# VARIO Cloud Developer Docs Get fast support for your VARIO Cloud development – from API integration to app development. The VARIO Dev Team is here to help → Get support now! VARIO Cloud is designed to be extended. For individual customer projects and for building reusable products. In-house IT teams, agencies and freelancers implementing custom solutions for VARIO customers, as well as independent developers and partners building public apps. Depending on the use case, VARIO Cloud can be integrated via the REST API, extended with private or public apps, automated using webhooks, or enhanced with custom logic through workflows and scripting. This allows you to build anything from a single customer integration to a public app that can be distributed to many customers through the VARIO App Store. ### 🧭 Get started with...

:puzzle-piece:

Apps

Build apps that extend VARIO with new functionality and user experiences/spaces/on1nU05fZpVHQJeS4nx5/pages/8zWGdc0Wa7TU4zD9QAu4/files/W2JAOPmNjCTHowVxNArg

:terminal:

REST API

Access and manage core ERP data to build integrations and synchronize systems./spaces/42xBlxNk23B7Vq5PVjW8/files/qPDrGSWECtBwEdk4slA4

👥 Who is this for?

🏢 In-house IT teams

Building and maintaining internal integrations and custom solutions.

⚙️ Dev Agencies

Implementing tailored ERP solutions for VARIO customers and building private apps.

🧩 App developers

Creating public apps and reusable products for distribution via the VARIO App Store.

Help & Support

Need help while building on VARIO Cloud? If you have questions, need guidance, or want to discuss a specific use case, we are here to support you. Support is provided directly by the VARIO Dev-team. As the platform and ecosystem grow, additional community and self-service support options will be added.

:envelope:

E-Mail support

Reach out for questions, clarifications, or technical guidance.dev-support@vario.ag

:brain-circuit:

Consulting & technical guidance

Book a paid session with VARIO experts (German-speaking) to discuss architecture, integrations, or app development.Book a session
# Overview An overview of the VARIO Cloud dev documentation and its structure. This section contains the technical documentation for extending and integrating **VARIO Cloud** — a cloud ERP system you can extend in three ways: | Approach | You build | Runs | Start here | | ------------- | ----------------------------------------------------------------------- | ----------------------- | --------------------------------------------------------------- | | **REST API** | An integration in any language that reads and writes ERP data over HTTP | Anywhere | [REST API Introduction](/documentation/rest-api/introduction) | | **Apps** | A self-hosted web app embedded into the ERP UI, talking to the REST API | Your own infrastructure | [Apps Introduction](/documentation/apps/introduction) | | **Scripting** | Server-side JavaScript running inside the ERP itself | VARIO backend | [Scripting Introduction](/documentation/scripting/introduction) | Most integrations combine them: an App for the UI and configuration, the REST API for data, Scripting for in-ERP automation, and [Webhooks](/documentation/webhooks/introduction) to react to changes. ## Find your way **I want to call the API.**\ Get a token via [Authentication](/documentation/rest-api/authentication), then send requests to your tenant base URL — see [REST API Introduction](/documentation/rest-api/introduction). Mind the [rate limits](/documentation/rest-api/rate-limiting), and query data with [VQL](/documentation/fundamentals/vql). **I want to build an App.**\ Read the [Apps Introduction](/documentation/apps/introduction), then [Create an App](/documentation/apps/create-an-app) to get credentials, and follow the [Quickstart](/documentation/apps/quickstart). The [App Manifest](/documentation/apps/app-manifest) reference describes every field. **I want to react to changes in the ERP.**\ Register a webhook — see [Webhooks Introduction](/documentation/webhooks/introduction). **I want to automate business logic inside the ERP.**\ No external server needed: use [Workflows](/documentation/scripting/workflows) or [Batch Processing](/documentation/scripting/batch-processing), with the [service layer](/documentation/scripting/services) and reusable [Script Modules](/documentation/scripting/script-modules). **I want to store my own data on ERP records.**\ Use [Custom Fields](/documentation/fundamentals/custom-fields) to extend articles, accounts, documents and more. **I'm building a shop, shipping, banking, accounting or POS integration.**\ These verticals follow established platform patterns. See [App Backends](/documentation/apps/app-backends) for a one-page guide per domain. **Something isn't working as expected.**\ Check the FAQ — it collects the mistakes developers hit most often. ## How this documentation is organised | Section | Content | | -------------------------------------------------------- | -------------------------------------------------- | | [REST API](/documentation/rest-api/introduction) | Base URL, authentication, rate limiting | | [Webhooks](/documentation/webhooks/introduction) | Reacting to ERP events, registration, delivery | | [Apps](/documentation/apps/introduction) | App model, credentials, manifest, quickstart | | [Fundamentals](/documentation/fundamentals/introduction) | Concepts that apply everywhere: custom fields, VQL | | [Scripting](/documentation/scripting/introduction) | Server-side JavaScript in the ERP | | FAQ | Common pitfalls and their answers | Beyond this space you'll also find the **API Reference** (every endpoint) and the **Scripting Reference** (every service and type). {% hint style="info" %} New to the platform? Start with the Introduction of the section you need. Looking for a specific detail? Jump straight to the relevant page — every page is written to stand on its own. {% endhint %} # Introduction How to reach the VARIO Cloud REST API — base URL, tenant-specific endpoints, and the OpenAPI specification. The VARIO Cloud REST API lets you read and write ERP data from your own applications and integrations. It is a standard HTTP API secured with **OAuth 2.0** and exposes the same service layer that powers the ERP itself. To call the API you need two things: an **access token** (see [Authentication](/documentation/rest-api/authentication)) and the correct **base URL** for your tenant. ## Base URL Every API request goes to your **tenant-specific** base URL: ``` https://{subdomain}.vario.cloud/api/vario ``` Replace `{subdomain}` with your own tenant subdomain — the same one you use to reach your VARIO Cloud installation. For example, if you access your installation at `https://mycompany.vario.cloud`, your API base URL is: ``` https://mycompany.vario.cloud/api/vario ``` All endpoint paths in this documentation and in the [API reference](https://developer.vario-software.de/api-reference) are relative to this base URL. For example, executing a [VQL](/documentation/fundamentals/vql) query: ``` POST https://mycompany.vario.cloud/api/vario/cmn/computed-queries/execute ``` {% hint style="warning" %} **Use your own tenant subdomain — not the address shown in the API reference.**\ The server address displayed at the top of the interactive [API reference](https://developer.vario-software.de/api-reference) is an internal placeholder and is not reachable from the outside. Always build your base URL from your own tenant subdomain, as shown above. {% endhint %} {% hint style="info" %} **The base URL is not the same as the authentication URL.**\ Access tokens are requested from the identity server at `https://sso.vario.cloud/realms//protocol/openid-connect/token`. Once you have a token, you send your actual API requests to `https://{subdomain}.vario.cloud/api/vario`. See [Authentication](/documentation/rest-api/authentication). {% endhint %} ## Tenant-specific OpenAPI specification The [API reference](https://developer.vario-software.de/api-reference) lists every available endpoint. For the exact, **tenant-specific** server URL and the endpoints enabled for your installation, download the OpenAPI (Swagger) specification directly from your VARIO ERP: 1. Open your VARIO ERP [support mode](https://help.vario-software.de/support/melden-von-problemen-in-vario-cloud/support-modus). 2. Download the OpenAPI specification for your installation. The `servers` entry in that file contains the correct base URL for your tenant. You can also import the file into tools such as Postman, Insomnia, or a code generator to work against your installation directly. ## Type definitions If you build your integration in TypeScript or JavaScript, the [@vario-software/types](https://www.npmjs.com/package/@vario-software/types) package provides type definitions for the VARIO Cloud platform — including typed API calls and the OpenAPI schemas — giving your editor autocompletion and type checking. See the package page for setup instructions. The same package also covers [Scripting](/documentation/scripting/introduction#type-definitions). ## Before you start * **Authenticate every request** with an OAuth 2.0 access token — see [Authentication](/documentation/rest-api/authentication). * **Always send a `User-Agent` header.** Requests without one are rejected with `403 Forbidden`. * API traffic is subject to [rate limiting](/documentation/rest-api/rate-limiting). # Authentication Obtain an access token with OAuth 2.0 — password, authorization code and device code grants. ### OAuth 2.0 authorization methods in VARIO Cloud In addition to its App frameworks, VARIO-Cloud exposes an HTTP API that is protected using **OAuth 2.0**.\ You can choose between three authorization methods: * **Password** grant * **Authorization Code** grant * **Device Code** grant All methods use the **client credentials** (`clientId`, `clientSecret`) that you obtain when creating an App in the Developer section. {% hint style="info" %} The exact URLs for the authorization and token endpoints depend on your tenant configuration.\ They can be found in the API-Clients section of the [Admin Center](https://admin.vario.cloud).\ In the examples below, replace `https://sso.vario.cloud/realms//protocol/openid-connect/` with your actual base URL. {% endhint %} {% hint style="warning" %} **User-Agent required**\ All API requests must include a `User-Agent` header (e.g. `MyApp/1.0`). Requests without `User-Agent` are blocked with `403 Forbidden`. {% endhint %} {% hint style="info" %} **Authentication URL vs. API base URL**\ The URLs above belong to the **identity server** (`sso.vario.cloud`) and are used only to obtain and refresh access tokens. Your actual API requests go to your **tenant-specific API base URL**, `https://{subdomain}.vario.cloud/api/vario`.\ The exact base URL for your installation is also included in the tenant-specific OpenAPI specification, which you can download from your VARIO ERP in [**support mode**](https://help.vario-software.de/support/melden-von-problemen-in-vario-cloud/support-modus). See the [Introduction](/documentation/rest-api/introduction) for details. {% endhint %} *** ### Password grant The **Password grant** allows your App to exchange a user’s **username and password** directly for an access token. #### When to use * For **trusted, server-side** applications that can securely store user credentials and client secrets. * For **system integrations** where a technical user is used for automation. {% hint style="warning" %} **Security warning**\ Do **not** use the Password grant in public clients (single-page apps, mobile apps without secure storage, etc.), because it requires handling the user’s raw password. {% endhint %} #### Requirements To use the Password grant, you need: * a **user account** in the VARIO-Cloud tenant * the user’s **password** * the App’s **Client ID** (`clientId`) * the App’s **Client Secret** (`clientSecret`) * the user must be **explicitly allowed** to use the Password grant in their user settings #### Enabling the Password grant for a user The Password grant is disabled by default for all users and must be enabled per user and per installation. 1. Sign in to your VARIO-Cloud tenant as an administrator. 2. Open the **“Benutzer”** (Users) menu. 3. Select the user who should be allowed to authenticate via Password grant. 4. Select the relevant **installation** (tenant / environment) for that user. 5. Activate the checkbox\ \&#xNAN;**„OAuth-Password-Grant-Type erlauben“**\ (Allow OAuth Password Grant Type). 6. Save your changes. Only users with this option enabled can obtain tokens via the Password grant. #### Requesting a token with the Password grant Once the user is enabled, you can request an access token with a standard OAuth 2.0 Password grant request: ``` curl -X POST "https://sso.vario.cloud/realms//protocol/openid-connect/token" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=password" \ -d "username=" \ -d "password=" \ -d "client_id=" \ -d "client_secret=" ``` The response contains an `access_token` (and usually a `refresh_token`), which you then use for API calls. *** ### Authorization Code grant The **Authorization Code grant** is the standard flow for **web applications** and other clients that can handle browser redirects.\ The user signs in via the VARIO-Cloud login page, and your App never sees the user’s password. #### When to use * For **browser-based** or **server-side web apps** with a backend that can receive HTTP callbacks. * When you want the user to explicitly **approve** the App’s access the first time it connects. #### Requirements To use the Authorization Code grant, you need: * a **user account** in the tenant (the end-user who will authorize the App) * the App’s **Client ID** and **Client Secret** * a **running OAuth callback server**, i.e. a backend endpoint that: * is reachable from the internet, and * can receive the `redirect_uri` callback * the callback URL must be **registered** for the App (according to your tenant configuration) {% hint style="danger" %} **Important**\ Unlike the Password grant, you **do not** send the user’s username/password to the token endpoint.\ The user authenticates directly against VARIO-Cloud in their browser and must **confirm** the access for your App on first connection in order to receive a valid token. {% endhint %} #### Typical flow 1. **Redirect the user** to the VARIO-Cloud authorization endpoint: ``` curl GET https://sso.vario.cloud/realms//protocol/openid-connect/auth ?response_type=code &client_id= &redirect_uri= ``` 2. The user logs in (if not already authenticated) and is asked to **grant access** to your App. 3. VARIO-Cloud redirects the user back to your `redirect_uri` with a `code` and `state` parameter. 4. Your backend exchanges the authorization code for tokens: ``` curl -X POST "https://sso.vario.cloud/realms//protocol/openid-connect/token" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=authorization_code" \ -d "code=" \ -d "redirect_uri=" \ -d "client_id=" \ -d "client_secret=" ``` 5. The response contains an `access_token` (and usually a `refresh_token`), which you then use for API calls. # Pagination and filtering How to page through results, sort them stably, and filter them. ## First: lists don't come from a REST collection Check that you are asking the right endpoint. **Reading lists is generally not done through classic REST collections in VARIO Cloud.** There is no `GET /erp/accounts`, no `GET /erp/articles` and no `GET /erp/documents`. Those paths take `POST` and `PUT` — a `GET` exists only for a **single record with its id**, as in `GET /erp/accounts/{id}`. Reading *across* records goes through the **computed query** API instead. There are **two ways to express the same query**, and you can pick either: | | **VQL** | **C-Unit** | | ---------- | ---------------------------------------------- | ----------------------------------------------- | | What it is | An SQL-like language, sent as a text statement | The same query as a structured **object** | | You write | `SELECT … FROM … WHERE …` | A predicate tree, a result list and a pageable | | Endpoint | `POST /cmn/computed-queries/execute` | `POST /cmn/computed-queries/{group}/{template}` | [**VQL**](/documentation/fundamentals/vql) — the language, and how to discover the available templates and field paths. The same templates and field paths apply to C-Unit; its object form is described [below](#c-unit-a-predicate-tree). {% hint style="info" %} **There are exceptions.** A few endpoints really do return a list — `GET /cmn/create-templates` is one, and the stock journal, import run entries and full-text search are others. Treat them as exceptions rather than the rule: when you need a list and no such endpoint is documented for it, the answer is a computed query. Either way this page applies to both worlds, because computed queries are paged too — with different parameter names, which is the next section. {% endhint %} Getting paging right matters more than it looks: paging without a stable sort silently returns some rows twice and skips others. ## Paging Two parameters, everywhere: an **offset** and a **limit**. What they are *called* depends on how you send them — this is the single most common source of confusion. | Where you send it | Offset | Limit | Sort | | ---------------------------------------------- | ---------- | --------- | ----------------- | | **Query string** on a REST collection | `start` | `limit` | `sort` + `order` | | **JSON body**, same object nested in a request | `_start` | `_limit` | `sort` + `_order` | | **C-Unit** — the `pageable` object | `start` | `limit` | `sortOrders` | | **VQL** — in the statement | `OFFSET n` | `LIMIT n` | `ORDER BY …` | | **VQL** — as request fields | `offset` | `limit` | in the statement | {% hint style="warning" %} Yes — the same field is `_start` in a body and `start` in a query string, and `sort` never takes the underscore while `_order` does. If a parameter seems to be ignored, check that you used the spelling that matches your transport. For VQL, note that both routes exist: `LIMIT 10 OFFSET 20` inside the statement, or `limit` / `offset` as request fields. **If you set both, the request field wins** and the clause in your statement is ignored — so pick one. {% endhint %} Defaults on REST collections: offset `0`, limit **`100`**. There is no enforced maximum. ``` GET /erp/stocks/stockjournal?start=0&limit=50&sort=id&order=asc ``` With C-Unit the pageable is an object, and sort is a list: ```json { "pageable": { "start": 0, "limit": 100, "sortOrders": [{ "property": "id", "direction": "ASC" }] } } ``` ## Knowing when you're done Two **response headers** tell you whether more data exists: | Header | Meaning | | ----------------------- | ---------------------------------- | | `x-query-more-elements` | `"true"` if there are further rows | | `x-query-next-offset` | The offset to request next | {% hint style="danger" %} **Both are strings, and the offset is `"0"` when you have reached the end** — not the final offset. So a loop that reuses `x-query-next-offset` without first checking `x-query-more-elements` jumps back to the first page and runs forever. Always branch on the flag: ```javascript const hasMore = headers['x-query-more-elements'] === 'true'; const nextOffset = Number(headers['x-query-next-offset']); if (!hasMore) break; ``` And note that `"false"` is a truthy string — comparing with `=== 'true'` is not optional. {% endhint %} There is **no total count**. The API determines "are there more" by reading one row beyond your page, so a total would cost a second query. Build UIs that page forward rather than showing "page 7 of 42". ## Always sort by a unique column This is the rule that prevents the bug in the title of this page: > Offset paging over an unsorted result set is undefined: the pages overlap, so rows come twice while an equal number is never served at all, and differently on every run. REST collections apply **no default order at all**. Computed queries add a primary-key tiebreaker, but only under conditions that are easy to miss: * it requires that a limit or offset is set, * and that the root entity's `id` is among the selected results. Two further traps: * **A non-unique sort column is not enough.** Sorting by a date still leaves rows with the same date in arbitrary relative order. * **Sending `pageable` discards the query template's own default sort.** Since paging requires sending `pageable`, you always lose it — so state your sort explicitly every time you page. Defensive practice: sort by `id`, and de-duplicate by `id` after collecting the pages. ## Filtering ### VQL: a `WHERE` clause If you send a VQL statement, you filter the way you would in SQL — `WHERE`, `AND`/`OR`, `LIKE`, `IN`, and so on. See [VQL](/documentation/fundamentals/vql) for the operators and the special value expressions. ### C-Unit: a predicate tree In object form the filter is structured rather than written out. A node is either a `JUNCTION` (with `children`) or a `FILTER` (with `property` and `values`): ```json { "queryPredicate": { "type": "JUNCTION", "operator": "AND", "children": [ { "type": "FILTER", "operator": "EQUALS", "property": "active", "values": ["true"] }, { "type": "FILTER", "operator": "IN", "property": "type", "values": ["A", "B"] } ] } } ``` `values` is **always an array of strings**, even for numbers and booleans. Commonly used operators: | Group | Operators | | ---------- | -------------------------------------------------------------------------- | | Junctions | `AND`, `OR` | | Equality | `EQUALS`, `NOT_EQUALS`, `IS_NULL_OR_EQUALS` | | Text | `LIKE`, `NOT_LIKE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `NOT_CONTAINS` | | Comparison | `GREATER_THAN`, `GREATER_THAN_EQUALS`, `LESS_THAN`, `LESS_THAN_EQUALS` | | Sets | `IN`, `NOT_IN` | | Ranges | `RANGE`, `NOT_RANGE` (exactly two values) | | Presence | `IS_NULL`, `IS_NOT_NULL` | | Subqueries | `EXISTS`, `NOT_EXISTS` | Operators have a fixed arity — `IS_NULL` takes no values, `RANGE` takes exactly two — and violating it is rejected. `GET /cmn/computed-queries/dialect-info` reports what the dialect supports in your version. You can either replace the preset's filter (`adhocPreset.queryPredicate`) or add to it (`additionalPredicate`, which is AND-ed on top). ### REST collections: per-endpoint parameters {% hint style="info" %} **There is no generic filter syntax.** No `?field=value`, no RSQL, no OData. Each collection endpoint defines its own set of filter parameters, and those are AND-combined. {% endhint %} Consult the [API Reference](https://developer.vario-software.de/api-reference) for what a given endpoint accepts. If the filter you need isn't there, fall back to a computed query — in [VQL](/documentation/fundamentals/vql) or C-Unit form. A concrete example that trips people up: to resolve an article id you cannot filter `/erp/articles` on `articleNumber` — as noted at the top, that collection cannot be read. Query the article template instead, filtering on `number`. ## Query parameters carry flat values only Query parameters are plain scalar key–value pairs. There is no `deepObject` support: a nested object put into a query string does not serialise into something the API can read. * **Scalars** — send as normal. * **Lists** — repeated keys (`types=a&types=b`) or comma-joined both work. * **Anything nested** — must go in a request body. That is exactly why the pageable exists in both a query-string and a body form. ## Pitfalls | What you do | What happens | | --------------------------------------------- | ------------------------------------------------------------------------------------------------ | | `limit=0` on a REST collection | **500** — the limit must be at least 1 | | `offset=0` on `/cmn/computed-queries/execute` | **422** — that endpoint requires positive values; omit the parameter instead | | Omit `limit` on a computed query | You get the **entire** result set, not 100 rows — and your paging loop exits after one huge page | | Select a projection without `id` | The tiebreaker cannot apply; unstable order returns | | Treat `x-query-next-offset` as authoritative | Infinite loop at the end of the data (see above) | | `Boolean(header)` for `more-elements` | Always `true`, because `"false"` is a non-empty string | ## Related * [VQL](/documentation/fundamentals/vql) — the query language, and how to discover field paths * [Rate limiting](/documentation/rest-api/rate-limiting) — pace your paging loops * [FAQ](broken://pages/DmBZgbUEXCMyhXGUtn1t) # Rate limiting Learn about the rate limits the VARIO Cloud API enforces To keep the VARIO Cloud API fast and reliable for everyone, we apply rate limits to API traffic. ### Limit **40 requests per 6 seconds** If you exceed this limit, the API will respond with **HTTP 429 (Too Many Requests)**. {% hint style="info" %} Note: Rate limits may evolve over time as the platform grows. If you have a use case that requires higher throughput, please contact us. {% endhint %} ### What happens when you hit the limit? When the rate limit is exceeded: * Requests may be rejected with **429 Too Many Requests** * You should **pause** and **retry** after a short delay * Repeated bursts without backoff will continue to be throttled # Concepts Some things you need to know before the API reference is useful, because they are **models**, not endpoints. A few business objects have a lifecycle or a structure you cannot infer from a field list, no matter how good the reference is. # Documents How documents move through their state machine — transitions, states and references. Documents (*Belege*) — offers, orders, delivery notes, invoices, credit notes — are the ERP's central business objects. They are also the object most integrations get wrong, because a document is not a record you edit freely. It is a **state machine**. {% hint style="info" %} This page explains the model. For endpoint details use the [API Reference](https://developer.vario-software.de/api-reference); for field paths use [runtime discovery](https://developer.vario-software.de/documentation/fundamentals/vql#dont-guess-field-paths-ask-the-api). {% endhint %} ## Everything happens through a transition There is **no** `DELETE /erp/documents/{id}`, and no endpoint that sets a state directly. Creating, editing, transferring, cancelling and deleting a document are all **transitions**: ``` POST /erp/documents create — with a transitionId PUT /erp/documents/{id}/states change state — with a transitionId POST /erp/documents/{id}/types transfer into a follow-up document ``` A transition is more than "from state A to state B". It is identified by the document **category**, an optional **source category** (for takeovers), the **transition**, the **source state** (absent = creation) and the **target state**. {% hint style="warning" %} `transitionId` is derived from enum ordinals and is not a stable contract. Never hard-code it, never store it long-term. Fetch it at runtime, per request. This is the single most common cause of an integration that works today and breaks after an update. {% endhint %} ## Finding the transition you need Three questions, three endpoints: | Question | Call | | ----------------------------------------------- | ---------------------------------------------------------- | | Which documents may I create? | `GET /erp/documents/types?qualifiers=SALE&languageCode=de` | | What can I do with *this* document right now? | `GET /erp/documents/{id}/states` | | Which follow-up documents can I create from it? | `GET /erp/documents/{id}/types` | Each entry carries the `transitionId` you then send, plus `typeId`, `typeLabel`, `targetState` and `transitionKey`. Of those, `transitionKey` (the transition's name) is the only human-stable identifier — match on that if you need to recognise a specific transition, and take the `transitionId` from the same response. The **qualifier** narrows the document world; there are only eight, so they are worth knowing: `SALE`, `PURCHASE`, `COMMISSION`, `POINT_OF_SALE`, `SALES_CONTRACT`, `PURCHASE_CONTRACT`, `FABRICATION`, `RMA`. Categories and transitions, by contrast, number in the dozens and hundreds. Their names follow a grammar — categories are prefixed by counterparty (`CUSTOMER_ORDER`, `SUPPLIER_ORDER`, `POS_*`, `FABRICATION_*`), transitions are either lifecycle verbs (`CREATE`, `BEGIN_EDITING`, `DELETE`, `PUBLISH`, `COPY`) or takeovers in `X_TO_Y` form (`OFFER_TO_ORDER`, `ORDER_TO_DELIVERY`, `DELIVERY_TO_INVOICE`) — but do not work from a list. The valid combinations depend on your installation's configuration; enumerate them. {% hint style="info" %} `/{id}/states` and `/{id}/types` are **disjoint** lists. A takeover into another document type never appears under `/states`. If a transition you expect is "missing", you are probably asking the wrong endpoint. {% endhint %} {% hint style="warning" %} `/states` contains a **collective** `ACCEPT` entry with `transitionId: 0`. Don't fire it — a document becomes *accepted* as a side effect of being taken over into a follow-up document, not by a direct call. {% endhint %} ## Creating a document Only `transitionId` is required: ```json POST /erp/documents { "transitionId": "", "targetTypeId": "", "document": { "accountId": "12345" } } ``` Whether an account is required depends on the category. Ids travel as **strings** throughout. Two things to get right in the order you do them: * Header fields such as the document date, default storage or report group are set with `PATCH /erp/documents/{id}` — **before** you add lines. * POS documents need `posRegisterId` and `cashDrawerId` **flat in** `document` at creation time, not nested. Leave the document **number** out. It is generated automatically (see below). ## What you may change, and when Every state carries a classification, and that classification — not the state name — decides what is allowed: | Classification | Meaning | | --------------------------------------- | ------------------------------------------------------ | | `EDITABLE` | Full edit allowed | | `INTERNAL_EDITABLE` | Only the backend may change it (a workflow is running) | | `PARTIALLY_TRANSFERRED` / `TRANSFERRED` | Partly or fully taken over into a follow-up | | `DELETED` | Being deleted | A full-body update requires `EDITABLE`. On a non-editable document, `PATCH` still works — but only for a small whitelist of fields; anything else is rejected. A document in a workflow state, or deleted, is refused outright. {% hint style="warning" %} `HISTORICAL_DATA` is a dead end by design. Imported legacy documents get this state and have *no transitions in or out*. Any write is refused. If you need to process such data, do it before import. {% endhint %} Writes participate in **optimistic locking**. The `x-get-leasable-lock`, `x-use-leasable-locks`, `x-refresh-leasable-locks` and `x-release-leasable-locks` request headers, and `x-active-leasable-locks` in the response, are part of the contract — respect them when several clients or users touch the same document. ## Lines ``` POST /erp/documents/document/{documentId}/line POST /erp/documents/document/{documentId}/multiple_lines PUT /erp/documents/document/{documentId}/line/{lineId} DELETE /erp/documents/document/{documentId}/line/{lineId} PUT /erp/documents/document/{documentId}/line/{lineId}/move/{position} ``` {% hint style="warning" %} Note the **doubled** `/document` segment — a frequent 404. {% endhint %} ```json { "documentLine": { "lineType": "…", "articleId": null, "texts": [] }, "additionalParameters": [] } ``` * Every line write returns the **whole document**, not the line. * On the document, the collection is called `lines`. * `PUT …/line/{lineId}` **ignores** a changed position — it forces the stored one. Use `…/move/{position}` (1-based) to reorder. ## Document texts Two positions: `HEADER_TEXT` and `FOOTER_TEXT`. A text either carries free `content` or references a text template, and `transferableIntoSubsequentDocuments` controls whether it survives a takeover. Texts can be sent at creation, per line, or on the document header via `PUT /erp/documents`. Two traps on the header update: {% stepper %} {% step %} ### Do not include `lines` The body must **not** contain `lines` — the request is rejected. {% endstep %} {% step %} ### Send the complete `texts` array The `texts` array is treated as **complete**. A text you omit is **deleted**. Read the existing texts first and send them back in full. {% endstep %} {% endstepper %} When reading, note that deleted texts are included in the response — filter them out. ## How documents reference each other **The link lives on the lines, not on the document.** A line carries `sourceLine` pointing at the line it came from; the document-level chain is derived from that. To show a document's history, use `GET /erp/documents/{id}/types/history` — a tree of predecessors and successors with number, date, type, state and totals. ### Partial delivery Three line fields express it: | Field | Meaning | | ------------------- | --------------------------------------------------------------------------- | | `quantity` | The line's quantity | | `quantityCommitted` | How much has been passed to follow-up documents — **can exceed** `quantity` | | `complete` | Whether the line is finally settled | The predecessor's state is then **recomputed** from those, not set by you: fully taken over → `ACCEPTED`, partly → `PARTIALLY_ACCEPTED`, otherwise back to `SAVED`. While a successor is being edited, the predecessor may show "successor is being edited" instead. To offer a partial takeover, ask for the open quantities — for example `GET /erp/documents/{id}/lines-to-transfer-to-customer-delivery` — then send the chosen `sourceLineId` + `quantity` pairs in `document.lines` of the takeover call. That is the only way a reduced (or negative) quantity travels along. ### A worked example: order → delivery note The `ORDER_TO_DELIVERY` transition accepts a `CUSTOMER_ORDER` in state `SAVED`, `PARTIALLY_ACCEPTED` or `PICKING_FINISHED`, and produces a delivery note in `SAVED` with its lines linked back to the order and a fresh document number. Yes — the delivery note is created **with reference to** the order; that reference is what later drives the order's own state. ## Document numbers **They are generated automatically.** Each document type has a sequence configuration — typically fully automatic, with a length, a pad character and a prefix expression (for example the short year). Consequences: * Don't send `number` on create; it is not part of the create body. `externalNumber` is the field for *your* reference. * A blank number is rejected on save (except for historical imports). * **Deleting a document returns its number to the pool**, so numbers are not strictly monotonic. Don't derive ordering or counts from them. Sequence configuration and next/last values can be inspected under `/cmn/sequencer`. ## Deleting Deletion is the `DELETE` **transition**, and it is allowed from exactly one state: `EDIT`. A saved document must first go through `BEGIN_EDITING`. It is refused when: * **active successor documents exist** — take them back or cancel them first (references to already-inactive successors are cleaned up silently); * **open items with movements exist** — payments have already been recorded against it. {% hint style="success" %} After a successful deletion the document may no longer exist, and the call answers `301 Moved Permanently` with an empty body rather than a document. Treat that as success, not as an error. {% endhint %} For documents that must remain on record, use cancellation (`CANCELLED`) or dissolution (`DISSOLVED`) instead of deletion — those keep the document and its number. ## Querying documents Sales documents are queried through the `document.querySalesDocuments` template. It is **already scoped** — restricted to the sales-side qualifiers and excluding internal POS categories — so you cannot widen it; use the purchase or POS template instead. Do not guess field paths. Enumerate them: ``` GET /cmn/computed-queries/document/querySalesDocuments/fields?filterable=true&depth=2 ``` `depth` is what walks into relations. To explore an entity's own attributes and relations, use `GET /cmn/computed-queries/fields?entityIdentifier=…`. The semantics you usually want: a delivery note that is posted but **not yet invoiced** is one whose state is not `ACCEPTED` (so `SAVED`, or `PARTIALLY_ACCEPTED` when partly invoiced), with lines where `complete` is false and `quantityCommitted` is below `quantity`. {% hint style="info" %} There is **no "shipped" flag** on a document. The closest things are line-level shipping and delivery dates, and the document's `published` flag — which means "output has been produced", not "goods have left". {% endhint %} ## Checklist * `transitionId` fetched at runtime, never cached * Right endpoint for the question — `/states` for state changes, `/types` for follow-ups * Header fields patched **before** lines are added * `PUT /erp/documents` sent without `lines`, and with the **complete** `texts` array * Line paths use the doubled `/document` segment * Number left to the sequencer * `301` after deletion handled as success * Leasable-lock headers respected ## Related * [App Backends](https://developer.vario-software.de/cookbook/app-backends/app-backends) · [Onlineshops and Marketplaces](https://developer.vario-software.de/cookbook/app-backends/onlineshops-and-marketplaces) — order import creates documents * [VQL](https://developer.vario-software.de/documentation/fundamentals/vql) · [Pagination and filtering](https://developer.vario-software.de/documentation/rest-api/pagination-and-filtering) · [FAQ](https://developer.vario-software.de/documentation/faq) # FAQ Frequently asked questions about API access, requests, data queries and custom fields. ## Calling the API ### What is my API base URL? ``` https://{subdomain}.vario.cloud/api/vario ``` `{subdomain}` is your own tenant subdomain — the one you use to reach your installation. {% hint style="warning" %} The server address shown at the top of the interactive [API Reference](https://developer.vario-software.de/api-reference) is an **internal placeholder** and is not reachable from outside. Don't copy it. {% endhint %} For the exact URL and the endpoints enabled for your installation, download the tenant-specific OpenAPI specification from your ERP in [support mode](https://help.vario-software.de/support/melden-von-problemen-in-vario-cloud/support-modus) — the `servers` entry holds the authoritative value. → [REST API Introduction](/documentation/rest-api/introduction) ### Every request fails with 403 Forbidden, even with a valid token. Why? You are almost certainly missing a **`User-Agent` header**. The API rejects requests without one. This is not arbitrary: the platform uses `User-Agent` to identify the calling app, which is what makes [webhook suppression](#how-do-i-stop-an-infinite-webhook-loop) work. The App Framework sends your `appIdentifier` as the value. ### What is the difference between the SSO URL and the API URL? They are two different hosts and it is the single most common mix-up: | Purpose | URL | | --------------------------------- | ----------------------------------------------------------------------- | | Getting and refreshing **tokens** | `https://sso.vario.cloud/realms//protocol/openid-connect/token` | | Making **API calls** | `https://{subdomain}.vario.cloud/api/vario` | → [REST API Authentication](/documentation/rest-api/authentication) ### I'm getting 429 Too Many Requests. You exceeded the rate limit of **40 requests per 6 seconds**. Pause and retry with a delay; continuing to burst keeps you throttled. → [Rate limiting](/documentation/rest-api/rate-limiting) ### What do 402, 403 and 422 mean? | Status | Meaning | | ------- | ---------------------------------------------------------------------------- | | **402** | A **license** is missing or its limit is exceeded — at runtime | | **403** | A **permission** is missing, or your request had no `User-Agent` | | **422** | Validation failed — including a missing required license **at install time** | ## Reading and writing data ### How do I find the right field path for a query? Don't look it up in documentation — **enumerate it**. The available groups, templates and field paths depend on your installation and change between versions, and a path copied from a document may not exist in your version. → [Don't guess field paths — ask the API](/documentation/fundamentals/vql#dont-guess-field-paths-ask-the-api) The same principle applies to navigating to a related entity: there is a dedicated call that returns all entities with their relations, which is how you discover joins. ### What is the difference between `account.number`, `customer.number` and `accountingNumber`? An **account** is the address. Numbers then exist **per business relationship** — an account can be a customer, a supplier and a sales agent at the same time, each with its own numbers. | Path | Meaning | | --------------------------- | --------------------------------------------------- | | `account.number` | Address number — identifies the account itself | | `customer.number` | Customer number, valid in the customer relationship | | `customer.accountingNumber` | The bookkeeping (FiBu) customer number | | `customer.ourNumber` | **Your** supplier number, as the customer knows you | | `supplier.number` | Supplier number, valid in the supplier relationship | | `supplier.accountingNumber` | The bookkeeping (FiBu) supplier number | | `supplier.ourNumber` | **Your** customer number, as the supplier knows you | The pattern is symmetric, so you can reason about any of them: * `number` — the partner's number in that relationship, * `accountingNumber` — its counterpart for financial accounting, * `ourNumber` — the number the partner uses for *you*. {% hint style="info" %} For accounting exports this matters: the export uses the relationship's `accountingNumber` and falls back to `number` when it is empty. Writing an identifier into the wrong one silently changes which account a booking lands on. {% endhint %} ### My paged query returns duplicates and misses rows. You are paging over an **unsorted** result set. Offset paging is undefined without an order: pages overlap, some rows arrive twice and others never arrive — differently on each run. The backend adds no default order. Always sort by a **unique** column (`id` is the safe choice), and deduplicate afterwards as a safety net. ### Why is `moreElements` never `true`? Because it is a **string**. Pagination information arrives in response headers and is exposed as strings — compare with `=== 'true'`, not as a boolean. → [VQL](/documentation/fundamentals/vql) ### How do I store my own data on ERP records? With [Custom Fields](/documentation/fundamentals/custom-fields). Attach them to articles, accounts, documents, listings and more, then query them by path: ```sql SELECT id, custom.myapp.externalId FROM article.query WHERE custom.myapp.externalId NOTNULL ``` This is the standard way to store external reference IDs and sync state. ### How do I get IntelliSense for the API and for scripting? Install the [`@vario-software/types`](https://www.npmjs.com/package/@vario-software/types) package — it provides type definitions for the platform, including the API schemas and the scripting interfaces. # Introduction React to events in VARIO Cloud instead of polling — registration, delivery, verification. A webhook lets VARIO Cloud call **your** service when something happens in the ERP — a document is created, an article changes, stock moves. Instead of polling, you subscribe once and get notified. Webhooks are also how scheduled work is triggered for Apps: a cron webhook is the same delivery mechanism, fired by a timer instead of a data change. ## Concepts A subscription has two parts, together called a **destination**: | Part | Meaning | | ------------------ | ---------------------------------------------------------------- | | `destinationQueue` | The event, e.g. `article.update` or `sales_channel.create` | | `destinationOwner` | Who owns the queue. Defaults to `#vario#` — the ERP's own events | Plus the `url` VARIO should call, and your `appIdentifier`. {% hint style="warning" %} **Always register with your `appIdentifier`.** It is what causes VARIO to send an `Authorization` header with the call. Without it, the delivery arrives unauthenticated — and an App built on the VARIO App Framework will reject it with `401`, because the framework verifies that header on every route. {% endhint %} ## Discovering available events You don't have to guess event names. Ask the ERP: ``` GET /cmn/system/app-message-webhook/destinations ``` It returns every queue the backend offers: ```json [ { "owner": "#vario#", "queue": "article.update", "description": "…" }, { "owner": "#vario#", "queue": "sales_channel.create", "description": "…" } ] ``` All webhook endpoints live under your tenant base URL with the versioned prefix: ``` https://{subdomain}.vario.cloud/api/vario/community/{version}/cmn/system/app-message-webhook/… ``` → See [REST API Introduction](/documentation/rest-api/introduction) for base URLs. `{version}` is `latest` unless you pin one. {% hint style="info" %} The destinations list is generated from the backend's definitions. For documents it contains **every possible combination** of category and transition — several thousand entries, and not all of them are ever emitted. A subscription to a topic that never fires registers successfully and simply stays silent. Verify against a real event before assuming your handler is broken. {% endhint %} ## Registering | Verb | Path | Purpose | | ------ | ------------------------------------ | --------------------- | | `POST` | `…/app-message-webhook/register` | Subscribe | | `POST` | `…/app-message-webhook/deregister` | Unsubscribe | | `GET` | `…/app-message-webhook/destinations` | List available queues | Body for register and deregister: ```json { "url": "https://my-app.example.com/api/webhooks/article.update", "destinationQueue": "article.update", "destinationOwner": "#vario#", "appIdentifier": "" } ``` `url` and `destinationQueue` are required; `destinationOwner` defaults to `#vario#`. Only `http://`, `https://` and `ws://topic/` URLs are accepted. Keep URLs short — the stored columns are limited to 255 characters. ### From an App The framework wraps this in migration helpers, which also prefix your path with the app's public domain: ```javascript await methods.registerWebhook('sales_channel.create', '/api/webhooks/sales_channel.create'); // App-owned (cron) destinations need the owner: await methods.registerWebhook('ORDER_IMPORT', '/api/cron-webhooks/ORDER_IMPORT', 'APP'); ``` Register webhooks inside `always()` rather than `setMigration()`, and prefer `registerWebhookIfNotExists()` — that combination is idempotent and re-registers after a reinstall. {% hint style="warning" %} `registerWebhookIfNotExists()` takes **no owner argument**. For app-owned destinations such as cron webhooks you must call `registerWebhook(queue, url, 'APP')`, otherwise the subscription lands under `#vario#` — where the queue name is unknown and the request is rejected as invalid. {% endhint %} ### Registration is idempotent Registering the same combination twice does not create a duplicate: an active subscription is returned unchanged, and a previously removed or deactivated one is reactivated. The identity is `appIdentifier` + `destinationOwner` + `destinationQueue` + **the full URL**. Change the URL and you get a *second* subscription — the old one keeps firing. This is the usual cause of handlers running twice. ## Event names The grammar is dotted and lowercase: ``` [.]. ``` Examples: `article.update`, `article-price.create`, `category-tree.delete`, `sales_channel.stockChange`, `shipment.parcel.completed`. Some events are **filtered**, taking a parameter in parentheses: ``` article(sales-channel-id=42).update ``` Substitute the value yourself when registering. The value must be a plain word — numeric ids work, values containing dashes do not match. {% hint style="info" %} For articles, the plain and the filtered event are **mutually exclusive** for a given change: a listing on a non-system sales channel fires the filtered form, a change on the system sales channel fires the plain `article.update`. Subscribing to both does not double-deliver, but subscribing to the wrong one delivers nothing. {% endhint %} Document events are composed from the document category and its transition: ``` document.. document.customer_delivery_document.order_to_delivery ``` ## What your handler receives A `POST` with `Content-Type: application/json` and these headers: | Header | When | | ---------------------------------- | --------------------------------------------------------------------------- | | `Authorization: Bearer ` | Only if the subscription has an `appIdentifier` | | `x-user-id` | Only if a user triggered the event — absent for system and scheduled events | The body is **small — normally just identifiers**, not the full entity: | Event | Body | | ---------------------------------------------- | ----------------------------------------- | | `document..` | `{ "documentId": … }` | | `article.*` | `{ "articleId": …, "listingId": …, … }` | | `account.*` | `{ "id": … }` | | `sales_channel.create` / `.update` / `.delete` | `{ "salesChannelId": … }` | | `sales_channel.stockChange` | `{ "salesChannelId": …, "articleId": … }` | | `shipment.parcel.completed` | `{ "shipmentId": …, "parcelId": … }` | Fetch what you need with [VQL](/documentation/fundamentals/vql) or the REST API. An event with no payload arrives as `{}`. ## Verifying the call There is **no HMAC signature**. Authenticity comes from the bearer token, which is a JWT: * signed with **ES256**, * verifiable with the **JWK set** you received when [creating the App](/documentation/apps/create-an-app), * whose `aud` claim equals your `appIdentifier`, * with a valid `exp`. Reject anything that fails those checks. If you build on the App Framework this already happens for every `/api/*` route — see [App Authentication](/documentation/apps/authentication). ## Delivery semantics Read this section before you write a handler. | Property | Behaviour | | --------- | ----------------------------------------------------------------- | | Timeout | **5 seconds**, for connect and response | | Attempts | **3**, then the delivery is permanently abandoned | | Guarantee | **At least once** | | Ordering | **None** — do not assume events arrive in the order they happened | | Backoff | No fixed schedule; retries happen when the sender next runs | {% hint style="danger" %} **Answer immediately, then do the work.** With a 5-second timeout, any real processing will exceed it — the delivery is recorded as failed and retried even though you handled it. Acknowledge with `200` first and continue asynchronously. The App Framework's webhook router does this for you. {% endhint %} Because delivery is at-least-once and a timeout cannot distinguish "not received" from "received and slow", **handlers must be idempotent.** Note that duplicate protection held in memory does not span processes — if you run more than one instance, you need a shared guard. A retry only happens the next time the sender runs, which is triggered by new activity. On a quiet tenant a failed delivery can wait a long time. After the third failure it is never retried. ## Preventing infinite loops If your app reacts to `article.update` by writing back to the article, that write triggers `article.update` again. Break the cycle with a header on **your** write: ``` x-vario-suppress-own-webhooks: true ``` This suppresses only **your own** subscriptions — other apps still receive the event. {% hint style="warning" %} Two things to know: 1. **Only the header's presence is checked, not its value.** Sending `x-vario-suppress-own-webhooks: false` still suppresses. 2. **VARIO must be able to identify you as the caller** — either from the authenticated app user, or from a `User-Agent` that is your app identifier. This is one reason the API insists on a `User-Agent` header, and why the framework sends your `appIdentifier` as its value. {% endhint %} Bulk imports have a separate switch: an import rule set can suppress webhooks for the whole run. ## Cron webhooks A cron webhook fires on a schedule instead of a data change. It needs **two** things: 1. A subscription with owner `APP` and your own queue name: ```javascript await methods.registerWebhook('ORDER_IMPORT', '/api/cron-webhooks/ORDER_IMPORT', 'APP'); ``` 2. A scheduled task with the same destination and a cron expression. Because the owner is not `#vario#`, the queue name is **not validated** — a typo registers happily and never fires. {% hint style="warning" %} Cron payloads can arrive **double-encoded**: the scheduled payload is stored as a JSON string and serialised again on dispatch. Handle both shapes: ```javascript const payload = typeof req.body === 'string' ? JSON.parse(req.body) : req.body; ``` {% endhint %} ## Inspecting what happened Subscriptions and deliveries are queryable with [VQL](/documentation/fundamentals/vql): ```sql SELECT id, destinationQueue, url, state, createdAt FROM system.queryAppMessageWebhook WHERE appIdentifier = '' ``` ```sql SELECT id, eventTopic, recipients.state, recipients.sentAttempts, recipients.response FROM system.queryAppMessageEntry ``` A subscription is `ACTIVE`, `DEACTIVATED` (switched off by a user), `REVOKED` (switched off by the platform) or `REMOVED` (deregistered). A delivery is `QUEUED`, `SENT`, `FAILED` (will be retried), `ERRONEOUS` (gave up) or `INACTIVE`. Failed attempts store the error in `response` — that is where to look first when a handler "never gets called". ## When nothing arrives Work through this in order: 1. **Is the App active for the tenant?** Events for inactive apps are dropped before a delivery record is even created — so you will find no failed deliveries either. 2. **Is the subscription there and `ACTIVE`?** Query `system.queryAppMessageWebhook`. 3. **Does the topic actually fire?** Especially for document events, the topic may be listed but never emitted. 4. **Are deliveries failing?** Query `system.queryAppMessageEntry` and read `recipients.response`. 5. **Are you returning `401`?** If the subscription lacks `appIdentifier`, no token is sent and the framework rejects the call. 6. **Are you too slow?** Anything over 5 seconds counts as failed. 7. **Did you suppress it yourself?** Check whether your own write set the suppression header. ## Related * [REST API Introduction](/documentation/rest-api/introduction) — base URL and versioned paths * [App Authentication](/documentation/apps/authentication) — verifying the inbound token * [VQL](/documentation/fundamentals/vql) — fetching the entity behind an event * [FAQ](broken://pages/DmBZgbUEXCMyhXGUtn1t) # FAQ Frequently asked questions about webhooks. ### How do I find out which events exist? Ask the ERP: ``` GET /cmn/system/app-message-webhook/destinations ``` It lists every available queue with a description. → [Webhooks Introduction](/documentation/webhooks/introduction) ### My webhook is registered but never fires. Work through this in order: 1. **Is the App active for this tenant?** Events for inactive apps are discarded before any delivery record is created — so you won't even find a failed delivery. 2. **Does that topic actually get emitted?** The destinations list is generated and, for documents, contains *every* category/transition combination. Some are never emitted. Registering one succeeds and stays silent forever. 3. **Are deliveries failing?** Query `system.queryAppMessageEntry` and read `recipients.response`. 4. **Are you answering in time?** The timeout is **5 seconds**. 5. **Are you returning 401?** See [above](#vario-calls-my-app-and-my-app-answers-401-whats-wrong). 6. **Did you suppress it yourself?** Check whether your own write set the suppression header. ### Why does my webhook handler run twice? Almost always a **second registration** you didn't intend. The identity of a subscription includes the **full URL** — so if the URL changed (a new domain, a different `WEBHOOK_HOST` in local development, a path convention change), the old subscription still exists and still fires. The other cause is registering the same webhook from two places, for example a per-channel registration plus an `always()` step that also registers it. ### How do I stop an infinite webhook loop? If you react to `article.update` by writing back to the article, that write triggers the event again. Send this header on **your** write: ``` x-vario-suppress-own-webhooks: true ``` It suppresses only **your own** subscriptions; other apps still get the event. {% hint style="warning" %} Only the **presence** of the header is checked — not its value. Sending `x-vario-suppress-own-webhooks: false` still suppresses. Omit the header entirely when you want the event. It also only works if VARIO can identify you as the caller, which is why the `User-Agent` must carry your app identifier. {% endhint %} ### How long may my handler take? Under 5 seconds — so in practice: **acknowledge first, then work.** Return `200` immediately and continue processing asynchronously. Otherwise the delivery is recorded as failed and retried even though you handled it. ### Are webhooks ordered? Delivered exactly once? No and no. Delivery is **at least once** with **no ordering guarantee**, up to **3 attempts**, after which it is abandoned permanently. Handlers must be idempotent. Note that in-memory duplicate protection does not span processes — if you run several instances you need a shared guard. ### Why does my cron webhook handler receive a string instead of an object? Cron payloads can arrive **double-encoded**. Accept both: ```javascript const payload = typeof req.body === 'string' ? JSON.parse(req.body) : req.body; ``` Also remember a cron webhook needs **two** things: a subscription with owner `APP`, *and* a scheduled task with the same destination. # Introduction What a VARIO Cloud App is, how it integrates with the ERP, and how a private App becomes public. A **VARIO Cloud App** is an external web application that you build and host yourself. It is integrated into VARIO-Cloud in three ways: * **UI integration**: VARIO Cloud embeds your App inside an iframe at defined integration points (for example, as a navigation entry or dialog). To the end user, the App appears as part of the ERP UI. * **Data integration via REST API**: Your App talks to the VARIO Cloud backend using the public REST API (secured with OAuth2) to read and update ERP data. * **Webhooks**: You can send and receive Events triggered by the Cloud App or via Webhooks The App does **not** run inside VARIO Cloud itself. Instead, it is a self-hosted service that connects to VARIO Cloud through iframe-based UI integration and the REST API. ### App types: private vs public VARIO Cloud supports **private Apps** and **public Apps**. Every App starts out private — public is a status an existing App is promoted to, not a separate kind of project. #### Private Apps Private Apps are built for a single customer or organization. * Any customer on the **Enterprise plan** can develop and add private Apps. * Private Apps are not listed in the App Store. #### Public Apps (App-Store) Public Apps are available to all customers via the **App Store**. You do not need our approval to start. Build and run your App as a private App first; when it is ready for a wider audience, it goes through these steps: 1. **Contact us** with your finished private App. 2. **Sign the App Store contract.** 3. **Review process** — we review the App, and on success it is published as a public App in the App Store. {% hint style="info" %} Because the path always starts private, nothing about the development work changes when you plan to publish later. Build it the normal way — see [Create an App](/documentation/apps/create-an-app) and the [Quickstart](/documentation/apps/quickstart). {% endhint %} # Quickstart Build and run your first App using the VARIO App Framework and the demo app. ### Getting started with the VARIO App Framework This guide walks you through building and connecting a new **VARIO Cloud App** using: * the **VARIO App Framework** (Node.js) * the **VARIO App Demo** as a starting point * a VARIO-Cloud tenant where you can register Apps You will: 1. Clone the demo app and install dependencies 2. Configure the manifest and API client 3. Run the app and see it embedded into VARIO Cloud via iframe 4. Start extending the app’s backend and frontend *** ### Prerequisites You should have: * A **VARIO Cloud tenant** with access to the **Developer (Entwickler)** section * A registered **App** in VARIO Cloud including its API credentials * `appIdentifier`, `clientId`, `clientSecret` * See: [**Creating a new App**](/documentation/apps/create-an-app) * **Node.js** and **npm** installed * **Git** installed * Access to public git Repository: * VARIO App Framework:\ * VARIO App Demo:\ *** ### 1. Prepare your App and credentials Before you start development, make sure you have followed the steps in\ [**Creating a new App**](/documentation/apps/create-an-app) and that you have: * an App created in the VARIO Cloud **Developer** section * the corresponding **AppClient** values: ``` { "appIdentifier": "your-app-identifier", "clientId": "your-client-id", "clientSecret": "your-client-secret", "appJWK": "JWK_TOKEN" } ``` These credentials will be used by the demo app to authenticate against the VARIO-Cloud API. *** ### 2. Use the demo app as a starting point The easiest way to get started is to use the **VARIO App Demo** as a template and adapt it to your needs. #### 2.1. Clone the demo repository ``` git clone https://github.com/vario-software/vario-app-demo.git cd vario-app-demo ``` You will find (among other things): * `backend/` – Node.js backend using the VARIO App Framework * `frontend/` – static assets / UI for the app * `app-manifest.json` – sample manifest * `app-client.js` – placeholder for API credentials * `package.json` – project configuration & npm scripts #### 2.2. Install dependencies From the root of the demo app: ``` npm install ``` This installs the VARIO App Framework and any other required libraries. *** ### 3. Connect the demo app to your VARIO-Cloud App Now you tie your **tenant App** (configured in VARIO Cloud) to your **demo app**. #### 3.1. Align the manifest in the repo Open `app-manifest.json` in the demo project and align it with the manifest you used when creating the App in VARIO-Cloud: * Ensure that key metadata matches: * `label`, `description`, `shortName`, `appVersion` * Adjust URLs to reflect your environment: * `rootUrl` * `pcInstallationUrl` * `pcInstallationDeletionUrl` * `pcManifestUrl` For local development you typically: * You have to make sure your app is publicly reachable from the internet. If you are developing on a local machine, you probably have to use a tunneling service like ngrok or DynDNS. The Vario Cloud must be able to connect to the running app. * run the app on [https://public-ip](https://public-ip/):\ * expose it through a tunnel (e.g. `https://.ngrok.io`) or use a test host with HTTPS > The URLs in the manifest must be reachable by VARIO-Cloud. #### 3.2. Add your AppClient credentials Open `app-client.js` in the demo project and fill it with the values from your AppClient: ```javascript module.exports = { appIdentifier: 'your-app-identifier', clientId: 'your-client-id', clientSecret: 'your-client-secret', appJWK: { keys: [ /* your JWK set */ ] }, }; ``` {% hint style="info" %} `app-client.js` is a JavaScript module, not a JSON file — the demo app loads it with `require`. `appJWK` holds the **JWK set** you received when creating the App; a JSON string is also accepted and parsed automatically. {% endhint %} *** ### 4. Run the app locally The demo app defines npm scripts in `package.json` to start the backend and frontend.\ Check the `scripts` section and use the appropriate command, for example: ``` # example – adjust to the actual script names in package.json npm run dev ``` Once the app is running: * the backend listens on its configured port (e.g. [https://public-ip:3000](https://public-ip:3000/)) * the frontend serves the UI pages referenced in your `uiIntegrations` manifest section *** ### 5. See the app inside VARIO-Cloud Because the manifest defines one or more **UI integrations**, VARIO Cloud embeds your App in an **iframe** at those integration points. Example integration: ``` "uiIntegrations": { "integrations": [ { "pointOfIntegration": "navigation.root", "id": "demo-page", "url": "https://app.example.com/ui/demo.html", "iconClass": "fal fa-atom-simple", "msgKey": "Demoapp", "permissionKey": "use-app" } ] } ``` For your development environment, ensure: 1. The `url` points to a reachable HTTPS endpoint of your running app (for local dev: via tunnel or test host). 2. The users you test with have the corresponding `permissionKey` (here: `use-app`) assigned in VARIO Cloud. Then: 1. Log in to VARIO Cloud. 2. Open the main navigation. 3. Click the navigation entry for your App (e.g. **“Demoapp”**). 4. VARIO-Cloud will open your App UI in an iframe. *** ### 6. Start developing your own functionality From here, you can extend both the **backend** and **frontend**. #### Backend (Node.js with VARIO App Framework) In the `backend` folder you can: * add new routes/endpoints * use the framework’s helpers to: * authenticate with VARIO-Cloud (OAuth2 using `clientId` and `clientSecret`) * call VARIO-Cloud REST APIs * execute VQL queries and return data to the frontend Typical flow for a new feature: 1. Decide which VARIO-Cloud data you need (e.g. customers, orders, CRM activities). 2. Implement a backend route that: * obtains/refreshes an access token * calls the appropriate VARIO-Cloud API or VQL endpoint * returns the processed data as JSON 3. Handle errors and logging for easier debugging. #### Frontend (UI pages) In the `frontend` folder you can: * modify existing HTML/JS pages or add new ones * use the framework’s CSS/JS assets to match VARIO Cloud’s look & feel * call your backend routes using `fetch` from within the iframe context *** ### 7. Summary In short, to get started with the VARIO App Framework: 1. **Create and configure an App** in VARIO-Cloud and obtain `appIdentifier`, `clientId`, `clientSecret` * See: [**Creating a new App**](/documentation/apps/create-an-app) 2. **Clone the VARIO App Demo** and run `npm install`. 3. **Align** `app-manifest.json` with your registered App and environment. 4. **Fill** `app-client.js` with your AppClient credentials. 5. **Start** the app using the npm scripts in `package.json`. 6. **Open** VARIO-Cloud and use the UI integration to reach your App. 7. **Extend** backend and frontend using the VARIO App Framework to build your own features. # Authentication How an App verifies calls from VARIO Cloud and authenticates its own API requests. An App authenticates in **two directions**, and it is important not to confuse them: | Direction | Token | Question it answers | | ---------------------- | --------------------------------------------------- | ------------------------------------------------- | | VARIO Cloud → your App | **appToken** | Is this incoming request really from VARIO Cloud? | | Your App → VARIO Cloud | **accessToken** (obtained from an **offlineToken**) | May this App read/write data in this tenant? | The **VARIO App Framework** handles both for you. This page explains what it does, so you can debug it — and so you can implement it yourself if you don't use the framework. *** ## The client configuration Your App is identified by the four values you receive when [creating the App](/documentation/apps/create-an-app). The demo app keeps them in `app-client.js`, exporting them as a module: ```javascript // app-client.js module.exports = { appIdentifier: '…', clientId: '…', clientSecret: '…', appJWK: { keys: [ /* … */ ] }, }; ``` You pass this object when constructing the App: ```javascript const VarioCloudApp = require('@vario-software/vario-app-framework-backend/app.js'); const client = require('../app-client.js'); const app = new VarioCloudApp(client); app.port = 8443; app.uiPath = path.resolve(__dirname, '../frontend'); app.offlineToken.init().then(() => app.start()); ``` {% hint style="warning" %} `app.start()` validates the configuration and throws if `appIdentifier`, `clientId`, `clientSecret` or `appJWK` is missing. `appJWK` must be valid JSON — a JSON **string** is parsed automatically, anything that isn't an object is rejected with `appJWK is not a valid JSON`. {% endhint %} *** ## Inbound: verifying the appToken Every request VARIO Cloud sends to your App carries an **appToken** — a JWT signed with ES256. The framework installs an authentication middleware on the App's API router, so all your `/api/*` routes are protected automatically. Verification checks that: * the signature matches the public key in your `appJWK`, * the `aud` claim equals your `appIdentifier`, * the token has not expired. If any check fails, the request is answered with **401** and never reaches your route. The token is normally read from the `Authorization: Bearer ` header. There is one exception: for `GET` requests to `/api/install` and `/api/uninstall`, it is read from the `appToken` **query parameter** — this exists so Apps without a UI can be installed. {% hint style="info" %} This is also how you verify **webhooks**: a webhook call into your App is authenticated the same way. If you handle webhooks through the framework's API router, verification already happened. See [Webhooks](/documentation/webhooks/introduction). {% endhint %} *** ## Outbound: from offlineToken to accessToken To call the VARIO Cloud API, your App needs an access token **per tenant**. 1. During installation, VARIO Cloud hands your App an **offlineToken** for that tenant — long-lived, but not unlimited (see [Lifetime](#lifetime-45-days-sliding)). 2. Your App stores it, keyed by tenant. 3. On the first API call, the framework exchanges the offlineToken for a short-lived **accessToken** at the tenant's identity server. 4. The accessToken is cached until shortly before it expires, then refreshed. The framework also derives the tenant's **API base URL** from the offlineToken itself: the token's issuer (`iss`) points at the tenant's identity server, and stripping the `sso.` prefix yields the tenant host. Requests are then sent to `https:///api/vario`. → See [REST API Introduction](/documentation/rest-api/introduction) for how base URLs are structured. ### Bootstrap: the install call The offlineToken arrives when VARIO Cloud installs your App in a tenant: it calls your install endpoint with the token in the request body: ```javascript // api/install const { offlineToken } = req.body; if (offlineToken) { await app.offlineToken.set(tenant, offlineToken); } ``` A typical install service does three things in order: ```javascript const install = async function () { await runAsAppUser(); // act as the App's technical user await saveOfflineToken(); // persist the tenant's offlineToken await migration1(); // create backends, EAV groups, webhooks… }; ``` {% hint style="danger" %} **Losing the offlineToken means losing API access for that tenant** until it is renewed. Persist it durably before you run anything else, and delete it again on uninstall. {% endhint %} ### Lifetime: 45 days, sliding An offlineToken is valid for **45 days** — but the clock restarts on **every use**. Each time your App exchanges it for an access token, its validity is extended to a fresh 45 days. In practice that means a regularly active App never sees the token expire. It only becomes invalid after **45 consecutive days without a single API call** for that tenant. {% hint style="warning" %} This bites Apps that are idle for long stretches — a seasonal integration, a tenant in a test environment, an App that only acts when the customer triggers something. If that describes your App, make sure it touches the API at least once inside the window (a small scheduled call is enough), or accept that the customer will have to renew the token before the App works again. {% endhint %} ### Renewal: the install call happens again An offlineToken is not permanent — it expires if unused, and the customer can replace it deliberately. In the Admin-Center, on the installed App's page, the action **"Offline-Token erneuern"** issues a fresh token and then opens your App's installation page (`pcInstallationUrl`) again with the new token attached — which hands it to your install endpoint exactly as it does on a first install. In other words: **install is not a one-shot event.** The same endpoint that bootstrapped the App is also the renewal channel. Two consequences for your implementation: * **Overwrite unconditionally.** Store the incoming token even when you already have one — otherwise renewal silently keeps the dead token. ```javascript if (offlineToken) { await app.offlineToken.set(tenant, offlineToken); // replaces the previous one } ``` * **Keep install idempotent.** It will run again on an already-provisioned tenant. Migration steps that already ran are skipped for you, but anything you do outside a migration step must tolerate repetition. {% hint style="info" %} When a token has expired, the App instance is flagged accordingly and the customer is prompted to renew it. Your App cannot trigger renewal itself — so when API calls for one tenant start failing with `401`, log the tenant clearly so the cause is recognisable. {% endhint %} ### Where the offlineToken is stored Out of the box, `app.offlineToken` keeps tokens in a local JSON file (`offlineToken.db`) — convenient for development, but not suitable for a multi-instance production deployment. You can pass your own storage implementation (`get`, `set`, `delete` per tenant) via the App options and keep tokens in your own database or secrets store. Changing or deleting a stored offlineToken also drops the cached accessToken for that tenant. *** ## Making API calls Once installed, you don't manage tokens at all — you use the ERP client on the App: ```javascript const { data } = await app.erp.vql({ statement: `SELECT id, articleNumber FROM article.query`, limit: 100, }); ``` The framework attaches, on every request: | Header | Value | | ------------------------- | ---------------------- | | `Authorization` | `Bearer ` | | `user-agent` | your `appIdentifier` | | `Accept` / `Content-Type` | `application/json` | {% hint style="info" %} The VARIO Cloud API **rejects requests without a `User-Agent`** with `403 Forbidden`. The framework satisfies this by sending your `appIdentifier` — if you call the API without the framework, you must set the header yourself. See [REST API Authentication](/documentation/rest-api/authentication). {% endhint %} If the API answers `401`, the cached accessToken for that tenant is discarded so the next call fetches a fresh one. *** ## Without the framework Nothing here is magic — the App model sits on plain OAuth 2.0. If you implement it yourself, you must: 1. Verify the inbound appToken (ES256, `aud` = `appIdentifier`, not expired) against your `appJWK`. 2. Store the offlineToken you receive on install, per tenant. 3. Exchange it for an accessToken using the **refresh token** grant with your `clientId` and `clientSecret`. 4. Send `Authorization: Bearer ` **and** a `User-Agent` on every request. 5. Cache access tokens and refresh them before they expire. The grant types and endpoints are documented in [REST API Authentication](/documentation/rest-api/authentication). # Create an App Register an App in the Admin-Center and obtain its API credentials. ### Creating a new App and getting API credentials Start in the VARIO Cloud Admin-Center: [https://admin.vario.cloud](https://admin.vario.cloud/) #### Step 1 – Open the Developer Menu (This has to be activated for you by the VARIO AG) 1. Sign in to the VARIO Admin-Center. 2. In the left-hand navigation, select **“Entwickler”** (Developer). This opens the Developer view where you see a list of your existing Apps. #### Step 2 – Start the “Create App” dialog 1. In the Developer view, locate the buttons in the header toolbar on the top right. 2. Click **“App erstellen”** (Create App). A dialog titled **“Neue App erstellen”** (Create new App) will open.\ It contains a single text field labeled **“App-Manifest”**. #### Step 3 – Paste the App manifest To define your new App, you must provide a valid **App manifest** in JSON format. 1. Prepare your manifest JSON locally. 2. Paste the JSON into the **App-Manifest** field. 3. Click **“Anlegen”** (Create). **EXAMPLE APP MANIFEST** ```json { "appVersion": "1.0.0", "label": "Demoapp", "description": "Just a demo app", "shortName": "demoapp", "rootUrl": "https://app.example.com/", "pcInstallationUrl": "https://app.example.com/ui/install.html", "pcInstallationDeletionUrl": "https://app.example.com/ui/uninstall.html", "pcManifestUrl": "https://app.example.com/manifest", "requirements": { "licenseKey": "app_demo_license_key", "permissions": [ { "resource": "crm-activity", "verb": "read" }, { "resource": "crm-activity", "verb": "create" } ] }, "authorizationVerbs": [ { "verb": "use-app", "description": "Allowed to use the demo app" }, { "verb": "add-activity", "description": "Allowed to add activities" } ], "uiIntegrations": { "integrations": [ { "pointOfIntegration": "navigation.root", "id": "demo-page", "url": "https://app.example.com/ui/demo.html", "iconClass": "fal fa-atom-simple", "msgKey": "Demoapp", "permissionKey": "use-app" }, { "id": "demo-dialog", "url": "https://app.example.com/ui/demo-dialog.html" }, { "id": "demo-vr", "url": "https://app.example.com/ui/demo-vr.html" } ] } } ``` At this point, you have defined: * basic App metadata (`label`, `description`, `appVersion`) * licensing and visibility (`uniqueLicenseKey`, `privateApp`, `dedicatedApp`) * URLs for the App backend and UI (`rootUrl`, `pcInstallationUrl`, `pcInstallationDeletionUrl`, `pcManifestUrl` ) * required **permissions** for the APP (access to the activity table in this case) under `requirements.permissions` * custom **authorization permissions** that can be assigned to users * **UI integrations** (for example, a navigation entry via `pointOfIntegration: "navigation.root"`) #### Step 4 – Copy your API credentials (AppClient) After you create the App successfully, VARIO-Cloud will generate OAuth2 client credentials for this App: ```json { "appIdentifier": "your-app-identifier", "clientId": "your-client-id", "clientSecret": "your-client-secret", "appJWK": "JWK_TOKEN" } ``` {% hint style="danger" %} **Important**\ `appIdentifier`, `clientId`, `clientSecret` and `appJWK` are shown **only once**.\ You must copy these values immediately and store them securely (for example in a password manager, a secrets vault, or environment variables used by your App). {% endhint %} These values are what you will use later to authenticate against the VARIO-Cloud API (e.g. when requesting OAuth2 tokens) and to verify the APP\_JWK Token. Once you have copied and stored these credentials, you are ready to continue with authentication (e.g. OAuth2 Refresh Token grant) and actual API calls. # App Manifest Reference for every manifest field — metadata, URLs, permissions and UI integrations. ### App manifest reference The App manifest is a JSON document that describes your App to VARIO Cloud.\ It defines metadata, technical URLs, permissions and UI integration points. ``` { "appVersion": "1.0.0", "label": "Demoapp", "description": "Just a demo app", "shortName": "demoapp", "rootUrl": "https://app.example.com/", "pcInstallationUrl": "https://app.example.com/ui/install.html", "pcInstallationDeletionUrl": "https://app.example.com/ui/uninstall.html", "pcManifestUrl": "https://app.example.com/manifest", "requirements": { "licenseKey": "app_demo_license_key", "permissions": [ { "resource": "crm-activity", "verb": "read" }, { "resource": "crm-activity", "verb": "create" } ] }, "authorizationVerbs": [ { "verb": "use-app", "description": "Allowed to use the demo app" }, { "verb": "add-activity", "description": "Allowed to add activities" } ], "uiIntegrations": { "integrations": [ { "pointOfIntegration": "navigation.root", "id": "demo-page", "url": "https://app.example.com/ui/demo.html", "iconClass": "fal fa-atom-simple", "msgKey": "Demoapp", "permissionKey": "use-app" }, { "id": "demo-dialog", "url": "https://app.example.com/ui/demo-dialog.html" }, { "id": "demo-vr", "url": "https://app.example.com/ui/demo-vr.html" } ] } } ``` Below is a description of all fields used in the example manifest. *** #### Top-level fields #### `appVersion` Type: `string` (semantic version, e.g. `"1.0.0"`) Version of the App itself.. *** #### `label` Type: `string` Human-readable name of the App.\ This is shown in the VARIO-Cloud UI. *** #### `description` Type: `string` Short description of what the App does.\ Used in the UI to help users understand the purpose of the App. *** #### `shortName` Type: `string` Unique identifier used by the VARIO-Cloud as a suffix to identify what app, for example, a role is connected to. * Must be unique across all apps. * Only accepts EN-letters and \_ or - *** #### `rootUrl` Type: `string` (URL) Base URL of the App backend / web application. * Example: `https://app.example.com/` *** #### `pcInstallationUrl` Type: `string` (URL) URL called when the App is **installed** for a tenant. Typical use cases: * Initialize data or configuration for this tenant. * Register webhooks or background jobs. *** #### `pcInstallationDeletionUrl` Type: `string` (URL) URL called when the App is **uninstalled** from a tenant. Typical use cases: * Clean up tenant-specific data or configuration. * Deregister webhooks or background jobs. *** #### `pcManifestUrl` Type: `string` (URL) URL where VARIO-Cloud can fetch additional technical metadata for the App (the “runtime manifest”). * Used by the platform to understand capabilities, endpoints or configuration dynamically. * Should return a JSON document. *** #### `requirements` object The `requirements` section declares what the App needs from the VARIO-Cloud platform. ``` "requirements": { "licenseKey": "app_demo_license_key", "permissions": [ { "resource": "crm-activity", "verb": "read" }, { "resource": "crm-activity", "verb": "create" } ] } ``` #### `requirements.licenseKey` Type: `string` The App's **own** license key, which grants access to the App itself. {% hint style="info" %} **You do not author this value.** VARIO Cloud generates it when the App is created, in the form `app__`, and preserves it whenever the manifest is refreshed — a manifest you send cannot overwrite it. It must be globally unique. {% endhint %} To declare licenses your App *depends on*, use `requirements.licenseKeys` instead. *** #### `requirements.licenseKeys` Type: `array` of `string` Additional **existing platform licenses** the tenant must already have for your App to be installable. ```json "requirements": { "licenseKeys": ["workflow_license"] } ``` Common values include `workflow_license` and `scripting_license`. {% hint style="warning" %} Installation fails with **422** if the tenant is missing any required license — both `licenseKey` and every entry in `licenseKeys` are checked. At **runtime**, a missing or exceeded license produces **402 Payment Required** instead. If your App can work without an optional license, check for it and degrade gracefully rather than failing. {% endhint %} *** #### `requirements.permissions` Type: `array` of `Permission` objects Declares which **API permissions** the App requires to operate. Each entry has: **`permission.resource`** Type: `string`\ Example: `"crm-activity"` Name of the resource in the VARIO-Cloud API that the App wants to access\ (e.g. customers, orders, CRM activities, …). **`permission.verb`** Type: `string`\ Examples: `"read"`, `"create"`, `"update"`, `"delete"` Operation the App wants to perform on the given resource.\ The exact set of verbs is defined by the VARIO-Cloud. > Together, `resource` + `verb` define a single permission, such as\ > `crm-activity:read` or `crm-activity:create`. *** #### `authorizationVerbs` array Declares **App-specific authorization permissions** that can later be assigned to users or roles inside VARIO-Cloud. ``` "authorizationVerbs": [ { "verb": "use-app", "description": "Allowed to use the demo app" }, { "verb": "add-activity", "description": "Allowed to add activities" } ] ``` Each entry defines a custom capability. #### `authorizationVerbs[].verb` Type: `string`\ Example: `"use-app"` A symbolic key representing a permission **inside** the App. * They are used by VARIO-Cloud to control what different users may do in the App. #### `authorizationVerbs[].description` Type: `string` Human-readable explanation of what the permission allows.\ Shown in the UI when assigning permissions to users or roles. *** #### `uiIntegrations` object Defines how the App integrates into the VARIO-Cloud **user interface**. ``` "uiIntegrations": { "integrations": [ { "pointOfIntegration":"navigation.root", "id":"demo-page", "url":"https://app.example.com/ui/demo.html", "iconClass":"fal fa-atom-simple", "msgKey":"Demoapp", "permissionKey": "use-app" }, { "id":"demo-dialog", "url":"https://app.example.com/ui/demo-dialog.html" }, { "id":"demo-vr", "url":"https://app.example.com/ui/demo-vr.html" } ] } ``` #### `uiIntegrations.integrations` Type: `array` of `Integration` objects Each entry describes one UI integration point. Common fields: **`integration.id`** Type: `string`\ Example: `"demo-page"` Unique identifier of this integration within the App manifest. **`integration.url`** Type: `string` (URL) URL where VARIO-Cloud can find actions / ui elements when the user triggers this integration *** Additional fields for navigation entries: **`integration.pointOfIntegration`** Type: `string`\ Example: `"navigation.root"` Specifies where in the VARIO-Cloud UI this integration appears. Omit it entirely for integrations you open yourself (see [Integrations without a point of integration](#integrations-without-a-point-of-integration)). Some points contain the placeholder `{APP_IDENTIFIER}`, which is replaced with your App's identifier at runtime — these points are reserved for the App that owns the object being displayed. ### Finding the available integration points **The set of integration points grows with every release, so this page deliberately does not list them.** Read them out of the running application instead — that way you always see the points your version actually offers: 1. Open your ERP in [support mode](https://help.vario-software.de/support/melden-von-problemen-in-vario-cloud/support-modus). 2. Enable the toggle **"App-Integrationspunkte anzeigen"** ("Show app integration points"). 3. Reload when prompted — the setting only takes effect after a reload. The ERP then renders a placeholder at every available integration point, labelled with the `pointOfIntegration` string you need for your manifest. Navigate to the screen you want to extend and read the value off it. **One value is not discoverable that way**, because it renders nothing of its own: | Value | Meaning | | ------------------------ | --------------------------------------------------------------------------------- | | `.badge` | Renders a badge on the tab of your own integration whose `id` matches the prefix. | {% hint style="danger" %} **An unknown `pointOfIntegration` fails silently.** Matching is exact string comparison, and there is no manifest validation — a typo means your integration simply never appears, with no error anywhere. The same is true for an unknown `resource` or `verb` in `requirements.permissions`: the permission is just never granted. {% endhint %} **`integration.iconClass`** Type: `string`\ Example: `"fal fa-atom-simple"` FontAwesome class for the icon that will be displayed in the UI. **`integration.msgKey`** Type: `string`\ Example: `"Demoapp"` Label displayed in the UI for this integration. **`integration.permissionKey`** Type: `string`\ Example: `"use-app"` Links this UI integration to one of the App’s `authorizationVerbs`. * Only users who have this verb assigned are allowed to see or use the integration. **`integration.contextAttribute`** Type: `object` Free-form metadata attached to the integration. Only meaningful where a specific integration point reads it. *** ### Integrations without a point of integration An integration with an `id` but **no** `pointOfIntegration` is never rendered by the ERP on its own. It exists so the URL is registered, and is opened on demand — typically as a dialog your own UI requests: ```javascript sendMain({ dialog: { open: { integrationId: 'settings.graphql-queries.editor', title: 'GraphQL Editor', }, }, }); ``` The ERP resolves the `id` in your manifest, opens it in a full-screen dialog, and returns the result to your App. Use this for editors, wizards and confirmation dialogs. Sub-pages that you navigate to *inside* your own App still need a manifest entry so the URL exists, even though nothing opens them by `id`. *** ### `requirements.permissions` vs `authorizationVerbs` These two are easy to confuse and do completely different things: | | `requirements.permissions` | `authorizationVerbs` | | ---------------- | -------------------------------------------------- | ------------------------------------------------ | | Grants access to | **your App's technical user**, calling the ERP API | **human users**, for actions inside your App | | Shape | `{ resource, verb }` | `{ verb, description }` | | Checked against | ERP resources and operations | your App's own identifier | | Failure | `403` from the ERP API | `403` from your own permission check | | Used with | API calls | `integration.permissionKey`, and your own checks | For `requirements.permissions`, `resource` is an ERP domain (for example `account`, `article`, `document`, `sales-channel`, `eav`, `masterdata`) and `verb` is either a standard operation — `create`, `read`, `update`, `delete`, `activate`, `deactivate` — or a domain-specific one such as `document:readSalesDocuments` or `crm-task:updateForeignCrmTask`. {% hint style="info" %} The authoritative list of resources and verbs for your installation is available from the ERP itself via the roles/permissions endpoint — see the [API Reference](https://developer.vario-software.de/api-reference). Requesting a permission that doesn't exist is silently ignored. {% endhint %} # UI Integration How an App and the ERP talk to each other inside the iframe — postMessage protocol, dialogs, height, widgets. Your App runs in an **iframe** inside the ERP. The [manifest](/documentation/apps/app-manifest) declares *where* it appears; this page describes how the two sides talk once it is there. Everything goes through `postMessage`, wrapped in two helpers: ```javascript import { sendMain, receiveMain } from '@vario-software/vario-app-framework-frontend/script/communication.js'; sendMain({ height: 640 }); const stop = receiveMain({ updateComponents: () => reload(), route: route => console.log(route.name), }); ``` `sendMain` automatically adds your `appIdentifier` and `integrationId` to every message — the ERP uses both to route it back to the right frame. {% hint style="warning" %} Because those two keys are added first and your payload is spread after them, a payload key called `appIdentifier` would overwrite the routing information. Don't reuse those names. `receiveMain` calls your handler for **every** key present in an incoming message, and it checks nothing about the sender. Treat inbound data as untrusted. {% endhint %} ## The ERP must hear from you within 15 seconds The host waits for a first valid message as a loaded-handshake. If none arrives within **15 seconds**, your App is replaced by an "app not available" message. The designated signal for this is: ```javascript sendMain({ ready: true }); ``` The framework sends it for you from `secureIntegration()`, which runs on `DOMContentLoaded`. That function does two things: it verifies your page is really embedded in a VARIO Cloud frame (by checking the referrer against the `*.vario.cloud` hosts and `localhost`), and then reports readiness. {% hint style="info" %} The host does not insist on that specific key — it treats **the first valid message** as the handshake, whatever it contains. So an App that immediately reports its height is also fine. `ready` is simply the explicit, guaranteed way to do it. Don't confuse it with `customActivity`, which is unrelated: that one resets the ERP's idle timer during long interactions so the user isn't logged out. {% endhint %} {% hint style="warning" %} **Send it yourself rather than relying on the framework.** In the current published version `secureIntegration()` throws before it reaches the `ready` message (see the warning at the end of this page), so nothing is sent. Apps still work because their own first message satisfies the handshake — but if your App renders slowly and sends nothing early, it will be marked unavailable. {% endhint %} {% hint style="danger" %} **During installation the deadline is harsher.** The install dialog rolls the installation back after **120 seconds**. Send `installationComplete` when done, or keep sending `uninstallAlive` while you work — otherwise your App is uninstalled again. {% endhint %} ## Sizing the frame **An iframe cannot grow with its content.** There is no `height: auto` that means "as tall as the page inside" — the browser gives the frame a fixed box, and anything taller simply scrolls **inside** it. The result is the thing users complain about: a second scrollbar within the ERP page, and your content cut off at an arbitrary line. The ERP cannot fix this on its own either. Your App is served from your own domain, so the host is not allowed to measure the document inside the frame. **Only you know how tall your content is.** Hence the contract: *you measure, the host applies.* ```javascript sendMain({ height: document.body.scrollHeight }); ``` Send it once the content is rendered, and again whenever it changes — after loading data, expanding a section, opening a form. The framework can do this continuously for you via `initHeightTransfer()`, which watches the body and re-sends on every change. {% hint style="warning" %} That creates a feedback loop: you send a height → the host resizes the iframe → your layout changes → you send again. It is only damped by an "unchanged value" check, so content whose layout depends on the frame height can oscillate. The robust alternative is to let the host own the height: ```javascript sendMain({ useFullHeight: true }); receiveMain({ height: value => resizeTo(parseInt(value, 10)) }); ``` The host then computes the height from the viewport and sends it to you. Note the **type flip**: outbound `height` is a number of pixels, inbound `height` is a CSS string such as `"650px"` or `"calc(100vh - 259px)"`. {% endhint %} Once the host owns the height — in full-height mode, in a dialog, or in a dashboard widget — your own `height` messages are **ignored**. Inside a dialog use `sendMain({ dialog: { fullHeight: true } })` instead. ## Dialogs Your App can open another of its own integrations as a modal, and get a value back. **Open it** (the `integrationId` must be declared in your manifest, typically without a `pointOfIntegration`): ```javascript sendMain({ dialog: { open: { integrationId: 'my-editor', title: 'Editor', additionalPayload: { id } }, updateComponentsAfterDismiss: true, }, }); ``` **Close it and return a value** — this is what the dialog's own code sends: ```javascript sendMain({ dialog: { close: true, result: { confirmed: true, value } } }); ``` **Receive the result** in the opener: ```javascript receiveMain({ dialogResult: result => apply(result), }); ``` {% hint style="info" %} If the user dismisses the dialog with the close button instead, **no result is sent at all** — `dialogOk`/`dialogResult` never arrive. That is what `updateComponentsAfterDismiss` is for: it makes the ERP refresh its components anyway. Note it sits on `dialog`, not inside `dialog.open`. {% endhint %} Inside a dialog you can also send `dialog.disablePadding` and `stickynavButtons` (rendered into the dialog header). ## Using the ERP's own dialogs You don't have to build pickers. Ask the host to open its own and send you the result: | Send | Get back | | -------------- | -------------------------------------------------- | | `searchDialog` | `searchDialog-` — `{ selected }` | | `datepicker` | `datepicker-` — JSON string of `{ date, to }` | | `cron` | `cron-` — JSON string of `{ value }` | | `colorpicker` | `colorpicker-` — JSON string of `{ value }` | | `confirmation` | `confimation` — `{ key, values }` | Each accepts an optional `key` so you can tell several instances apart; without it the reply key ends in `-result`. {% hint style="danger" %} Two things will cost you an afternoon: 1. **`confimation` is misspelled** — one `r` is missing, on both sides. Listening for `confirmation` receives nothing. 2. **`datepicker`, `cron` and `colorpicker` results arrive as JSON strings** and must be parsed. `searchDialog` only stringifies `selected` when multiple selection is enabled. `dialogResult` is passed through raw. Cancelling a picker sends **nothing** — only `confirmation` reports a cancel, as `{ key: false }`. {% endhint %} ## Integrating into the ERP shell | Message | Effect | | -------------------------------- | --------------------------------------------------------------------------------------- | | `ready` | Confirms your integration has loaded — the handshake described above | | `updateComponents` | Tells the ERP to refresh its datagrids and badges | | `notify` | Shows an ERP toast; `route` adds an open-in-new-tab action | | `badge` | Puts a badge on your tab | | `backlink` | Custom back link; clicking it sends you `back` | | `stickynavButtons` | Buttons in the sticky nav; a click sends you `button-` | | `stickynavTabs` | Sub-tabs bound to the route; the host rewrites the URL rather than reloading you | | `editmode` | Register, enter or leave the ERP's edit mode; you then receive `edit`, `save`, `cancel` | | `documentTitle` | Sets the browser tab title | | `copyToClipboard` | Copies text and shows a confirmation | | `customActivity` | Resets the idle timer, preventing auto-logout during long interactions | | `minWidth` | Minimum width for your frame | | `openInNewTab` / `openInSameTab` | Navigate the ERP (see below) | | `updateSettings` | Change a shared setting — only the level-of-detail and UI-mode keys are accepted | Some of these are vetoed by the host depending on where you are embedded: `stickynavButtons`, `backlink` and `editmode` are ignored inside dialogs and widgets. {% hint style="warning" %} **Nothing is queued.** A message you send before the host has attached its listener is lost, and a message the host sends before your frame exists is dropped. Send state-establishing messages (buttons, tabs, badge, backlink) on `DOMContentLoaded` or later, and re-send them after you receive `routeChanged`. {% endhint %} ## What the host sends you | Key | Meaning | | --------------------------- | ------------------------------------------------- | | `height` | New frame height (CSS string) in full-height mode | | `updateComponents` | Something changed in the ERP; refresh | | `changeLanguageCode` | The user switched language | | `route` + `routeChanged` | The ERP route changed | | `submit` | An ERP form is submitting — see below | | `dialogOk` / `dialogResult` | Your dialog resolved | | `back` | Your custom backlink was clicked | | `appToken` | A refreshed App token | | `edit` / `save` / `cancel` | Edit-mode actions | | `button-` | One of your sticky-nav buttons was clicked | | `beforeUnmount` | Your integration is being torn down | ### Answering a submit When the ERP submits a form that contains your integration, it asks you to confirm: ```javascript receiveMain({ submit: ({ correlationId }) => { const ok = validate(); sendMain(ok ? { submitConfirmed: true, correlationId } : { submitRejected: true, correlationId }); }, }); ``` {% hint style="warning" %} `correlationId` must be sent back as a **sibling key**, not nested inside an object — otherwise the ERP cannot match your answer. And if you don't answer at all, the ERP proceeds anyway after its timeout. {% endhint %} ## Navigating the ERP ```javascript sendMain({ openInNewTab: { name: 'documents-sales.index' } }); sendMain({ openInNewTab: { name: 'documents-sales.detail', params: { id } } }); ``` The target is a standard vue-router location, so `name` must be a route the ERP actually has. {% hint style="info" %} **Route names are not listed here** — there are many and they change per release. The ERP's route definitions are the source of truth; the names follow the visible hierarchy (`documents-sales.index`, `accounts.detail.tabs.masterdata`, `settings.general.users.index`). App integrations get generated names of the form `apps..`. {% endhint %} `openInSameTab` navigates the ERP window itself and is deliberately restricted — a string target is only accepted for VARIO Cloud hosts. ## Parameters you receive The host puts context on your integration URL. The framework exposes the common ones: `appIdentifier`, `integrationId`, `language`, `supportMode`, `myCompanyId`, `uimode`, `detailDatagridTable`, `superUser`, `permissions`, `additionalPayload` Also on the URL but not exposed by the framework — read them from the query string yourself: `userId`, `detailDatagrid`, `routeName`, and every parameter of the current ERP route. {% hint style="warning" %} **All values are strings.** `superUser` must be compared to `'true'`; using it as a boolean makes every user a super user. `additionalPayload` is a JSON string when the host passes an object — parse it. On installation and uninstallation pages the parameter set is smaller: there is no `integrationId`, no `superUser` and **no `permissions`**. Calling a permission check there fails, so guard it. {% endhint %} ## Dashboard widgets A widget is an integration mounted at one of the `dashboard.*` integration points. Its title and icon come from the manifest; the grid fixes the minimum size. **Settings are exchanged, not stored by you.** Announce your defaults, and the host sends back the user's saved settings merged over them: ```javascript receiveMain({ widgetSettings: settings => apply(settings), widgeEditmode: active => setEditMode(active), }); sendMain({ widget: { init: { showTotals: true } } }); // your defaults ``` When the user changes something, report it and the dashboard persists it: ```javascript sendMain({ widget: { settings: { showTotals: false } } }); ``` {% hint style="warning" %} Two details: * The inbound edit-mode key is spelled **`widgeEditmode`** — missing a `t`. Use it exactly as written. * If you send `widget.init` **without** any defaults, the host concludes your widget has no settings and shows no settings affordance at all. {% endhint %} To follow the ERP's own edit mode, report your state with `sendMain({ widget: { editmode: { active } } })`. ## Reusing the ERP's look The framework ships **CSS only** — no JavaScript components. Link the stylesheet and write plain markup with `v-*` classes: ```html ``` Controls rely on structure. A checkbox needs a wrapper, and the input must come **immediately before** its label, because the checked state is expressed with an adjacent-sibling selector: ```html
``` Put anything between the input and the label and nothing renders. `v-toggle` has the same structure for switches. Dark mode and responsive breakpoints are applied by `initSharedSettings()` and `initScreenSize()`, which set classes on `body`. {% hint style="danger" %} **Call those initialisers explicitly.** In the current published framework, `secureIntegration()` throws before it can start them, which silently costs you dark mode, responsive classes, height transfer and token refresh. Call `initHeightTransfer()`, `initAppTokenHandling()`, `initSharedSettings()` and `initScreenSize()` yourself rather than relying on the bootstrap. Also: `initStickynav()` waits for a reply the ERP never sends. Do not `await` it. {% endhint %} ## Related * [App Manifest](/documentation/apps/app-manifest) — declaring where your integration appears * [App Authentication](/documentation/apps/authentication) — the App token you receive * [FAQ](broken://pages/DmBZgbUEXCMyhXGUtn1t) # App Backends How an app registers a backend and takes over a role in the ERP. Most apps only *read and write* ERP data. The apps in this space do something more: they **take over a role** in the ERP. To do that, an app registers a **backend** — a record in the ERP that says *"for this domain, I am responsible"*. {% hint style="info" %} Every domain in this space works the same way. Learn it once here. {% endhint %} ## The pattern ``` ┌───────────┐ 1. install: register backend ┌───────────┐ │ Your App │ ──────────────────────────────► │ VARIO ERP │ │ │ │ │ │ │ ◄────────────────────────────── │ │ └───────────┘ 2. ERP calls back / notifies └───────────┘ ``` {% stepper %} {% step %} ## On install A migration creates a backend record carrying your **app identifier**. {% endstep %} {% step %} ## From then on The ERP routes work in that domain to you — either by calling a URL you registered, or by firing a [webhook](https://developer.vario-software.de/documentation/webhooks/introduction). {% endstep %} {% endstepper %} Two things make the record yours: | Field | Value | Why | | ---------------------- | -------------------- | -------------------------------------------------------------------- | | `appId` | your `appIdentifier` | The ERP knows which app owns this backend, and you can find it again | | `type` / `backendType` | `APP` | Distinguishes an app-provided backend from a built-in one | ## What each domain registers | Domain | Record | Endpoint | | --------------------------------------------------------------------------------------------- | -------------------------------------- | ------------------------------------------------------ | | [Onlineshops and Marketplaces](/documentation/apps/app-backends/onlineshops-and-marketplaces) | Sales channel backend + sales channels | `POST /community/{version}/erp/sales-channels/backend` | | [Shipping](/documentation/apps/app-backends/shipping-carrier) | Carrier type | `POST /community/{version}/vds/carrier-type` | | [Banking](/documentation/apps/app-backends/banking) | Bank backend | `POST /erp/bank/backend` | | [Financial Accounting](/documentation/apps/app-backends/financial-accounting) | Finance backend | `POST /community/{version}/erp/finance/backend` | | [POS Payment Methods](/documentation/apps/app-backends/pos-payment-methods) | POS payment backend | `POST /community/{version}/erp/pos/payment/backend` | The framework provides migration helpers for sales channel, bank and finance backends. Carrier types and POS payment backends are created with a plain API call. {% hint style="info" %} The naming is not uniform. Most domains have something literally called a *backend*; shipping does not — there the **carrier type** (`Versendertyp`) plays that role, carrying the app identifier and the callback URLs. There is no "carrier backend". {% endhint %} ## How the ERP reaches you This is the part that surprises people: for several domains the ERP calls **into your app**, synchronously. You register those URLs on the backend record itself. | Domain | URL fields on the record | Called when | | -------- | ---------------------------------------------------- | --------------------------------------------------------------- | | Shipping | `createShipmentSyncUrl`, `createLabelSyncUrl` | A shipment is created / a label is requested | | Banking | `appTransactionUrl`, `appPaymentUrl`, `appStatusUrl` | Transactions are fetched / a payment is sent / status is polled | {% hint style="warning" %} Your app must be publicly reachable for these to work. The URL is built from your app's public host at install time — which means **if that host changes, the stored URLs are stale**. Every shipping app ships a later migration that rewrites them for exactly this reason. {% endhint %} ## What you register vs. what the customer creates A frequent misunderstanding. Your app registers the **technical infrastructure**. The customer creates their own **business objects** on top of it: | You create (on install) | The customer creates (in the ERP) | | ---------------------------------------- | ----------------------------------------------------------------------- | | Carrier **type** ("DHL App") | Carriers and shipping methods that use it | | Bank **backend** ("PayPal") | Their banks, which select your backend | | POS payment **backend** | The payment methods that point at it, and their assignment to registers | | Sales channel **backend** ("Shopware 6") | Usually created by your app — one channel per store | So a shipping app never creates a carrier, and a banking app usually never creates a bank — it makes itself *selectable*. Don't create customer master data on install; the customer owns names, IBANs and BICs. {% hint style="warning" %} **Deactivate, don't delete, on uninstall.** Customer objects that reference your backend must survive an uninstall so they can be reactivated on reinstall. Deactivate in dependency order (children before parents) — the ERP validates references to inactive parents. {% endhint %} ## Migrations Backends are created in a **migration** that runs on install. Two things you must understand: {% hint style="info" %} **Migrations run once, ever.** Each step is recorded by name. Editing an existing step does nothing on tenants where it already ran — you must add a **new, differently named step**. {% endhint %} ```javascript const migratorErp = new MigratorErp('migration1'); await migratorErp.setMigration('salesChannel', async (methods) => { const backend = await methods.createSalesChannelBackend('My Shop', ['ECOMMERCE']); await methods.createSalesChannel(backend, 'My Shop', '', 'ECOMMERCE'); await methods.activateSalesChannelBackend(backend); }); ``` Use `always(key, callback)` instead of `setMigration` for steps that must re-run on every install — webhook registration is the usual case. {% hint style="warning" %} **A failed migration does not fail the install.** Errors are caught, reported to your error handler and written to the app log — the install still reports success. If a backend seems to be missing, read the app log. Failed steps are not recorded as done, so they retry on the next install. {% endhint %} {% hint style="warning" %} **Order matters.** Later steps that look up what earlier steps created will fail if the order is wrong — for example, an EAV group must exist before it can be read or changed, and a bank cannot reference a backend that isn't there yet. {% endhint %} ## Sandbox vs. production There is no platform-level sandbox flag. Two approaches are used: * **A second backend record** whose label is suffixed `(Sandbox)` — the shipping apps do this, and detect the mode from the label. * **A configuration value** the user toggles — PayPal does this. {% hint style="warning" %} Configuration values round-trip through storage as **strings**. The string `"false"` is truthy in JavaScript, so compare explicitly (`value === 'true'`) rather than relying on truthiness. This has caused real incidents where a sandbox flag sent live traffic to production. {% endhint %} ## Finding your backend again You rarely keep the id. Query it back by your own app identifier — e.g. via [VQL](https://developer.vario-software.de/documentation/fundamentals/vql): ```sql SELECT id FROM sales-channel.salesChannelBackends WHERE appId = '' AND type = 'APP' ``` The framework's `findSalesChannelBackend()` does exactly this. ## Checklist * Manifest declares the permissions your domain needs * Migration registers the backend with your `appId` and type `APP` * Callback URLs point at your public host — and a later migration can refresh them * Webhooks registered with `always()`, not `setMigration()` * Uninstall deactivates (never deletes) customer objects, children first * Sandbox mode explicit, with string-safe boolean checks * App log checked after install — failures are silent # Onlineshops and Marketplaces Connect a shop or marketplace: sales channels, listings, outbound sync and order import. A shop app connects an online shop or marketplace — Shopware 6, Shopify, Amazon, eBay, Channelpilot — to the ERP. Products, prices, stock and images go **out**; orders come **in**. {% hint style="info" %} Read [App Backends](/documentation/apps/app-backends) first; this page only covers what is specific to this domain. {% endhint %} ## Backend vs. channel | | Sales channel **backend** | Sales **channel** | | ---------- | ------------------------------------- | ----------------------------------------------------- | | How many | **One** per app per tenant | **Many** — one per connected store | | Represents | The integration itself ("Shopware 6") | One shop or marketplace account | | Created | On install | On install (a default one) and by the user afterwards | `validChannelTypes` on the backend restricts which channel types users may attach. Use `['ECOMMERCE']` for shops and `['MARKETPLACE']` for marketplaces (`POS` and `STORE` also exist). ```javascript await migratorErp.setMigration('salesChannelBackend', async (methods) => { let backend = await methods.findSalesChannelBackend(); if (backend) { backend = await methods.getSalesChannelBackend(backend.id); await methods.activateSalesChannelBackend(backend); } else { backend = await methods.createSalesChannelBackend('My Shop', ['ECOMMERCE']); } const channels = await methods.getSalesChannels(); if (channels?.length) { return null; } // never create a second default channel const channel = await methods.createSalesChannel(backend, 'My Shop', '', 'ECOMMERCE'); return channel.id; // stored as the migration note }); ``` Three details in that snippet matter: * **Reactivate on reinstall.** A deactivated backend disappears from the ERP's channel-creation dialog, so users can no longer create channels for your app. * **`findSalesChannelBackend()` returns only an id.** Re-read the full record before patching it. * **Guard against a second default channel**, or every reinstall adds one. Only the first sales channel is license-free. Creating another without a license produces a `402`, which the framework **swallows** — logging a warning and returning an empty object. Your migration continues, so code that expects `channel.id` must tolerate its absence. ## Serving many channels from one app Everything channel-specific is keyed by the channel id: | Concern | How it is scoped | | -------------- | ------------------------------------------------------------- | | Requests | The `X-Sales-Channel` header, pinned into the request context | | Configuration | Per-channel parameters stored in your app | | Credentials | Per channel — one tenant may connect several stores | | Webhooks | Channel-scoped events, and the channel id in the callback URL | | Scheduled work | One cron task per channel | Register handlers for `sales_channel.create` and `sales_channel.delete`, and provision everything above in the create handler. That is what makes a second store work without a reinstall. {% hint style="warning" %} **Cache API clients per channel, never globally.** A single-flight or cache key that ignores the channel lets a request for store B reuse store A's pending client — with A's credentials. That means writing one customer's data into another customer's shop. {% endhint %} ## Migration order The order of steps inside your migration is the order they run, and two orderings bite: {% stepper %} {% step %} ### Register webhooks after the channel exists Channel-scoped callback URLs carry the channel id, which you read from the previous step's result. Register first and you get subscriptions pointing at `?salesChannel=null` — permanently, because the wrong URL is part of a subscription's identity. Every existing shop app carries a cleanup migration for exactly this. {% endstep %} {% step %} ### Create import presets before the channel is created The `sales_channel.create` handler looks them up. {% endstep %} {% endstepper %} Also: create an EAV group in one step and write to it in a **separate** step, so a retry of the write doesn't try to recreate the group. ## Listings Each article can have one **listing** per sales channel, holding the channel-specific data — above all the external platform id. Query listings through the `article.shopListing` view, filtered by your channel: ```sql SELECT --v:result{displayname='listingId'} listings.id, --v:result{displayname='articleId'} id, --v:result{displayname='externalId'} listings.custom.myShop.id FROM article.shopListing WHERE id = '' AND listings.salesChannel.id = '' ``` {% hint style="warning" %} **The view is article-rooted: it returns a row even when your channel has no listing** — with a null listing id. Never treat "a row came back" as "a listing exists". Check the projected listing id itself, or you will follow up with a lookup by `null`. {% endhint %} Listing state is a handshake between the ERP and your app: | Set by the ERP | Set by your app | | ----------------------------------------------- | ---------------------------------------------------------------------------- | | `DISABLED`, `NEED_SYNCHRONIZE`, `NEED_DELETION` | `QUEUED_FOR_SYNCHRONIZE`, `QUEUED_FOR_DELETION`, `SYNCHRONIZED`, `ERRONEOUS` | Move a listing to `QUEUED_FOR_SYNCHRONIZE` when you enqueue it, and to `SYNCHRONIZED` or `ERRONEOUS` when the sync finishes. **Await that final write** — if it fails silently, the queue entry is marked complete while the listing stays stuck and gets re-enqueued forever. Skip listings that are `DISABLED`. Otherwise a channel-creation backfill enqueues the entire catalogue. ## Storing external ids Use [custom fields](https://developer.vario-software.de/documentation/fundamentals/custom-fields). Two groups are conventional: * a group named after your app with a single `id` attribute, attached to the entities you need; * a group named `_article_listing` on `article_listing` for richer per-listing data. Attach the group only to the entities that actually need it. A group shared across accounts, documents, listings, media and variants means an id written for one entity type leaks onto all the others — a real problem that had to be undone later with a migration. Also note that removing data from a group removes it across **every** entity the group is attached to. When you write an external id back to a listing, set `x-vario-suppress-own-webhooks` — otherwise your write re-triggers the article event you subscribe to, and you loop. See the [FAQ](/documentation/webhooks/faq). ## Outbound: the queue Webhooks fire far more often than a platform API should be called, so outbound work goes through a queue in your app: ``` ERP webhook ──► queue entry (QUEUED) ──► cron ──► fetch via VQL ──► transform ──► push ``` Entries move `QUEUED → PROCESSING → COMPLETED`, or to `FAILED`. Points worth knowing: * **Check the transfer toggle when inserting**, not when processing. Then the queue only ever holds work the user has enabled. * **Deduplicate against both `QUEUED` and `PROCESSING`.** Checking only `QUEUED` lets a webhook that arrives while the worker is busy create a duplicate. * **Dedup is check-then-act**, so it races. Add an in-process guard per entity — and be aware it does not span processes, so a multi-instance deployment still needs a shared guard. * **A `FAILED` entry is not retried automatically.** The drain only picks up `QUEUED`. Offer a retry action. * **Mask errors before persisting them.** The stored request extract is shown in the UI and can contain credentials or customer data. If the platform applies a whole batch in one transaction, a single bad item rolls back the rest — put the successful entries back to `QUEUED` rather than marking them complete. ## Inbound: order import Orders come in through the ERP's **multi-part import**: ``` cron ──► fetch from platform ──► transform ──► stream into a multi-part import ──► validate or run ``` The flow is: copy your import preset, stream the data up as a DMS file, create the import runs, wait until the data is extracted, then validate or execute. Presets are created during your migration and define the field mapping per file. **Deduplicate inside the import script** by looking for an existing document carrying the platform's order id. That single guard is what makes the whole pipeline safe to re-run — and it is why you should keep other identifiers in their own attributes rather than reusing the order-id field. Because of that guard, an overlap is cheap and a gap is not: * Advance your "imported up to" watermark **only after a successful import** — never in validation-only mode. * **Query a little further back than the watermark.** Platform feeds are eventually consistent, and an order can surface after your cursor has moved past it. Re-seen orders are dropped by the dedup guard. ## What else to watch out for **Tax mapping is by name, and names are fragile.** Mapping an ERP tax type to a platform tax class by name breaks as soon as the platform name contains a space or a `%` — the value cannot be safely interpolated and is dropped, silently losing the price. Validate names, and prefer ids where the platform offers them. **Platform limits are low.** Shopware caps every search at 500 results; Amazon's SP-API is aggressively rate limited and reports its own limits in response headers. Chunk id lists and paginate. **Some pagination is state-driven.** If your fetch filters on a status you then change, the result set shrinks by itself and you must *not* pass a page number — but in validation-only mode nothing changes, so you must not paginate at all or you loop forever on page one. **A stored external reference is not proof the remote object exists.** With transactional platform APIs, a rolled-back sync can leave you holding a reference to something that was never created. Verify before pointing new objects at it. **Uninstall leaves almost everything in place** — webhooks, cron tasks and the backend all survive. Reinstall therefore has to be idempotent and must reactivate the backend. # Shipping / Carrier Connect a carrier: carrier types, label creation, tracking and write-back. A shipping app connects a carrier — DHL, GLS, DPD, UPS, Deutsche Post Internetmarke — to the ERP. It turns a shipment into a **label** and a **tracking number**. {% hint style="info" %} Read [App Backends](/documentation/apps/app-backends) first; this page only covers what is specific to shipping. {% endhint %} ## The three levels Getting these apart is the single most important thing: | Level | German | Who creates it | | ------------------- | ------------ | ----------------------------------------------- | | **Carrier type** | Versendertyp | **Your app**, on install — this is your backend | | **Carrier** | Versender | The **customer**, in ERP settings | | **Shipping method** | Versandart | The **customer**, assigned to a carrier | Your app registers the carrier *type* and nothing else. The customer then creates carriers that use your type, and shipping methods on those carriers. Your app only ever **activates or deactivates** them — never creates or deletes them. ## Registering the carrier type There is no framework helper for this — it's a plain API call in your migration. Check first whether it already exists, then create it: ```javascript await app.erp.fetch(`/community/${app.version}/vds/carrier-type`, { method: 'POST', body: JSON.stringify({ label: 'DHL App', description: 'DHL Anbindung', appId: app.client.appIdentifier, active: true, backendType: 'APP', canPrintLabel: true, createShipmentSyncUrl: `${baseUrl}/api/shipment/create`, createLabelSyncUrl: `${baseUrl}/api/label/create`, trackingUrlTemplate: 'https://www.dhl.de/de/privatkunden/dhl-sendungsverfolgung.html?piececode=TRACKING_NUMBER', }), }); ``` The two `…SyncUrl` fields are the important part: **the ERP calls these URLs synchronously.** Your app is not polling — it is being called. {% hint style="info" %} Register **two** carrier types: production and one whose label ends in `(Sandbox)`. That is how the apps model sandbox mode, and how they detect it at runtime. {% endhint %} {% hint style="warning" %} The URLs are built from your app's domain at install time. If the domain changes, they are stale and the ERP calls the wrong host. Every existing shipping app ships a later migration that rewrites `createShipmentSyncUrl` and `createLabelSyncUrl` for that reason — plan for it. {% endhint %} ## The two-phase flow ### Phase 1 — shipment created → `createShipmentSyncUrl` The ERP posts the shipment. Note that the `shipment` property arrives as a **JSON string**, not an object: ```javascript const shipment = JSON.parse(body.shipment); ``` Your job here is *not* to talk to the carrier. It is to resolve the configuration and **stamp it onto the shipment and every parcel**: ```javascript const settings = await getDeliveryMethodSettings({ carrierId: data.carrier.id, deliveryMethodId: data.deliveryMethodId, }); data.shipmentParameter = settings; data.parcels.forEach(parcel => { parcel.packageParameter = settings; }); ``` Then `PUT /vds/shipment/{id}` to persist it. This snapshot is deliberate: the label phase reads settings **from the parcel**, not from current configuration. A label reprinted next month must use the settings that were active when the shipment was created. ### Phase 2 — label requested → `createLabelSyncUrl` Skip parcels that are already `COMPLETED`, then per parcel: {% stepper %} {% step %} ## Read configuration Read config from `parcel.packageParameter` — never reload it. {% endstep %} {% step %} ## Build the carrier request Map addresses and build the carrier request. {% endstep %} {% step %} ## Call the carrier API Call the carrier API. {% endstep %} {% step %} ## Upload the label Upload the label to the **DMS**. {% endstep %} {% step %} ## Write the result back Write the result back to the parcel. {% endstep %} {% endstepper %} ```javascript parcel.parcelState = 'COMPLETED'; parcel.trackingNumber = response.shipmentNo; parcel.carrierResponse = /* small summary only — see below */; parcel.validationErrors = mapValidationMessages(response.validationMessages ?? []); await app.erp.fetch(`/vds/shipment/${shipment.id}/parcels/${parcel.id}`, { method: 'PUT', body: parcel, }); ``` `parcelState` is one of `OPEN`, `REQUESTED`, `COMPLETED`, `ERROR`, `MANUAL`, `CANCELLED`. ## Where things are stored | Thing | Location | | --------------------------- | ------------------------------------------------------------------------------------------------------------ | | Tracking number | `parcel.trackingNumber` | | Label file | **DMS resource**, attributed `refType: 'PARCEL'`, `refId: ` | | Carrier reply summary | `parcel.carrierResponse` | | Carrier validation messages | `parcel.validationErrors` | | Tracking events | `parcel.trackingDetails[]`, normalised to `CREATED`, `PICKUP`, `TRANSIT`, `DELIVERED`, `RETURN`, `EXCEPTION` | The label is never stored on the parcel — it goes to the DMS and is linked by attribution. Customs documents are uploaded the same way. {% hint style="warning" %} `**carrierResponse**`\*\* is capped at 255 characters.\*\* Do not put the raw carrier response in it — the label, customs documents and validation messages have their own homes. Store a small summary (tracking number, document id) and truncate defensively. {% endhint %} ## Credentials The ERP carrier record holds **no credentials** — it has only a label, its type reference and free-form parameters. Store credentials in your app, keyed by `carrierId`, so one tenant can run several accounts of the same carrier. Sandbox and production credentials are separate. Since the sandbox flag round-trips as a string, coerce it explicitly: ```javascript this.sandbox = String(sandbox) === 'true'; ``` {% hint style="warning" %} `"false"` is a truthy string. A restored session with `sandbox: "false"` that is not coerced will send **production credentials to the sandbox endpoint** — or worse, the reverse. {% endhint %} ## Install and uninstall Because carriers and shipping methods belong to the customer, install is a two-step conversation: {% stepper %} {% step %} ## Activate carrier types Run migrations, then activate your carrier types (infrastructure — always safe). {% endstep %} {% step %} ## Let the user select what to activate Read back the carriers and shipping methods that use your types, and let the user pick which to activate. {% endstep %} {% endstepper %} Activate **carriers before shipping methods**, so a method is never briefly active without an active carrier. On uninstall, reverse it: shipping methods → carriers → carrier types. Deactivate only — deleting would destroy customer configuration and prevent selective reactivation. ## What to watch out for **Field lengths.** Carriers reject overlong fields rather than truncating them. DHL address fields are typically 35 characters, not the 50 the schema suggests — 50 applies to dangerous goods only. Truncate deliberately, and make it switchable per carrier. Never truncate an email address: a cut address fails format validation, so omit the field instead. **Country codes differ per carrier.** Some want ISO-2, some ISO-3. Do not derive one from the other by slicing — `AUT` sliced to two characters is `AU`, which is Australia. Map explicitly. **Weight and dimension units.** Read the unit from the parcel instead of assuming. Carriers expect wildly different units — kilograms, pounds, even 10-gram increments. Zero weight usually needs a minimum substituted. **Customs is product-dependent.** Only certain international products accept customs data. An incomplete customs configuration can silently produce a label with no customs information at all — validate before sending. **Fail onto the parcel, not the request.** A carrier error is normal operation, not a server error. Set `parcelState = 'ERROR'` with `validationErrors` so the user sees what went wrong on the shipment, and keep the endpoint's response successful. **Cancellation varies.** Some carriers offer a real void/cancel API; others have none, in which case you can only delete the label document and reset the parcel state. **Tracking URL placeholders.** `trackingUrlTemplate` uses `TRACKING_NUMBER`, and some carriers additionally need `POSTAL_CODE`. If a placeholder in the template has no value at runtime, the ERP shows **no tracking link at all** rather than a broken one. # Banking Deliver account transactions into the ERP and send payments out. A banking app delivers **account transactions** into the ERP and optionally sends **payments** out. PayPal and file-based banking (CAMT/PAIN) are the reference implementations. {% hint style="info" %} Read [App Backends](/documentation/apps/app-backends) first; this page only covers what is specific to banking. {% endhint %} ## Registering the bank backend ```javascript const bankBackend = await methods.createBankBackend('PayPal', 'APP'); await methods.changeBankBackend(bankBackend.id, { ...bankBackend, description: 'Manages PayPal transactions, refunds and open-item matching.', }); ``` Two calls, because `createBankBackend` has no description parameter. `changeBankBackend` is a **full PUT** — spread the created object so `label` and `version` survive. {% hint style="info" %} `backendType` is `APP` for apps. Other values exist for built-in providers. {% endhint %} ### You register a backend — the customer creates the bank This is the key decision when you start: > Registering the backend makes your app **selectable** in the ERP's "create bank" dialog. The customer then creates their own bank — with the correct name, IBAN and BIC — and picks your backend. Do **not** create banks on install. The customer owns that master data. The one exception is a provider where the "bank" is the provider itself and there is nothing for the customer to name — the PayPal app creates a single `PayPal` bank, one **account per connected merchant**. ### Letting the ERP call you The bank backend record carries three URL fields. Set them if the ERP should drive the interaction: | Field | Purpose | | ------------------- | ------------------------------ | | `appTransactionUrl` | Fetch transactions | | `appPaymentUrl` | Send a payment or direct debit | | `appStatusUrl` | Poll the status of a payment | If your app pulls on a schedule instead, you don't need them — use a [cron webhook](https://developer.vario-software.de/documentation/webhooks/introduction). ## Delivering transactions One POST per transaction. There is no bulk endpoint: ```javascript await app.erp.fetch('/erp/bank/transactions', { method: 'POST', body: transaction, }); ``` The fields that matter: | Field | Notes | | ------------------------------------------ | ----------------------------------------------------------- | | `accountId` | The ERP bank account this belongs to | | `bookingDate`, `valueDate` | Date-time | | `amount` | **Always positive** — the sign lives in `direction` | | `direction` | `INCOMING` or `OUTGOING` | | `currency` | ISO code | | `endToEndId` | Your stable identifier — this is what deduplication keys on | | `purpose`, `name`, `iban`, `accountNumber` | Counterparty and reference data | `matchingState` and `isPotentialDuplicate` are set by the ERP — don't try to write them. Balances are updated separately, and the value goes in the **query string**: ``` PUT /erp/bank/accounts/{id}/balance?balance=1234.56 ``` ## Matching against open items You do not implement matching. Hand it to the ERP after importing: ```javascript await app.erp.fetch('/erp/finance/openitemsynchronization', { method: 'POST', body: { bankId, bankAccountId }, }); ``` Call it once per account **after** a batch, not per transaction. Only call it when something was actually imported. ## Sending payments Outbound is the mirror image: read payments the ERP has prepared, send them, then report back. * Only payments with status `CREATED` or `PREPARED` are pending. * Credit transfers are `MONEY_TRANSFER` / `REALTIME_MONEY_TRANSFER`; direct debits are `SEPA_CORE_DIRECT_DEBIT` / `SEPA_B2B_DIRECT_DEBIT`. * Confirm with `POST /erp/bank/payments/{id}/update_status/SENT` — and only after the bank or provider has actually accepted it. {% hint style="warning" %} **Archive before you mark as sent.** If you write the file to the DMS *after* transitioning payments to `SENT`, a failed upload leaves payments marked as sent with no record of what the bank received. Upload first, then transition. {% endhint %} ## What to watch out for **Deduplication is your responsibility.** The ERP flags potential duplicates but does not reject them. Key on `endToEndId`. Two traps: * If you only check for existing ids **within the date window you just queried**, a transaction whose booking date falls outside that window will be imported again. Overlapping sync windows make this likely. * Transactions **without** an `endToEndId` can never be deduplicated. Derive a stable identifier for them or accept duplicates. For file-based imports, layer the checks: hash of the whole file, then statement identity, then per-entry id. A file that failed to import must still be retryable — treat an import as "already done" only if it actually created rows. **Provider data lags.** Reporting APIs often do not have the last few hours. Ending a sync window at "now" returns empty results or an error. End it deliberately in the past and track how far you have synced. **Windows have maximum lengths.** Many providers cap a query at around a month. Split a long back-fill into chunks rather than requesting the whole range. **Watch the sync cursor.** If a manual sync with an explicit date range writes the same "synced to" value the scheduled job reads, a user investigating an old transaction can move the cursor backwards or forwards and skip days. Keep the cursor separate from ad-hoc queries. **Dates as strings.** If you compare dates lexicographically, never mix date-only (`2026-01-15`) and date-time (`2026-01-15T10:30:00Z`) values in the same field — the comparison silently breaks. **Amounts.** Send the absolute value and set `direction`. Losing the direction flag silently inverts a booking. Keep two decimals and be careful with floating-point sums over large batches. **SEPA is EUR-only** and its character set is restricted — transliterate umlauts and accents, and strip anything outside the permitted set before generating a file, or the bank rejects it. The SEPA creditor identifier (Gläubiger-ID) lives on the ERP **bank** record, not in your app configuration. **Credentials per connected account.** A tenant may connect several merchants or accounts to one backend. Key credentials by account so they don't overwrite each other, and never log them. # Financial Accounting Export bookings and debtor/creditor master data to an accounting system. A financial accounting app exports the ERP's **bookings** and **debtor/creditor master data** to an accounting system. DATEV is the reference implementation. {% hint style="info" %} Read [App Backends](/documentation/apps/app-backends) first; this page only covers what is specific to accounting. {% endhint %} ## Registering the finance backend ```javascript await methods.createFinanceBackend('DATEV'); ``` Registering it makes your app appear as an export target in the ERP's finance export. {% hint style="info" %} `createFinanceBackend` takes **only a label**. Passing a description as a second argument does nothing — it is silently ignored. Set the description afterwards with `changeFinanceBackend(label, description)`. {% endhint %} {% hint style="info" %} Note that `changeFinanceBackend` looks the backend up by your **app identifier**, not by the label — the label argument only appears in its log message. It returns `null` instead of throwing when nothing is found. {% endhint %} ## The export is two-phase Do not collapse these. The ERP model separates producing the files from transmitting them: ``` 1. Build ERP data ──► formatted files ──► DMS 2. Transmit DMS files ──► accounting system ──► job status ``` Phase 1 is triggered by the user, reads the booking run, and writes finished files into the DMS. Phase 2 picks those files up and uploads them. Keeping them apart means a transmission can be retried without regenerating, and the exported files stay auditable. Both phases are long-running. The reference app answers the HTTP request **immediately** and continues in the background, writing progress into a status record the UI polls. {% hint style="warning" %} If you do that, remember a `200` then means *"accepted"*, not *"finished"*. Clients that treat it as completion will read stale files. Give them a status endpoint. {% endhint %} ## Reading the data Bookings come from computed queries — the booking run, its bookings, and the individual records: ``` POST /cmn/computed-queries/finance-export/bookings (filtered by bookingRun.id) POST /cmn/computed-queries/finance-export/records (filtered by booking.bookingRun.id) ``` Within a booking, the **first record is the header** and the remaining records are the lines. A booking with only one record therefore produces no output. The accounts come straight from the data — there is no mapping table in the app: | Export field | Source | | ----------------------------- | --------------------------------- | | Account (`Konto`) | the **header** record's ledger | | Contra account (`Gegenkonto`) | the **line** record's ledger | | Tax key (`BU-Schlüssel`) | the line record's transaction key | Skip lines whose amount is zero or whose booking state is not `OK`. {% hint style="warning" %} **Always sort a paged query by a unique column.** Offset paging over an unsorted result set is undefined: pages overlap, some rows arrive twice and others never arrive at all — differently on every run. The backend adds no default order. Sort by `id`, and deduplicate afterwards as a safety net. {% endhint %} ## Format details are unforgiving Accounting formats are validated strictly on import. The things that actually break exports: **Encoding.** Write UTF-8 **with a byte-order mark**. Strip it again when reading your own files back. **Numbers.** German decimal comma, exactly two decimals, no thousands separator, and the **absolute value** — the sign is carried by the debit/credit indicator. If that indicator is lost, the booking silently inverts. **Dates are partial.** In the DATEV booking format the document date is only day and month; the year comes from the file header. That is precisely why the export must be split per business year — a booking outside the header's year would be filed under the wrong one. Walk backwards and forwards from the main business year and write additional files as needed. **Field widths and quoting.** Fields have maximum lengths and per-field quoting rules. Truncation is silent, and an embedded quote character is usually removed rather than escaped — so validate values before writing rather than trusting the writer. **Timezones.** Date formatters typically use local time while a date-only configuration value parses as UTC midnight. On a server west of UTC that shifts the business year by a day. Normalise before comparing. ## Configuration An accounting integration needs client identification — for DATEV the consultant number and client number, which combine into the client id used on every API call. Along with the business-year start and the ledger account length, these are **required before an export can run**: gate the export button on them rather than failing mid-run. Store them where both your export code and your API layer can read them, and remember that values round-trip as strings. ## What to watch out for **Make re-exports distinguishable.** A regenerated file must not silently overwrite the previous one — add a suffix. Auditors need to see what was sent and when. **Deduplicate transmissions.** Track which files and documents already succeeded and skip them on a re-run, or you create duplicate jobs in the accounting system. Treat the accounting system's own "duplicate" response as success, not as an error. **Guard against concurrent runs**, with a staleness timeout so a crashed run doesn't block the export forever. **Respect rate limits and retry properly.** Honour `Retry-After` on `429`/`503`, then back off exponentially with a cap. Distinguish fatal errors (missing rights, expired authorisation) — which should abort the whole run — from per-document failures, which should be logged and skipped. **Check the export rights explicitly.** An authorised session is not the same as an authorised *service*. Verify the required services are enabled for the client and surface a clear message; otherwise a missing entitlement looks like a generic authorisation failure. **Attachments have size limits.** Document upload limits are enforced on both sides — check the size before uploading and report oversized documents as warnings rather than aborting the run. **Long-lived authorisation expires.** Refresh tokens for accounting APIs can last months or years, but they do expire; handle the expiry as a normal state with a re-authorisation prompt. # POS Payment Methods Provide a payment method the cash register can use, fulfilled by your app. A POS payment method is what the cashier presses at the register. Most are handled by the ERP itself — cash goes straight into the till. But a payment method can also be **handed to an app**: the ERP places a payment *order*, something external fulfils it, and the receipt only closes once the result comes back. That "something external" is a **payment consumer**. The VARIO local-link is one — it drives card terminals in the shop. An app can be another. {% hint style="info" %} Read [App Backends](/documentation/apps/app-backends) first. {% endhint %} This page describes the platform mechanism. The reference implementation of a consumer today is the **local-link** (card terminals over the local network). If you are building an app-side consumer, expect to work directly against the REST resources described here. ## The five pieces | Entity | What it is | | -------------------- | ------------------------------------------------------------------------------------ | | **Payment backend** | Who is responsible: `SELF` (the ERP) or `APP` (you) | | **Payment method** | The button on the register — `CASH` or `CARD`, pointing at a backend | | **Payment consumer** | The worker that fulfils orders, with a heartbeat | | **Payment rule** | Routes an order to a consumer, based on method, operation, register or sales channel | | **Payment order** | One unit of work, identified by an `externalPaymentId` | ## Registering the backend There is no framework migration helper here — create the backend through the API, with the same identifying fields as every other app backend: ```json { "label": "My Terminal App", "type": "APP", "appId": "", "placePayment": true, "canCancel": true, "canRefund": true } ``` `placePayment` is the switch that matters. It is only meaningful for `type: "APP"`: > With `SELF`, the payment is booked directly in the register. With `APP` and `placePayment`, an order is **placed** for an external consumer to fulfil. `canCancel` and `canRefund` advertise what you support. They are not cosmetic — see the warnings below. ## The runtime flow ``` cashier presses method │ ▼ POS adds a document line ──► ERP creates a PosPaymentOrder (externalPaymentId) │ ▼ rule routes it to a consumer │ consumer picks it up (push, or request-next) │ consumer performs the payment │ ▼ PUT …/orders/{externalPaymentId}/status?status=SUCCESSFUL │ ▼ POS is polling the order ──► receipt closes ``` Note what triggers this: **the POS adds a document line**, not a call to a payment API. The order is a side effect. If no order appears, the POS simply continues — that is the `SELF` path. ### Picking up work Either be pushed to (the local-link subscribes over a WebSocket) or ask for the next order: ``` POST /community/{version}/erp/pos/payment/consumer/{id}/request-next ``` No request body, and it returns at most one order. Send a heartbeat so the ERP can show whether you are alive: ``` PUT /community/{version}/erp/pos/payment/consumer/{id}/heart-beat ``` Process **one order at a time**. A terminal that is already busy rejects a second request, and parallel chains send payments to an occupied device. ### Reporting the result **That is the entire write-back surface — `status` and `errorMessage`, as query parameters.** There is no field for an authorisation code, card reference, receipt number or the actual amount. If you need any of that later (for example a terminal reference required to reverse the payment), you must store it yourself, keyed by `externalPaymentId`. The local-link keeps its own store for exactly this reason. ``` PUT /community/{version}/erp/pos/payment/orders/{externalPaymentId}/status ?status=SUCCESSFUL|CANCELLED|REJECTED|PROCESSING|PENDING &errorMessage= ``` The ERP updates the receipt itself once the status is `SUCCESSFUL`; the POS reloads the document afterwards. ### Operations | `paymentOperation` | Meaning | Extra | | ------------------ | -------------------------------------------------- | ----------------------------------- | | `PAYMENT` | Normal payment | — | | `CANCEL` | Reverse a specific earlier payment | `cancelledExternalPaymentId` is set | | `REFUND` | Pay money back with no original payment to reverse | — | `CANCEL` needs the original transaction, so you must be able to find your own record of it. `REFUND` stands alone. ## What to watch out for {% hint style="warning" %} **Never report a payment as failed because reporting failed.** If the card was charged and the status call then errors, retrying the *report* is correct — retrying the *payment* is not, and reporting `REJECTED` tells the register the customer did not pay. That is how double charges happen. Retry the status call, treat `4xx` as final, and log loudly if you have to give up: the customer has been charged and the order will sit unresolved. {% endhint %} {% hint style="warning" %} **An order can be cancelled while you are working on it.** The cashier can give up and set it to `CANCELLED`. If the terminal then completes anyway, you have a charged payment against a cancelled order — detect it, don't overwrite the status, and flag it for manual reconciliation. Watch the order while you process it so you can abort at the device. {% endhint %} {% hint style="warning" %} **Aborting is a request, not a command.** Once a terminal reaches the point of no return it may ignore the abort and complete normally. Handle the late success. {% endhint %} {% hint style="info" %} **Your `errorMessage` is shown to the cashier verbatim.** Write messages a shop assistant can act on, and remember it travels as a URL query parameter. {% endhint %} {% hint style="warning" %} **Timeouts don't line up.** The POS gives up waiting for pickup after about 20 seconds and abandons the payment after about three minutes. A consumer that only polls every 30 seconds will trigger the "payment system not responding" dialog even when it is perfectly healthy. Subscribe to pushes, or poll faster than the pickup timeout. {% endhint %} {% hint style="warning" %} **Capabilities have configuration consequences.** A backend with neither `canCancel` nor `canRefund` can **block the register from being activated** at all, because cancelling a receipt then becomes impossible — and it prevents splitting a receipt across several card payments. Declare honestly, but understand the cost. {% endhint %} {% hint style="warning" %} **A rule is required.** A `placePayment` backend with no matching payment rule fails **at payment time**, not at configuration time — the cashier sees "no payment consumer could be determined". Ship setup instructions, or check for a rule during install. {% endhint %} {% hint style="warning" %} **There is no idempotency key.** `externalPaymentId` is the only anchor you get, on both the pickup and the status call. Guard against processing the same order twice yourself. {% endhint %} {% hint style="info" %} **Partial payments are normal.** Each split is a separate line and a separate order. The receipt closes when it balances, so expect several cycles per sale. {% endhint %} {% hint style="warning" %} **Fiscal rules interrupt you.** Adding a payment line can come back asking for a decision (signature-device handling under German cash-register law). If you drive the POS side, handle that instead of treating it as a failure — otherwise cancellations with partial payments fail silently. {% endhint %} {% hint style="info" %} **Cash-journal behaviour is set on the method, not the backend.** Whether a method is counted and carried in the cash book, and how it is skimmed at closing, is configured on the payment method regardless of who fulfils it. {% endhint %} # FAQ Frequently asked questions about App authentication, installation, migrations, manifests and UI integrations. ## App authentication ### Where does my App get its credentials for a tenant? VARIO Cloud hands your App an **offlineToken** in the body of the install call. Persist it, keyed by tenant, before doing anything else. Your App exchanges it for short-lived access tokens from then on. It is **not** a one-time-only event, though: the customer can renew it at any time. In the Admin-Center, on the installed App's page, **"Offline-Token erneuern"** issues a fresh offlineToken and calls your **install endpoint again** with it. {% hint style="warning" %} So your install endpoint must be safe to call more than once, and must **overwrite** the stored token rather than keeping the first one. Migrations already behave that way — a step that has run is skipped — but the token write must not be conditional on "no token stored yet". {% endhint %} → [App Authentication](/documentation/apps/authentication) ### My App suddenly gets 401 from the API for one tenant. Why? Most likely the tenant's offlineToken has **expired through inactivity**. The token is valid for **45 days**, and every use extends it by another 45. So it never expires while the App is working — but **45 consecutive days with no API call for that tenant** invalidate it. Typical victims: seasonal integrations, test tenants, and Apps that only act when a customer triggers something. Once it has expired, the App instance is flagged accordingly and the customer is prompted in the Admin-Center to use **"Offline-Token erneuern"**, which sends your install endpoint a fresh token. That is a customer action — your App cannot trigger it. Two things you can do: * **Prevent it**: if your App can be idle for weeks, make a small scheduled call so the token stays alive. * **Diagnose it**: fail clearly and log which tenant is affected, so this looks like an expired token rather than a generic outage. ### VARIO calls my App and my App answers 401. What's wrong? Your App is rejecting the inbound token. It must be verified as: * an **ES256**-signed JWT, * against the **JWK set** you received when creating the App, * with `aud` equal to your `appIdentifier`, * and a valid `exp`. ## Installation and migrations ### I changed my migration and nothing happened. Migrations run **once, ever**. Each step is recorded by name, and an already-recorded step is skipped — editing its body has no effect on tenants where it already ran. Add a **new step with a new name** instead. For steps that must run every time (webhook registration is the classic case), use `always()` rather than `setMigration()`. ### My install reported success but nothing was created. Migration errors are **caught, not thrown**: they go to your error handler and the app log, and the install still reports success. Read the app log. Failed steps are not recorded as completed, so they retry on the next install. ### `createSalesChannel` returned an empty object. That is the platform telling you a **license is missing**. Only the first sales channel is license-free; creating more requires a sales channel license. The framework catches the resulting `402`, logs a warning and returns `{}` so the migration continues — which means your code must tolerate a missing `id`. ### I get a 404 reading an EAV group that I create in the same migration. Ordering. An EAV group must be created by an **earlier** step before it can be read or changed. The same applies to anything else you look up by identity — a bank cannot reference a backend that doesn't exist yet. ## Manifest, permissions and UI ### What is the complete list of `pointOfIntegration` values? There intentionally isn't one in this documentation — integration points are added with every release, so any list published here would be wrong within a version or two. Read them out of your own installation instead: 1. Open the ERP in [support mode](https://help.vario-software.de/support/melden-von-problemen-in-vario-cloud/support-modus). 2. Enable the toggle **"App-Integrationspunkte anzeigen"** ("Show app integration points"). 3. Reload when prompted. Every available integration point is now labelled in the UI with the exact `pointOfIntegration` string to put in your manifest. Navigate to the screen you want to extend and read it off there. → [App Manifest](/documentation/apps/app-manifest) ### My UI integration doesn't show up. There is **no manifest validation**, and integration points are matched by exact string comparison — so a typo means your integration silently never appears. Check: * the spelling of `pointOfIntegration`; * that you kept the literal `{APP_IDENTIFIER}` placeholder where the point requires it; * that the user has the verb named in `permissionKey`. Integration points are added with every release, so don't work from a list. Open the ERP in [support mode](https://help.vario-software.de/support/melden-von-problemen-in-vario-cloud/support-modus), enable **"App-Integrationspunkte anzeigen"** and reload — the ERP then labels every available integration point with the exact `pointOfIntegration` string to use. → [App Manifest](/documentation/apps/app-manifest) # Introduction Concepts that apply to every integration: tenants, VQL, custom fields, webhooks and app backends. Universal concepts and core mechanisms that apply across the entire VARIO Cloud ecosystem — regardless of whether you are building a shop integration, a logistics connector, another type of app, or working directly with the API. These guides cover the foundational building blocks every developer should understand. They are equally relevant for full app developers and for API-only users, as the underlying concepts, data structures, and system behavior remain the same across all integration approaches. ## In this section | Page | What it covers | | ---------------------------------------------------------- | ----------------------------------------------------------------------------------- | | [Custom Fields](/documentation/fundamentals/custom-fields) | Attaching your own fields to ERP entities — articles, accounts, documents, and more | | [VQL](/documentation/fundamentals/vql) | The query language used to read and filter data across the whole ERP | ## Concepts you will meet everywhere ### Tenants Every VARIO Cloud installation is a **tenant**, reachable at its own subdomain. Your API base URL is derived from it (`https://{subdomain}.vario.cloud/api/vario`), and all data is scoped to that tenant. An integration that serves several customers talks to several tenants, each with its own credentials. → [REST API Introduction](/documentation/rest-api/introduction) explains how to build the base URL. ### Reading data: VQL Most read access goes through **VQL** (VARIO Query Language), a SQL-like language that works across every entity — articles, accounts, documents, CRM activities. Instead of one endpoint per query, you send a statement and get rows back. VQL also handles filtering, sorting, and pagination. → [VQL](/documentation/fundamentals/vql) ### Extending the data model: Custom Fields You cannot add columns to ERP tables, but you can attach **Custom Fields** to entities. They are the standard way for an integration to store its own data — external reference IDs, sync state, mapping information — directly on ERP records, and they are queryable from VQL. → [Custom Fields](/documentation/fundamentals/custom-fields) ### Reacting to change: Webhooks Rather than polling, register a **webhook** and let the ERP notify your integration when data changes. Webhooks are also how scheduled work is triggered for apps. → [Webhooks](/documentation/webhooks/introduction) ### Domain backends For some domains, an app does not just read and write data — it takes over a **role** in the ERP. It registers a typed *backend* during installation, and the ERP then routes work in that domain to the app: | Domain | What the app registers | | ----------------------------- | ----------------------------------- | | Online shops and marketplaces | A sales channel backend | | Shipping | A **carrier type** (`Versendertyp`) | | Banking | A bank backend | | Financial accounting | A finance backend | | POS payment methods | A POS payment backend | Each of these is tagged with the app's identifier and marked as app-provided, so the ERP knows which app is responsible. {% hint style="info" %} Note the naming: for shipping there is no "carrier backend". The **carrier type** plays that role — it carries the app identifier and the callback URLs, while the actual carriers (`Versender`) are master data the customer creates on top of it. {% endhint %} → [Core Concepts](https://developer.vario-software.de/core-concepts) covers each domain on a single page. ### Running logic inside the ERP Not every extension needs an external service. **Scripting** runs server-side JavaScript directly in the ERP — for validation, enrichment, and automation with no network latency and no deployment pipeline. → [Scripting](/documentation/scripting/introduction) # Custom Fields Attach your own fields to ERP entities and query them. Custom Fields are the primary way for apps to extend the VARIO Cloud ERP data model. They let you attach your own fields to any ERP entity — articles, accounts, documents, CRM activities, and more. This is central to most integrations: storing external reference IDs, tracking synchronization state, mapping data between systems, or adding any app-specific information directly on ERP records. Once registered, Custom Fields appear automatically in the ERP UI under the "Zusatzfelder" tab and are fully queryable via the API and VQL. {% hint style="info" %} In the API, Custom Fields are represented as **EAV Groups** (Entity-Attribute-Value) containing **Attributes**. {% endhint %} ```mermaid graph TD G["EAV Group «myapp»\nexternalId (TEXT)\nisActive (BOOLEAN)"] G -->|"custom.myapp."| A["Article"] G -->|"custom.myapp."| D["Document"] ``` Access pattern: `custom.{groupKey}.{attributeKey}` *** ### Definition Define an EAV group as a JSON file in `migrations/{n}/static/erp/eav-groups/`: ```json { "key": "myapp", "label": "My App", "description": "Custom fields for the integration", "attributes": [ { "key": "externalId", "label": "External ID", "description": "Reference ID in the external system", "position": 1, "type": "TEXT", "viewMode": "EDITABLE", "active": true, "fulltextField": true, "searchIndex": true } ], "uiSettings": {}, "entities": ["document"] } ``` ### Group Properties | Field | Type | Description | | ------------- | -------- | ---------------------------------------------------------------- | | `key` | `string` | Unique identifier — determines the access path `custom.{key}.*` | | `label` | `string` | Display name in the ERP | | `description` | `string` | Description | | `attributes` | `array` | The fields in this group | | `uiSettings` | `object` | UI display configuration (optional) | | `entities` | `array` | Target entities, e.g. `["account"]` or `["account", "document"]` | ### Attribute Properties | Field | Type | Description | | --------------- | -------------- | ----------------------------------------------- | | `key` | `string` | Unique key within the group | | `label` | `string` | Display name | | `description` | `string` | Description | | `position` | `number` | Sort order | | `type` | `string` | Data type (see below) | | `viewMode` | `string` | `"EDITABLE"`, `"READ_ONLY"`, or `"NOT_VISIBLE"` | | `active` | `boolean` | Whether the field is active | | `fulltextField` | `boolean` | Include in fulltext search | | `searchIndex` | `boolean` | Create a search index | | `textGroupRef` | `string\|null` | Reference to a text enum group (for dropdowns) | ### Attribute Types | Type | Description | | ----------- | ------------- | | `TEXT` | Text | | `MEMO` | Long text | | `BOOLEAN` | Boolean | | `INTEGER` | Integer | | `DECIMAL` | Decimal | | `CURRENCY` | Currency | | `DATE` | Date | | `DATE_TIME` | Date and time | | `JSON` | JSON object | *** ## Migration The following section on Custom Field migration is only relevant for developers building VARIO apps. If you are working exclusively with the API, you may skip ahead to the next chapter. Custom Fields are registered during app installation via the migration system. ``` backend/services/maintenance/install/migrations/ 1/ index.js static/erp/eav-groups/myapp.json 2/ ← later update index.js ``` ### Creating Fields ```javascript const MigratorErp = require('@vario-software/vario-app-framework-backend/utils/migrator.js'); const eavGroup = require('./static/erp/eav-groups/myapp.json'); const handle = async function() { const migrator = new MigratorErp('migration1'); await migrator.setMigration('createEav', async (methods) => { await methods.createEavGroup(eavGroup); }); }; module.exports = handle; ``` ### Updating Fields Add a new migration folder (e.g. `migrations/2/`) and use `changeEavGroup`: ```javascript // migrations/2/index.js const MigratorErp = require('@vario-software/vario-app-framework-backend/utils/migrator.js'); const handle = async function() { const migrator = new MigratorErp('migration2'); await migrator.setMigration('addStatusField', async (methods) => { await methods.changeEavGroup('myapp', (group) => { group.attributes.push({ key: 'syncStatus', label: 'Sync Status', type: 'TEXT', viewMode: 'EDITABLE', active: true, searchIndex: false, }); return group; }); }); }; module.exports = handle; ``` ### Migration Methods | Method | Description | | ------------------------------------------------- | ---------------------------------------- | | `createEavGroup(json)` | Create a group | | `getEavGroup(groupKey)` | Read a group | | `changeEavGroup(groupKey, callback)` | Modify a group via callback | | `deleteEavGroup(groupKey)` | Delete a group including its data | | `removeDataFromEavGroup(groupKey, attributeKeys)` | Remove specific attributes or their data | *** ## API Access Custom Fields live under the `custom` namespace on every entity they are bound to: ```javascript // Read const { data } = await app.erp.fetch('/crm/activities/123', { useInternalApi: true, }); const value = data.custom.myapp.externalId; ``` ```javascript // Create await app.erp.fetch('/crm/activities', { method: 'POST', useInternalApi: true, body: { comment: 'Created via app', custom: { myapp: { externalId: 'EXT-456' } }, }, }); ``` ```javascript // Update await app.erp.fetch('/crm/activities/123', { method: 'PUT', useInternalApi: true, body: { custom: { myapp: { externalId: 'EXT-789' } }, }, }); ``` ### VQL ```javascript const { data } = await app.erp.vql({ statement: ` SELECT id, comment, custom.myapp.externalId FROM crm.activities WHERE custom.myapp.externalId NOT NULL LIMIT 50 `, }); ``` *** ## Permissions Required in `app-manifest.json`: ```json { "requirements": { "permissions": [ { "resource": "eav", "verb": "read" }, { "resource": "eav", "verb": "create" }, { "resource": "eav", "verb": "update" }, { "resource": "eav", "verb": "delete" } ] } } ``` # VQL The SQL-like query language for reading data across the whole ERP. VQL (VARIO Query Language) is a SQL-like language for querying data across the entire VARIO Cloud ERP. It is the essential way to select and read data in apps and via the API. VQL lets you filter, sort, and paginate any entity — articles, accounts, documents, CRM activities, and beyond — with a single statement. VQL is case-insensitive. All keywords — `SELECT`, `select`, `Select` — work identically. *** ## Statement Structure ```sql SELECT [DISTINCT] columns FROM group.template [JOIN (subquery) AS alias ON (condition)] [WHERE expression] [ORDER BY column [ASC|DESC], ...] [LIMIT n] [OFFSET n] ``` {% hint style="info" %} VQL supports `JOIN` but not `LEFT`, `RIGHT`, `INNER`, or `OUTER` variants. There is no `GROUP BY`, `HAVING`, or `UNION`. {% endhint %} \## Columns Select specific fields, use `*` for standard fields, or apply functions: ```sql SELECT id, name, documentDate FROM document.querySalesDocuments ``` ```sql SELECT * FROM account.query ``` ```sql SELECT count(id) FROM article.query ``` ### Column Aliases Use the `--v:result{}` annotation to control column behavior in the response: ```sql SELECT --v:result{visible=false} id, --v:result{displayname='name'} default_address.name1 FROM account.query ``` **Options:** | Option | Type | Description | | ------------- | --------- | ------------------------------------------------------------------------------------------------ | | `displayname` | `string` | Key name in the returned data objects. Without it, the raw attribute path is used. | | `visible` | `boolean` | Whether the column appears in UI renderings. Set to `false` to fetch data without displaying it. | | Function | Description | | -------------- | -------------- | | `COUNT(field)` | Count | | `SUM(field)` | Sum | | `AVG(field)` | Average | | `MIN(field)` | Minimum | | `MAX(field)` | Maximum | | `ABS(field)` | Absolute value | | `LIST(field)` | List values | Functions can be nested: `COUNT(SUM(field))`. ### Arithmetic (Available Soon) Full arithmetic is supported in `SELECT`, `WHERE`, and `ORDER BY`: ```sql select (quantity * unitPrice) from statistic.statisticSalesFact ``` Operators: `+`, `-`, `*`, `/` *** ## FROM Clause Every query targets a **group** and **template** in the format `group.template`: ```sql SELECT * FROM article.query ``` ```sql SELECT * FROM document.querySalesDocuments ``` ```sql SELECT * FROM account.query ``` The group identifies the entity domain, the template defines which view of that data you query. ### Don't guess field paths — ask the API The set of groups, templates and field paths depends on your installation and changes between versions. Rather than looking a path up in documentation, **enumerate it at runtime**: | Endpoint | Returns | | --------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | `GET /cmn/computed-queries` | All groups | | `GET /cmn/computed-queries/{group-key}` | Templates in a group | | `GET /cmn/computed-queries/{group-key}/{id}/fields` | Attributes of the template's **root entity only** — no relations | | `GET /cmn/computed-queries/fields` | **All** entities with their attributes and relations — this is where you find joins and navigation paths | | `GET /cmn/computed-queries/dialect-info` | The dialect's capabilities | | `POST /cmn/computed-queries/execute` | Execute a VQL query | {% hint style="info" %} **Looking for a path to a related entity?** `…/{id}/fields` deliberately returns only the root entity's attributes. To find out what you can navigate or join to, use `GET /cmn/computed-queries/fields` — optionally narrowed with `entityIdentifier` (a fully qualified or simple entity name). {% endhint %} Useful query parameters on the field endpoints: | Parameter | Effect | | --------------------------- | ------------------------------------------------------ | | `filterable` / `resultable` | Restrict to attributes usable in `WHERE` / in `SELECT` | | `verbose` | Include detailed data-type information | | `visibility` | Filter by attribute visibility | | `depth` | How far to traverse (template fields endpoint) | | `entityIdentifier` | Limit to one entity (all-fields endpoint) | This is the reliable answer to "what is the exact field path for …". A path you copied from a document may not exist in your version; a path you enumerated always does. *** ## WHERE Clause ### Operators | Operator | Example | | ----------------------- | -------------------------------------------- | | `=` | `WHERE status = 'ACTIVE'` | | `!=` | `WHERE status != 'CLOSED'` | | `>` `>=` `<` `<=` | `WHERE documentDate >= '2024-01-01'` | | `LIKE` | `WHERE name LIKE '%GmbH%'` | | `NOT LIKE` | `WHERE name NOT LIKE '%test%'` | | `IN` | `WHERE id IN ('a1', 'a2', 'a3')` | | `NOT IN` | `WHERE status NOT IN ('DRAFT', 'CANCELLED')` | | `BETWEEN` | `WHERE amount BETWEEN 100 AND 500` | | `NOTNULL` / `NOT NULL` | `WHERE externalId NOTNULL` | | `ISNULL` / `IS NULL` | `WHERE deletedAt ISNULL` | | `EXISTS (subquery)` | `WHERE EXISTS (SELECT id FROM ...)` | | `NOT EXISTS (subquery)` | `WHERE NOT EXISTS (SELECT id FROM ...)` | | `IN (subquery)` | `WHERE id IN (SELECT ... FROM ...)` | Combine with `AND`, `OR`, and parentheses `()` for grouping. ### Field-to-Field Comparison ```sql WHERE modifiedDate > createdDate ``` *** ## Sorting and paging `ORDER BY`, `LIMIT` and `OFFSET` work as they do in SQL, and they belong in the statement: ```sql SELECT id, number, documentDate FROM document.querySalesDocuments ORDER BY id ASC LIMIT 10 OFFSET 20 ``` {% hint style="warning" %} **Always order by a unique column when you page.** Offset paging over an unsorted result set is undefined — pages overlap, so some rows arrive twice and others never arrive, differently on each run. `id` is the safe choice. → [Pagination and filtering](/documentation/rest-api/pagination-and-filtering) {% endhint %} `LIMIT` and `OFFSET` can **also** be supplied next to the statement — as `limit` and `offset` on the execute request, which is what the framework's `vql()` helper does. Both routes exist because tools such as JDBC/ODBC drivers add them independently of the statement text. {% hint style="info" %} **Don't set both.** If a request field and a statement clause disagree, the **request field wins** and the clause in your statement is silently ignored. Pick one place — the statement when you write queries by hand, the parameters when you page programmatically. {% endhint %} *** ## Special Value Expressions ### Relative Date — rd{} Filter by dates relative to today. Format: `rd{DAY.MONTH.YEAR}` — each segment accepts `*` (keep current), an absolute value, or a relative offset (`+N` / `-N`). **Examples:** ```sql WHERE createdAt >= 'rd{*.-1.*}' ``` ```sql WHERE documentDate < 'rd{-14.*.*}' ``` **Reference:** | Expression | Meaning | | ------------- | ------------------------------------------------ | | `rd{*.*.*}` | Today | | `rd{-14.*.*}` | 14 days ago | | `rd{*.-1.*}` | One month ago | | `rd{*.*.-1}` | One year ago | | `rd{1.*.*}` | First of the current month | | `rd{E.*.*}` | First day of the current month | | `rd{L.*.*}` | Last day of the current month | | `rd{EW.*.*}` | First working day (Mon–Fri) of the current month | | `rd{LW.*.*}` | Last working day (Mon–Fri) of the current month | | `rd{TODAY}` | Today (alias) | Extends `rd{}` with a time component. Format: `rdt{DAY.MONTH.YEAR HOUR:MINUTE}` — the time part supports the same `*` / `+N` / `-N` syntax plus the keywords `start`, `end`, and `now`. {% hint style="info" %} `rd{}` can also be used on DateTime fields — the system resolves it to a date and handles the conversion automatically. Use `rdt{}` only when you need explicit control over the time component. {% endhint %} **Examples:** ```sql WHERE startDateTime > 'rdt{-14.*.* start}' ``` ```sql WHERE updatedAt >= 'rdt{*.-1.* 00:00}' ``` **Reference:** | Expression | Meaning | | ------------------- | -------------------------------- | | `rdt{*.*.* now}` | Current date and time | | `rdt{*.*.* start}` | Start of today (`00:00:00`) | | `rdt{*.*.* end}` | End of today (`23:59:59`) | | `rdt{-7.*.* 08:00}` | 7 days ago at 08:00 | | `rdt{*.*.* *:*}` | Current date and time (keep all) | An optional timezone suffix converts the result to UTC: `rdt{*.*.* start;tz=Europe/Berlin}` ### Current User — env{me} Resolves to the ID of the authenticated user. Use it to scope queries to the current user's data: ```sql WHERE assignedUser.id = 'env{me}' ``` *** ## Custom Fields Custom Fields (EAV attributes) are accessed via dot notation: ```sql SELECT id, custom.myapp.externalId FROM article.query WHERE custom.myapp.externalId NOTNULL ``` Path pattern: `custom.{groupKey}.{attributeKey}` *** ## Subqueries and JOINs ### Subqueries As a column (correlated — `^$` references the outer query): ```sql SELECT (SELECT displayName FROM account.query WHERE id = ^$.addresses.account.id) AS accountName FROM document.querySalesDocuments ``` As a FROM source: ```sql SELECT t$.name FROM (SELECT name FROM account.query) AS t ``` In WHERE: ```sql SELECT * FROM crm.tasks WHERE NOT EXISTS ( SELECT id FROM crm.task-activities WHERE ^$.id = relations.crmTask.id AND startDateTime > 'rd{-14.*.*}' ) ``` `^$` references the parent query. `alias$` references a named subquery or join. ### JOIN Joins use a subquery as the right-hand side: ```sql SELECT id, number, docs$.totalNetPrice FROM account.query JOIN ( SELECT sum(totalNetPrice), addresses.account.id, addresses.type FROM document.querySalesDocuments ) AS docs ON ( docs$.addresses.account.id = id AND docs$.addresses.type = 'DEFAULT_ADDRESS' AND docs$.totalNetPrice > 0 ) WHERE docs$.addresses.account.id = id LIMIT 1 ``` ### Complex Example This query finds all CRM tasks that had no activity in the past 14 days, are not finished, are older than 14 days, are in a specific state, and are assigned to the current user: ```sql SELECT * FROM crm.tasks WHERE NOT EXISTS ( SELECT id FROM crm.task-activities WHERE ^$.id = relations.crmTask.id AND startDateTime > 'rd{-14.*.*}' ) AND state.finishState = 'false' AND createdAt < 'rd{-14.*.*}' AND state.sortOrder = '55' AND assignedUser.id = 'env{me}' AND (assignedGroup.label != 'Group-Name' OR assignedGroup.id ISNULL) ``` *** ## App Framework Usage VQL is the essential mechanism for selecting and reading data from the ERP within apps. Whether you need to look up a single record, fetch a filtered list, or aggregate values — `app.erp.vql()` is how your app queries the ERP: ```javascript const { data, moreElements, nextOffset } = await app.erp.vql({ statement: ` SELECT --v:result{displayname='id'} id, --v:result{displayname='name'} default_address.name1 FROM account.query WHERE default_address.country.isoAlpha2 = 'DE' ORDER BY default_address.name1 ASC `, limit: 100, offset: 0, }); ``` ### Parameters | Parameter | Type | Default | Description | | ----------- | -------------- | ------- | ------------------ | | `statement` | `string` | — | The VQL query | | `limit` | `number\|null` | `null` | Max rows to return | | `offset` | `number\|null` | `null` | Rows to skip | ### Response The response body contains: | Field | Type | Description | | ------------ | ------- | ----------------------------------------------------- | | `data` | `array` | Result rows — keys match your `displayname` aliases | | `definition` | `array` | Column metadata (data types, visibility, sortability) | ### Pagination Pagination information is delivered via **response headers**. The framework reads them and exposes them on the response object: | Response Header | Framework Field | Type | Description | | ----------------------- | --------------- | -------- | ---------------------------------------------------------------- | | `x-query-more-elements` | `moreElements` | `string` | `'true'` if additional rows exist beyond the current page | | `x-query-next-offset` | `nextOffset` | `string` | Pass this as `offset` in the next request to fetch the next page | Use `limit` and `offset` to page through results. When `moreElements` is `'true'`, pass `nextOffset` as the `offset` for the next call to continue. {% hint style="warning" %} `moreElements` and `nextOffset` are **strings**, not booleans or numbers. Always compare with `=== 'true'` or `=== 'false'`. {% endhint %} {% hint style="info" %} For the full Computed Query API specification, see the [API Docs](https://developer.vario-software.de/api-reference/computed-queries). {% endhint %} # Introduction Run server-side JavaScript inside the ERP — workflows and batch processing. VARIO Cloud is a cloud ERP system with a built-in scripting engine for server-side business logic automation. Scripts are written in JavaScript and executed in a sandboxed GraalJS runtime on the VARIO backend — no external servers, no middleware, no deployment pipelines. They can read, validate, transform, and write ERP records the moment an event occurs, with full transactional safety and zero network latency. Every business eventually outgrows the standard feature set. An ERP that cannot be extended becomes a bottleneck. VARIO Cloud Scripting removes that bottleneck: any rule, automation, or integration you can express in JavaScript becomes a native part of the system — invisible to end users, auditable through logs, and versioned alongside your workflows. The scripting engine runs on the same Java backend that powers the REST API, and the full service layer is available to every script. *** ## What You Can Do With VARIO Cloud Scripting, you can automate any business process in the ERP: * **Validate** — enforce business rules before data is persisted, blocking saves that violate your constraints * **Enrich** — auto-fill fields, resolve references, and set defaults based on context when entities are created or modified * **React** — trigger follow-up actions in response to entity lifecycle events — create tasks, update related records, notify stakeholders * **Orchestrate** — pause execution to prompt users for decisions, then continue down the chosen path * **Branch** — route logic based on entity type, state, or any field value, applying different rules to different scenarios * **Transform** — convert documents between types, update statuses, and chain operations together automatically * **Import** — process CSV or JSON files row by row to create or update entities in bulk, with full field mapping and error handling per row *** ## Two Scripting Contexts VARIO Cloud provides two scripting contexts. Both share the same service layer — every service available in a workflow is also available in a batch script. The difference is how scripts are triggered and what data they receive. ### Workflows Event-driven scripts that react to entity lifecycle events — saving, creating, transferring, or editing records. A workflow consists of a trigger, one or more script elements, optional branching logic, and user interaction steps. Workflows are the primary mechanism for real-time automation. → [Workflow documentation](/documentation/scripting/workflows) ### Batch Processing Data import scripts that process files row by row. Each row passes through a series of callbacks — `beforeImport`, `eachRow`, `afterImport` — giving you full control over how external data maps into VARIO entities. Batch scripts are designed for bulk operations like importing articles, customers, or suppliers from external systems. Imports can be scheduled to run automatically using Cron expressions, enabling fully unattended recurring data syncs. → [Batch Processing documentation](/documentation/scripting/batch-processing) *** ## Shared Service Layer Both scripting contexts in VARIO Cloud access ERP functionality through `ctx.services` — a rich set of services for reading, creating, updating, and querying entities, resolving references, managing users, and logging. → [Services documentation](/documentation/scripting/services) *** ## Script Modules Reusable JavaScript modules that can be imported by any workflow or batch script. Modules are managed centrally and organized into groups for structure and namespacing. > [Script Modules documentation](/documentation/scripting/script-modules) *** ## Getting Started 1. Open the **Workflows** section in VARIO Cloud 2. Create a new workflow and choose a trigger 3. Add a script element and write your first `setAction` 4. Use the built-in autocompletion to explore `ctx.availableInput` and `ctx.services` 5. Check the execution log after triggering the workflow The script editor provides full autocompletion for all available services, methods, and entity properties — no guesswork required. *** ## Type Definitions The in-app script editor already offers autocompletion. When you develop scripts — especially [Script Modules](/documentation/scripting/script-modules) — locally in your own editor (for example VS Code), you can get the same IntelliSense and type checking from the [@vario-software/types](https://www.npmjs.com/package/@vario-software/types) package. It ships type definitions for the scripting interfaces, including the `ctx` object, `ctx.services`, and entity DTOs. See the package page for setup instructions. The same package also provides types for the [REST API](/documentation/rest-api/introduction#type-definitions). # Workflows Event-driven scripts that react to entity lifecycle events in the ERP. VARIO Cloud Workflows let you run server-side JavaScript in response to entity lifecycle events in the ERP — an account being saved, a document being created, a CRM deal changing state, and more. Workflows are the primary mechanism for automating business processes, validating data before it is persisted, and orchestrating multi-step logic with user interactions. *** ## Workflow Structure Every VARIO Cloud workflow consists of a **trigger** and a chain of **elements** connected by successors: ``` Trigger (e.g. account.BEFORE_SAVE) → START_EVENT → SCRIPT_TASK → EXCLUSIVE_SPLIT_GATEWAY → SCRIPT_TASK (Branch A) → SCRIPT_TASK (Branch B) → EXCLUSIVE_JOIN_GATEWAY → END_EVENT_SUCCESS ``` *** ## Triggers The trigger determines **when** a VARIO Cloud workflow runs and **what data** is available to your scripts. ### BEFORE\_SAVE vs AFTER\_SAVE This is the most important distinction in VARIO Cloud workflow scripting — it determines whether your script can modify the entity directly or must read and update it via service calls: | | BEFORE\_SAVE | AFTER\_SAVE | | --------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------- | | **Execution** | Synchronous — blocks the save | Asynchronous — runs after save completes | | **Input** | The entity to save (e.g. `accountToSave`) and its previous version | The saved entity's ID (e.g. `accountId`) and previous version | | **Can modify entity** | Yes — changes to the ToSave entity are persisted automatically | Yes — but must read by ID and update via service methods | | **Can cancel save** | Yes — `throw 'message'` aborts with an error shown to the user | No | BEFORE\_SAVE scripts receive the entity object directly and can modify it in place — every change is persisted with the save. AFTER\_SAVE scripts only receive the entity's ID, so they must read the entity via its service, apply changes, and explicitly call the update method. ### Other Triggers Beyond BEFORE\_SAVE and AFTER\_SAVE, triggers exist for specific lifecycle events such as `document.CREATE`, `document.TRANSFER`, and `document.BEGIN_EDITING`. These behave like AFTER\_SAVE — they run asynchronously and provide IDs rather than entity objects. The data available to each trigger is accessible via `ctx.availableInput` and `ctx.parameters`. The exact fields depend on the trigger and are visible in the workflow editor. *** ## Script Structure Every workflow script in VARIO Cloud starts with an import that determines its type. Scripts can be written inline in each element or saved centrally as [Script Modules](/documentation/scripting/script-modules) and referenced by name. ### SCRIPT\_TASK ```javascript import workItem from "work_item_script"; workItem.setAction((ctx) => { // Your business logic }); ``` You can optionally add a **guard** to skip the element, and a **prepare** step to set up variables before the action: ```javascript workItem.setPrepare((ctx) => { // Optional — runs before setAction, e.g. to initialize variables }); workItem.setGuard((ctx) => { // Return true to execute setAction, false to skip this element return ctx.availableInput.accountToSave.customer !== null; }); workItem.setAction((ctx) => { // Only runs if guard returned true }); ``` ### EXCLUSIVE\_SPLIT\_GATEWAY ```javascript import workItem from "work_item_split_gateway"; workItem.setSplit((ctx) => { const targetCategory = ctx.availableInput.targetCategory; const creditNoteTypes = [ 'CUSTOMER_CREDIT_NOTE_WITH_STOCK', 'CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK', 'SUPPLIER_CREDIT_NOTE_WITH_STOCK', 'SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK' ]; if (creditNoteTypes.includes(targetCategory)) { return 'TRANSFER_INTO_CREDIT_NOTE'; } return 'END_WORKFLOW'; }); ``` The returned string must match a key in the element's `successors` map. *** ## The Context Object (ctx) Every script in a VARIO Cloud workflow receives a context object `ctx` with the following properties: | Property | Description | | -------------------- | ---------------------------------------------------------------------- | | `ctx.availableInput` | Trigger-specific data — the entity being saved, IDs, previous versions | | `ctx.services` | All available scripting services | | `ctx.parameters` | Workflow parameters and user task results | *** ## Reading and Modifying Data How you read and modify ERP data in VARIO Cloud depends on the trigger type. ### BEFORE\_SAVE — Direct Modification In BEFORE\_SAVE triggers, `ctx.availableInput` contains the entity object that is about to be saved, named with a `ToSave` suffix — e.g. `accountToSave`, `documentToSave`, or `crmDealToSave`. This is the actual object being persisted. Any property you set on it is automatically included in the save without calling a service method. Because the save is still in progress, you can also cancel it by throwing an error. ```javascript import workItem from "work_item_script"; workItem.setAction((ctx) => { const document = ctx.availableInput.documentToSave; if (!document) return; if (!document.documentCategory || !document.documentCategory.startsWith('CUSTOMER')) { return; } if (document.reverseCharge === true) { const vatId = document.vatId; if (!vatId || vatId.trim() === '') { throw 'Bei Belegen mit §13b (Reverse Charge) muss eine USt.-ID angegeben werden.'; } ctx.services.logger.info('§13b Validierung erfolgreich: USt.-ID ist vorhanden.'); } }); ``` ### AFTER\_SAVE — Read, Modify, Update In AFTER\_SAVE triggers, read the entity by ID, modify it, and call the service's update method: ```javascript import workItem from "work_item_script"; workItem.setAction((ctx) => { if (ctx.availableInput.previousAccount != null) { return; } const account = ctx.services.accountService.readById(ctx.availableInput.accountId); const createdBy = ctx.services.userAndGroupService.findUserById(account.info.createdFrom); if (createdBy?.username !== 'niko.neumann') return; let taskDto = ctx.services.crmTaskService.createNewDtoByTemplate('Adress-Prüfung'); ctx.services.crmTaskService.create(taskDto); }); ``` ### Document Updates When updating documents via service (e.g. in AFTER\_SAVE or CREATE triggers), `documentService` requires a request wrapper. In `document.ON_MERGE_CHANGES` triggers, the document is available as `documentToSave` and can be modified directly — like any other BEFORE\_SAVE entity. ```javascript workItem.setAction((ctx) => { const { documentId } = ctx.parameters; const { documentService, accountService, deliveryMethodService, paymentMethodService, utils, logger } = ctx.services; const document = documentService.readById(documentId); const account = accountService.readById(document.accountId); if (account.types.includes('CUSTOMER')) { return; } if (!document.deliveryMethodRef) { logger.info('Setze Versandart: DL'); const deliveryMethod = deliveryMethodService.findByLabel('DL'); document.deliveryMethodRef = utils.toApiReference(deliveryMethod); } if (!document.paymentMethodRef) { logger.info('Setze Zahlungsart: UEB'); const paymentMethod = paymentMethodService.findByLabel('UEB'); document.paymentMethodRef = utils.toApiReference(paymentMethod); } const updateRequest = documentService.getUpdateDocumentRequest(); updateRequest.document = document; documentService.update(updateRequest); }); ``` *** ## Validation and Cancellation In BEFORE\_SAVE triggers, throw an error to cancel the save: ```javascript workItem.setAction((ctx) => { const account = ctx.availableInput.accountToSave; if (!account.defaultAddress.postcode) { throw 'A postal code is required.'; } if (account.defaultAddress.country.isoAlpha2 === 'DE' && account.defaultAddress.postcode.length !== 5) { throw 'German postal codes must be exactly 5 digits.'; } }); ``` The error message is displayed to the user and the save operation is aborted. *** ## Logging Use `ctx.services.logger` to write log entries: ```javascript ctx.services.logger.info('PLZ-Validierung erfolgreich abgeschlossen.'); ctx.services.logger.warn('Unexpected value encountered.'); ctx.services.logger.error('Failed to update document.'); ``` | Method | Description | | ------------------- | --------------------- | | `logger.info(msg)` | Informational message | | `logger.warn(msg)` | Warning | | `logger.error(msg)` | Error | Log entries are visible in the workflow execution log in the ERP. *** ## VQL in Workflows Use `ctx.services.vqlService` to query ERP data within scripts: ```javascript const results = ctx.services.vqlService.queryAll( `SELECT id, number FROM article.query WHERE number = '12345' LIMIT 1` ); if (results && results.length > 0) { const articleId = results[0].id; } ``` {% hint style="info" %} `vqlService.queryAll()` returns a `List`. Access fields directly by their attribute path: `results[0].id`, `results[0].number`. {% endhint %} *** ## User Tasks VARIO Cloud workflows support user interaction through `USER_TASK` elements. A user task pauses workflow execution and prompts the user for input. The user's response is available in subsequent scripts via `ctx.parameters`: ```javascript // In the element after a USER_TASK with resultName 'closingReasonId' workItem.setAction((ctx) => { const crmDealService = ctx.services.crmDealService; const dealId = ctx.parameters['crmId']; const closingReasonId = ctx.parameters['closingReasonId']; crmDealService.dealWon(dealId, closingReasonId); }); ``` *** ## Custom Fields VARIO Cloud [Custom Fields](/documentation/fundamentals/custom-fields) are accessed directly on entity objects in scripts: ```javascript // Read const externalId = account.custom.myapp.externalId; ``` ```javascript // Write (in BEFORE_SAVE) account.custom.myapp.externalId = 'EXT-123'; account.custom.myapp.syncedAt = ctx.services.utils.dateTimeNow(); ``` *** ## Comparing with Previous State Both BEFORE\_SAVE and AFTER\_SAVE triggers in VARIO Cloud provide the previous version of the entity. Use it to detect field-level changes and react only when specific values have changed: ```javascript workItem.setAction((ctx) => { const current = ctx.availableInput.crmDealToSave; const previous = ctx.availableInput.crmDealPrevious; // Only act if the state actually changed if (current.state.id === previous.state.id) return; if (current.state.label === 'Won') { // Deal just became "Won" } }); ``` # Batch Processing Process imported CSV or JSON data row by row, with full control over mapping and errors. VARIO Cloud Batch Processing lets you run server-side JavaScript scripts that process imported data (CSV/JSON) row by row. Batch scripts are not limited to importing new records — they can also update existing entities in bulk, create related objects in mass, or combine both approaches. Since the full service layer is available, anything you can do in a workflow script can also be done per row in a batch script. *** ## Script Structure Every VARIO Cloud batch script starts with an import and registers one or more callbacks: ```javascript import batchAction from 'batch_script'; batchAction.setGuard((ctx) => { // Return false to skip this row return ctx.importData.ID !== ''; }); batchAction.setAction((ctx) => { // Process a single row — return true on success, false on failure const id = ctx.importData.ID; // ... return true; }); batchAction.setAfterBatch((ctx) => { // Runs once after all rows are processed // ctx.importData is empty here — use ctx.importSession for accumulated data }); ``` ### Callbacks | Callback | Runs | Return | Purpose | | --------------- | ------------------- | --------------------------------------------- | --------------------------------------------- | | `setGuard` | Per row | `boolean` — `false` skips the row | Filter rows before processing | | `setAction` | Per row | `boolean` — `true` = success, `false` = error | Process a single import row | | `setAfterBatch` | Once after all rows | — | Finalize the batch (e.g. trigger a print job) | *** ## The Context Object Almost every callback in a VARIO Cloud batch script receives a context object `ctx` with the following properties: | Property | Description | | ------------------- | --------------------------------------------------------------------------------------------- | | `ctx.importData` | The current CSV/JSON row as a map. Keys are column headers. | | `ctx.importSession` | A shared map that persists across all rows in a run. Use it to accumulate state. | | `ctx.services` | Same services as in workflow scripts (`vqlService`, `accountService`, `articleService`, etc.) | | `ctx.parameters` | Import parameters configured on the rule set | | `ctx.errorMessages` | Accumulate error messages for the current row | *** ## Typical Pattern — Create or Update Most VARIO Cloud batch scripts follow this pattern when importing data: check if the entity already exists via VQL, then create or update accordingly: ```javascript import batchAction from 'batch_script'; batchAction.setAction((ctx) => { const number = ctx.importData.Artikelnummer; // Check if article already exists const existing = ctx.services.vqlService.queryAll( `SELECT id FROM article.query WHERE number = '${number}' LIMIT 1` ); let article; if (!existing || existing.length === 0) { article = ctx.services.articleService.getNewDto(); article.number = number; } else { article = ctx.services.articleService.readById(existing[0].id); } // Map import data to entity fields article.description = ctx.importData.Bezeichnung; article.custom.mygroup.FIELD = ctx.importData.CustomValue; // Persist if (!existing || existing.length === 0) { ctx.services.articleService.create(article); } else { ctx.services.articleService.update(article); } return true; }); ``` *** ## Logging Use `ctx.services.logger` the same way as in workflow scripts: ```javascript ctx.services.logger.info('Article created: ' + number); ctx.services.logger.warn('Missing field, skipping row.'); ctx.services.logger.error('Failed to create article.'); ``` {% hint style="info" %} Each row is processed in its own transaction. Workflows and webhooks can be suppressed during batch processing via the import configuration. {% endhint %} *** ## Scheduled Execution VARIO Cloud batch imports can be scheduled to run automatically using Cron expressions. Configure the schedule directly in the ERP on the import rule set — the system will trigger the import at the defined intervals without manual interaction. This is useful for recurring imports such as nightly stock updates, daily price syncs, or periodic data feeds from external systems. # Services The ctx.services layer scripts use to read, create, update and query ERP data. In VARIO Cloud, scripts access the full ERP functionality through `ctx.services`. This shared service layer is the backbone of all scripting — it is available in both workflow and batch scripts, and every service works identically in either context. The services and methods shown below are examples. For the complete list of available services, methods, and parameters, see the Scripting Reference. *** ## Entity Services Entity services are the primary way to read, create, update, and deactivate business objects in VARIO Cloud. They manage core ERP records — accounts, articles, documents, CRM objects, and more. Most share a common method pattern: | Method | Description | | ------------------------------ | ------------------------------------------------- | | `getNewDto()` | Create a new empty DTO | | `createNewDtoByTemplate(name)` | Create a new DTO pre-filled from a named template | | `readById(id)` | Read an entity by ID | | `create(dto)` | Persist a new entity | | `update(dto)` | Update an existing entity | | `deactivate(id)` | Deactivate an entity | Not every service exposes every method — the available methods depend on the entity type. ```javascript const account = ctx.services.accountService.readById(accountId); account.custom.myapp.externalId = 'EXT-123'; ctx.services.accountService.update(account); ``` *** ## VQL Service The VARIO Cloud `vqlService` executes [VQL](/documentation/fundamentals/vql) queries from within scripts, giving you full access to the query language for lookups, aggregations, and existence checks. `queryAll()` returns a `List` — access fields directly by their attribute path. ```javascript const results = ctx.services.vqlService.queryAll( `SELECT id, number FROM article.query WHERE number = '${number}' LIMIT 1` ); if (results && results.length > 0) { const articleId = results[0].id; } ``` {% hint style="info" %} For the full VQL syntax — operators, relative dates, subqueries, JOINs — see [VQL](/documentation/fundamentals/vql). {% endhint %} *** ## User & Group Service `userAndGroupService` resolves users and groups in the system — for example to check who created an entity or to assign a user to a task. ```javascript const user = ctx.services.userAndGroupService.findUserById(account.info.createdFrom); ctx.services.logger.info('Created by: ' + user.username); ``` *** ## DTO Factory In VARIO Cloud, entity services like `accountService.getNewDto()` create the top-level entity object, but not the nested objects within it. When you need to add an address, a contact, a business relationship, or similar sub-objects to an entity, you must create them separately via `dtoFactory` and then attach them — typically by assigning to a field or pushing into an array. The factory covers all DTO types in the system — addresses, contacts, business relationships, article identifiers, metrics, and many more. The naming follows the pattern `create()`. The full list is available via autocompletion in the script editor. ### Adding Nested Objects to an Entity ```javascript const account = ctx.services.accountService.getNewDto(); // Create and assign the default address const address = ctx.services.dtoFactory.createAccountAddress(); address.name1 = 'Mustermann GmbH'; address.street = 'Hauptstraße 1'; address.postcode = '50667'; address.city = 'Köln'; account.defaultAddress = address; // Create contacts and push them into the address const phone = ctx.services.dtoFactory.createContact(); phone.ctType = 'PHONE'; phone.ctLabel = 'Telefon'; phone.value = '+49 221 12345'; account.defaultAddress.contacts.push(phone); // Create the business relationship const customer = ctx.services.dtoFactory.createCustomer(); customer.number = '10001'; account.customer = customer; ctx.services.accountService.create(account); ``` *** ## Utilities `utils` provides helper functions used across all scripting contexts — most importantly `toApiReference()` for reference fields, but also `dateTimeNow()`, `concatLists()`, and others. ### API References Any DTO field ending in `Ref` — such as `paymentMethodRef`, `deliveryTermRef`, `taxSchemaRef`, or `productGroupRef` — expects an API reference object. You cannot assign a plain ID string or entity directly. Use `toApiReference()` to convert an ID into the required format. The recommended approach is to pass the ID directly: ```javascript article.taxSchemaRef = utils.toApiReference('1434873425719062528'); article.productGroupRef = utils.toApiReference(existingGroup[0].id); ``` When using a lookup service, you can also pass the resolved entity: ```javascript const deliveryMethod = ctx.services.deliveryMethodService.findByLabel('DL'); document.deliveryMethodRef = utils.toApiReference(deliveryMethod); ``` ```javascript account.custom.myapp.syncedAt = ctx.services.utils.dateTimeNow(); ``` *** ## Logger `logger` writes log entries visible in the workflow execution log or batch import log. It provides `info()`, `warn()`, and `error()` methods. ```javascript ctx.services.logger.info('Account ' + account.number + ' updated successfully'); ctx.services.logger.warn('Missing field — using default value'); ctx.services.logger.error('Failed to update document ' + documentId); ``` *** ## Destructuring When a script uses multiple services you can destructure them for readability: ```javascript const { documentService, accountService, paymentMethodService, utils, logger } = ctx.services; const document = documentService.readById(documentId); const account = accountService.readById(document.accountId); logger.info('Processing document for account ' + account.number); ``` *** # Script Modules Reusable JavaScript modules shared across workflows and batch scripts. VARIO Cloud Script Modules are reusable JavaScript files stored directly in the ERP. Instead of duplicating logic across workflows and batch scripts, you write it once as a module and import it wherever needed. Modules are managed under **System → Scripts** in VARIO Cloud. *** ## Module Groups Groups organize modules into named collections. Every group has a unique `name` and an optional `description`. Beyond organization, groups serve as **namespaces** — they become part of the import path and prevent name collisions between unrelated modules. A module can belong to exactly one group or exist ungrouped at the top level. *** ## Import Mechanism Any workflow or batch script in VARIO Cloud can import a module using standard ES module syntax. The import path determines how the module is resolved at runtime through a virtual module system: ```javascript // Ungrouped module — looked up by name alone import helpers from "my_module"; ``` ```javascript // Grouped module — looked up by module name within the specified group import helpers from "my_group/my_module"; ``` Module resolution is virtual — there is no filesystem involved. When a script executes, the engine resolves the import path against all registered modules in the database at runtime. {% hint style="warning" %} Module names and group names must be **alphanumeric**. The combination of module name and group must be unique. {% endhint %} *** ## Domains Each module has a **domain** that indicates its intended usage context. The domain is organizational — it helps categorize modules in the UI and signals to other developers what the module is designed for. | Domain | Purpose | | ----------------------------- | ------------------------------------------ | | `LIBRARY` | Shared modules importable by other scripts | | `WORKFLOW_SCRIPT` | Workflow script tasks | | `WORKFLOW_SPLIT_GATEWAY` | Workflow split gateways | | `WORKFLOW_INTERMEDIATE_EVENT` | Workflow intermediate events | | `IMPORT_BATCH_PROCESSING` | Batch processing scripts | | `APP` | App-specific modules | | `UNDEFINED` | Not yet categorized | *** ## Parameters Modules can define **typed parameters** that make them configurable. Each parameter has a `name` and a `valueType` (`string`, `boolean`, or `number`). When a module is used in a workflow or batch script, the parameter values are passed at runtime and accessible inside the script via `ctx.parameters`. This allows a single module to serve multiple use cases — for example, one print module configured with different templates or output formats depending on the context it runs in. *** ## Presettings VARIO Cloud ships with **preset modules** — default implementations for common tasks like printing documents, sending emails, or assigning images to articles. These presets belong to the group **Vorgabe-Stapel-Skripte** and can be used out of the box. Users can customize a preset module by editing its script. The original version is preserved internally, and the module can be **reset to its presetting** at any time to restore the default implementation. *** ## Built-in Modules The scripting engine provides built-in modules that are always available and cannot be modified. These are the entry points for workflows and batch scripts: | Module | Context | | ------------------------------ | ------------------------------------------------------------- | | `work_item_script` | Workflow script tasks (`setAction`, `setGuard`, `setPrepare`) | | `work_item_split_gateway` | Workflow split gateways (`setSplit`) | | `work_item_intermediate_event` | Workflow intermediate events | | `batch_script` | Batch processing (`setAction`, `setGuard`, `setAfterBatch`) | These are imported at the top of every script — e.g. `import workItem from "work_item_script"`. User-created modules are imported alongside them using the same syntax. *** ## Example A reusable module that validates address fields: ```javascript // Module: "address_validation" in group "validators" export default { validatePostcode(country, postcode) { if (country === 'DE' && (!postcode || postcode.length !== 5)) { throw 'German postal codes must be exactly 5 digits.'; } }, requireField(value, fieldName) { if (!value || (typeof value === 'string' && value.trim() === '')) { throw fieldName + ' is required.'; } } }; ``` Importing it in a workflow: ```javascript import workItem from "work_item_script"; import address from "validators/address_validation"; workItem.setAction((ctx) => { const account = ctx.availableInput.accountToSave; const addr = account.defaultAddress; address.requireField(addr.city, 'City'); address.requireField(addr.postcode, 'Postal code'); address.validatePostcode(addr.country.isoAlpha2, addr.postcode); }); ``` {% hint style="info" %} The same module can be imported in batch scripts, other workflow scripts, or even other modules — write once, use everywhere. {% endhint %} # VARIO Cloud REST API Reference Complete reference for the REST API This section contains the complete reference documentation for the VARIO Cloud REST API. The API reference is generated from the OpenAPI specification and provides detailed information about all endpoints, request and response schemas, authentication requirements, and error formats. Use this reference when you need precise technical details. For guides, concepts, and best practices, see the REST API documentation. We automatically generates pages and endpoints from our OpenAPI spec. This API reference is rendered using GitBook’s built-in OpenAPI viewer. We are continuously working on improving the structure and presentation within the capabilities of the tool. If you prefer, you can also download the OpenAPI specification and explore it locally using your preferred tooling. # Asset Verwaltung der Assets ## GET /erp/assets/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/{id}":{"get":{"tags":["Asset"],"summary":"Find an existing Resource by identifier","operationId":"getById_81","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-Asset"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-Asset":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"number":{"type":"string","description":"Asset-Nummer"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Asset-Bezeichnung"},"note":{"type":"string","description":"Notiz"},"warrantyStartDate":{"type":"string","format":"date","description":"Beginn Garantie"},"warrantyEndDate":{"type":"string","format":"date","description":"Ende Garantie"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"billingAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contractRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentAssetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childAssetRefs":{"type":"array","description":"Zugehörige Assets","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["articleRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/assets/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/{id}":{"put":{"tags":["Asset"],"summary":"Update existing Resource ","operationId":"update_74","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-asset-Asset"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-Asset"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-Asset":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"number":{"type":"string","description":"Asset-Nummer"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Asset-Bezeichnung"},"note":{"type":"string","description":"Notiz"},"warrantyStartDate":{"type":"string","format":"date","description":"Beginn Garantie"},"warrantyEndDate":{"type":"string","format":"date","description":"Ende Garantie"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"billingAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contractRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentAssetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childAssetRefs":{"type":"array","description":"Zugehörige Assets","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["articleRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /erp/assets/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/{id}":{"delete":{"tags":["Asset"],"summary":"Delete an existing Resource","operationId":"delete_72","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/assets/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/{id}/deactivate":{"put":{"tags":["Asset"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_35","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-Asset"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-Asset":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"number":{"type":"string","description":"Asset-Nummer"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Asset-Bezeichnung"},"note":{"type":"string","description":"Notiz"},"warrantyStartDate":{"type":"string","format":"date","description":"Beginn Garantie"},"warrantyEndDate":{"type":"string","format":"date","description":"Ende Garantie"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"billingAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contractRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentAssetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childAssetRefs":{"type":"array","description":"Zugehörige Assets","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["articleRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/assets/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/{id}/activate":{"put":{"tags":["Asset"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_35","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-Asset"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-Asset":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"number":{"type":"string","description":"Asset-Nummer"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Asset-Bezeichnung"},"note":{"type":"string","description":"Notiz"},"warrantyStartDate":{"type":"string","format":"date","description":"Beginn Garantie"},"warrantyEndDate":{"type":"string","format":"date","description":"Ende Garantie"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"billingAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contractRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentAssetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childAssetRefs":{"type":"array","description":"Zugehörige Assets","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["articleRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## GET /erp/assets/types/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/types/{id}":{"get":{"tags":["Asset"],"summary":"Find an existing Resource by identifier","operationId":"getById_82","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-AssetType"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-AssetType":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/assets/types/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/types/{id}":{"put":{"tags":["Asset"],"summary":"Update existing Resource ","operationId":"update_75","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-asset-AssetType"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-AssetType"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-AssetType":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/assets/types/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/types/{id}":{"delete":{"tags":["Asset"],"summary":"Delete an existing Resource","operationId":"delete_73","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/assets/types/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/types/{id}/deactivate":{"put":{"tags":["Asset"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_36","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-AssetType"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-AssetType":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/assets/types/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/types/{id}/activate":{"put":{"tags":["Asset"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_36","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-AssetType"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-AssetType":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/assets/{id}/copy > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/{id}/copy":{"post":{"tags":["Asset"],"operationId":"copy_1","parameters":[{"name":"id","in":"path","description":"Asset-Id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"newAssetNumber","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-Asset"}}}}}}}},"components":{"schemas":{"erp-asset-Asset":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"number":{"type":"string","description":"Asset-Nummer"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Asset-Bezeichnung"},"note":{"type":"string","description":"Notiz"},"warrantyStartDate":{"type":"string","format":"date","description":"Beginn Garantie"},"warrantyEndDate":{"type":"string","format":"date","description":"Ende Garantie"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"billingAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contractRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentAssetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childAssetRefs":{"type":"array","description":"Zugehörige Assets","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["articleRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/assets/types/ > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/types/":{"post":{"tags":["Asset"],"summary":"Create new Resource","operationId":"create_70","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-asset-AssetType"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-AssetType"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-AssetType":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/assets/create-by-template > Neues Asset erzeugen ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/create-by-template":{"post":{"tags":["Asset"],"summary":"Neues Asset erzeugen","operationId":"createByTemplate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-asset-AssetCreateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-Asset"}}}}}}}},"components":{"schemas":{"erp-asset-AssetCreateRequest":{"properties":{"createTemplateId":{"type":"integer","format":"int64","description":"Vorlage zum Erstellen eines Assets"},"asset":{"$ref":"#/components/schemas/erp-asset-Asset"}}},"erp-asset-Asset":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"number":{"type":"string","description":"Asset-Nummer"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Asset-Bezeichnung"},"note":{"type":"string","description":"Notiz"},"warrantyStartDate":{"type":"string","format":"date","description":"Beginn Garantie"},"warrantyEndDate":{"type":"string","format":"date","description":"Ende Garantie"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"billingAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contractRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentAssetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childAssetRefs":{"type":"array","description":"Zugehörige Assets","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["articleRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/assets/ > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Asset","description":"Verwaltung der Assets"},{"name":"Asset","description":"Verwaltung der Assets-Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/assets/":{"post":{"tags":["Asset"],"summary":"Create new Resource","operationId":"create_71","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-asset-Asset"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-asset-Asset"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-asset-Asset":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"number":{"type":"string","description":"Asset-Nummer"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Asset-Bezeichnung"},"note":{"type":"string","description":"Notiz"},"warrantyStartDate":{"type":"string","format":"date","description":"Beginn Garantie"},"warrantyEndDate":{"type":"string","format":"date","description":"Ende Garantie"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"billingAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"contractRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentAssetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childAssetRefs":{"type":"array","description":"Zugehörige Assets","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["articleRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` # Main Product Groups the IdentifierType API ## GET /erp/product-types/main-product-groups/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MainProductGroups","description":"the IdentifierType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/product-types/main-product-groups/{id}":{"get":{"tags":["MainProductGroups"],"summary":"Find an existing Resource by identifier","operationId":"getById_24","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ProductMainGroup"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ProductMainGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Hauptwarengruppe","maxLength":50,"minLength":0},"description":{"type":"string","description":"Beschreibung der Hauptwarengruppe","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Hauptwarengruppe aktiv ja/nein","readOnly":true},"targetTradingMargin":{"type":"number","description":"Soll-Handelsspanne"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/product-types/main-product-groups/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MainProductGroups","description":"the IdentifierType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/product-types/main-product-groups/{id}":{"put":{"tags":["MainProductGroups"],"summary":"Update existing Resource ","operationId":"update_24","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ProductMainGroup"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ProductMainGroup"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ProductMainGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Hauptwarengruppe","maxLength":50,"minLength":0},"description":{"type":"string","description":"Beschreibung der Hauptwarengruppe","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Hauptwarengruppe aktiv ja/nein","readOnly":true},"targetTradingMargin":{"type":"number","description":"Soll-Handelsspanne"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /erp/product-types/main-product-groups/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MainProductGroups","description":"the IdentifierType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/product-types/main-product-groups/{id}":{"delete":{"tags":["MainProductGroups"],"summary":"Delete an existing Resource","operationId":"delete_23","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/product-types/main-product-groups/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MainProductGroups","description":"the IdentifierType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/product-types/main-product-groups/{id}/deactivate":{"put":{"tags":["MainProductGroups"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_10","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ProductMainGroup"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ProductMainGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Hauptwarengruppe","maxLength":50,"minLength":0},"description":{"type":"string","description":"Beschreibung der Hauptwarengruppe","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Hauptwarengruppe aktiv ja/nein","readOnly":true},"targetTradingMargin":{"type":"number","description":"Soll-Handelsspanne"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/product-types/main-product-groups/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MainProductGroups","description":"the IdentifierType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/product-types/main-product-groups/{id}/activate":{"put":{"tags":["MainProductGroups"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_10","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ProductMainGroup"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ProductMainGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Hauptwarengruppe","maxLength":50,"minLength":0},"description":{"type":"string","description":"Beschreibung der Hauptwarengruppe","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Hauptwarengruppe aktiv ja/nein","readOnly":true},"targetTradingMargin":{"type":"number","description":"Soll-Handelsspanne"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## POST /erp/product-types/main-product-groups > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MainProductGroups","description":"the IdentifierType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/product-types/main-product-groups":{"post":{"tags":["MainProductGroups"],"summary":"Create new Resource","operationId":"create_22","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ProductMainGroup"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ProductMainGroup"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ProductMainGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Hauptwarengruppe","maxLength":50,"minLength":0},"description":{"type":"string","description":"Beschreibung der Hauptwarengruppe","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Hauptwarengruppe aktiv ja/nein","readOnly":true},"targetTradingMargin":{"type":"number","description":"Soll-Handelsspanne"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` # Storage Lager ## GET /erp/storages/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}":{"get":{"tags":["Storage"],"summary":"Find an existing Resource by identifier","operationId":"getById_16","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-Storage"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-Storage":{"description":"Lager","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Ist das Lager aktiv?","readOnly":true},"number":{"type":"string","description":"Lager-Nr."},"displayName":{"type":"string","description":"Anzeigename"},"salesStorage":{"type":"boolean","default":false,"description":"Lieferlager?"},"purchaseOrderStorage":{"type":"boolean","default":false,"description":"Bestelllager?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll das Lager in die Summierung der Bestände/Verfügbarkeiten mit einbezogen werden?"},"returnOrderStorage":{"type":"boolean","default":false,"description":"Ziel-Lager für Retouren (z.B. aus Rechnungskorrektur mit WR)"},"pickingRequired":{"type":"boolean","default":false,"description":"Muss in diesem Lager kommissioniert werden?"},"withStorageBins":{"type":"boolean","default":false,"description":"Sollen in diesem Lager Lagerplätze verwendet werden"},"allowNegativeStock":{"type":"boolean","default":false,"description":"Darf in diesem Lager negativer Bestand gebucht werden"},"transit":{"type":"boolean","default":false,"description":"Ist es das Transitlager"},"identifier":{"type":"string","description":"Nur bei Lagern ohne Lagerplätze: Barcode (vom Standard-Lagerplatz)"},"onlyOneBatchPerStorageBin":{"type":"boolean","default":false,"description":"Nur eine Charge je Artikel pro Lagerplatz"},"supplyStorage":{"type":"boolean","default":false,"description":"Nachschublager"},"forFabricationComponents":{"type":"boolean","default":false,"description":"Material-Lager"},"defaultForFabricationComponents":{"type":"boolean","default":false,"description":"Standard-Material-Lager"},"fabricationWorkbenchStorage":{"type":"boolean","default":false,"description":"Produktion: Werkbank-Lager"},"fabricationQualityAssurance":{"type":"boolean","default":false,"description":"Produktion: QS-Lager"},"fabricationDefectiveStorage":{"type":"boolean","default":false,"description":"Produktion: Defekt-Lager"},"fabricationTargetStorage":{"type":"boolean","default":false,"description":"Produktion: Ziel-Lager"},"considerForOrderProposal":{"type":"boolean","default":false,"description":"Für Bestellvorschlag berücksichtigen"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/storages/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}":{"put":{"tags":["Storage"],"summary":"Update existing Resource ","operationId":"update_15","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-Storage"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-Storage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-Storage":{"description":"Lager","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Ist das Lager aktiv?","readOnly":true},"number":{"type":"string","description":"Lager-Nr."},"displayName":{"type":"string","description":"Anzeigename"},"salesStorage":{"type":"boolean","default":false,"description":"Lieferlager?"},"purchaseOrderStorage":{"type":"boolean","default":false,"description":"Bestelllager?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll das Lager in die Summierung der Bestände/Verfügbarkeiten mit einbezogen werden?"},"returnOrderStorage":{"type":"boolean","default":false,"description":"Ziel-Lager für Retouren (z.B. aus Rechnungskorrektur mit WR)"},"pickingRequired":{"type":"boolean","default":false,"description":"Muss in diesem Lager kommissioniert werden?"},"withStorageBins":{"type":"boolean","default":false,"description":"Sollen in diesem Lager Lagerplätze verwendet werden"},"allowNegativeStock":{"type":"boolean","default":false,"description":"Darf in diesem Lager negativer Bestand gebucht werden"},"transit":{"type":"boolean","default":false,"description":"Ist es das Transitlager"},"identifier":{"type":"string","description":"Nur bei Lagern ohne Lagerplätze: Barcode (vom Standard-Lagerplatz)"},"onlyOneBatchPerStorageBin":{"type":"boolean","default":false,"description":"Nur eine Charge je Artikel pro Lagerplatz"},"supplyStorage":{"type":"boolean","default":false,"description":"Nachschublager"},"forFabricationComponents":{"type":"boolean","default":false,"description":"Material-Lager"},"defaultForFabricationComponents":{"type":"boolean","default":false,"description":"Standard-Material-Lager"},"fabricationWorkbenchStorage":{"type":"boolean","default":false,"description":"Produktion: Werkbank-Lager"},"fabricationQualityAssurance":{"type":"boolean","default":false,"description":"Produktion: QS-Lager"},"fabricationDefectiveStorage":{"type":"boolean","default":false,"description":"Produktion: Defekt-Lager"},"fabricationTargetStorage":{"type":"boolean","default":false,"description":"Produktion: Ziel-Lager"},"considerForOrderProposal":{"type":"boolean","default":false,"description":"Für Bestellvorschlag berücksichtigen"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/storages/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}":{"delete":{"tags":["Storage"],"summary":"Delete an existing Resource","operationId":"delete_14","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/storages/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/deactivate":{"put":{"tags":["Storage"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_5","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-Storage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-Storage":{"description":"Lager","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Ist das Lager aktiv?","readOnly":true},"number":{"type":"string","description":"Lager-Nr."},"displayName":{"type":"string","description":"Anzeigename"},"salesStorage":{"type":"boolean","default":false,"description":"Lieferlager?"},"purchaseOrderStorage":{"type":"boolean","default":false,"description":"Bestelllager?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll das Lager in die Summierung der Bestände/Verfügbarkeiten mit einbezogen werden?"},"returnOrderStorage":{"type":"boolean","default":false,"description":"Ziel-Lager für Retouren (z.B. aus Rechnungskorrektur mit WR)"},"pickingRequired":{"type":"boolean","default":false,"description":"Muss in diesem Lager kommissioniert werden?"},"withStorageBins":{"type":"boolean","default":false,"description":"Sollen in diesem Lager Lagerplätze verwendet werden"},"allowNegativeStock":{"type":"boolean","default":false,"description":"Darf in diesem Lager negativer Bestand gebucht werden"},"transit":{"type":"boolean","default":false,"description":"Ist es das Transitlager"},"identifier":{"type":"string","description":"Nur bei Lagern ohne Lagerplätze: Barcode (vom Standard-Lagerplatz)"},"onlyOneBatchPerStorageBin":{"type":"boolean","default":false,"description":"Nur eine Charge je Artikel pro Lagerplatz"},"supplyStorage":{"type":"boolean","default":false,"description":"Nachschublager"},"forFabricationComponents":{"type":"boolean","default":false,"description":"Material-Lager"},"defaultForFabricationComponents":{"type":"boolean","default":false,"description":"Standard-Material-Lager"},"fabricationWorkbenchStorage":{"type":"boolean","default":false,"description":"Produktion: Werkbank-Lager"},"fabricationQualityAssurance":{"type":"boolean","default":false,"description":"Produktion: QS-Lager"},"fabricationDefectiveStorage":{"type":"boolean","default":false,"description":"Produktion: Defekt-Lager"},"fabricationTargetStorage":{"type":"boolean","default":false,"description":"Produktion: Ziel-Lager"},"considerForOrderProposal":{"type":"boolean","default":false,"description":"Für Bestellvorschlag berücksichtigen"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/storages/{id}/bins/{storageBinId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/bins/{storageBinId}":{"put":{"tags":["Storage"],"operationId":"updateStorageBin","parameters":[{"name":"id","in":"path","description":"identifier of storage","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"storageBinId","in":"path","description":"identifier of storage bin","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}}}}}}},"components":{"schemas":{"erp-stock-StorageBin":{"description":"Lagerplatz","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"string","description":"Lager, in dem sich der Lagerplatz befindet"},"level1":{"type":"string","description":"Ebene1","maxLength":40,"minLength":0},"level2":{"type":"string","description":"Ebene2","maxLength":40,"minLength":0},"level3":{"type":"string","description":"Ebene3","maxLength":40,"minLength":0},"level4":{"type":"string","description":"Ebene4","maxLength":40,"minLength":0},"level5":{"type":"string","description":"Ebene5","maxLength":40,"minLength":0},"level6":{"type":"string","description":"Ebene6","maxLength":40,"minLength":0},"identifier":{"type":"string","description":"Barcode"},"displayName":{"type":"string","description":"Anzeigename"},"description":{"type":"string","description":"Beschreibung"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","default":"ACTIVE","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"comment":{"type":"string","description":"Kommentar"},"storageAreaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["displayName","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## DELETE /erp/storages/{id}/bins/{storageBinId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/bins/{storageBinId}":{"delete":{"tags":["Storage"],"operationId":"deleteStorageBin","parameters":[{"name":"id","in":"path","description":"identifier of storage","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"storageBinId","in":"path","description":"identifier of storage bin","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## PUT /erp/storages/{id}/bins/{binId}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/bins/{binId}/deactivate":{"put":{"tags":["Storage"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivateStorageBin","parameters":[{"name":"id","in":"path","description":"identifier of storage","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"binId","in":"path","description":"identifier of storage bin","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-StorageBin":{"description":"Lagerplatz","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"string","description":"Lager, in dem sich der Lagerplatz befindet"},"level1":{"type":"string","description":"Ebene1","maxLength":40,"minLength":0},"level2":{"type":"string","description":"Ebene2","maxLength":40,"minLength":0},"level3":{"type":"string","description":"Ebene3","maxLength":40,"minLength":0},"level4":{"type":"string","description":"Ebene4","maxLength":40,"minLength":0},"level5":{"type":"string","description":"Ebene5","maxLength":40,"minLength":0},"level6":{"type":"string","description":"Ebene6","maxLength":40,"minLength":0},"identifier":{"type":"string","description":"Barcode"},"displayName":{"type":"string","description":"Anzeigename"},"description":{"type":"string","description":"Beschreibung"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","default":"ACTIVE","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"comment":{"type":"string","description":"Kommentar"},"storageAreaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["displayName","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/storages/{id}/bins/{binId}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/bins/{binId}/activate":{"put":{"tags":["Storage"],"summary":"aktiviert eine bestehende Resource","operationId":"activateStorageBin","parameters":[{"name":"id","in":"path","description":"identifier of storage","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"binId","in":"path","description":"identifier of storage bin","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-StorageBin":{"description":"Lagerplatz","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"string","description":"Lager, in dem sich der Lagerplatz befindet"},"level1":{"type":"string","description":"Ebene1","maxLength":40,"minLength":0},"level2":{"type":"string","description":"Ebene2","maxLength":40,"minLength":0},"level3":{"type":"string","description":"Ebene3","maxLength":40,"minLength":0},"level4":{"type":"string","description":"Ebene4","maxLength":40,"minLength":0},"level5":{"type":"string","description":"Ebene5","maxLength":40,"minLength":0},"level6":{"type":"string","description":"Ebene6","maxLength":40,"minLength":0},"identifier":{"type":"string","description":"Barcode"},"displayName":{"type":"string","description":"Anzeigename"},"description":{"type":"string","description":"Beschreibung"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","default":"ACTIVE","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"comment":{"type":"string","description":"Kommentar"},"storageAreaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["displayName","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/storages/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/activate":{"put":{"tags":["Storage"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_5","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-Storage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-Storage":{"description":"Lager","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Ist das Lager aktiv?","readOnly":true},"number":{"type":"string","description":"Lager-Nr."},"displayName":{"type":"string","description":"Anzeigename"},"salesStorage":{"type":"boolean","default":false,"description":"Lieferlager?"},"purchaseOrderStorage":{"type":"boolean","default":false,"description":"Bestelllager?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll das Lager in die Summierung der Bestände/Verfügbarkeiten mit einbezogen werden?"},"returnOrderStorage":{"type":"boolean","default":false,"description":"Ziel-Lager für Retouren (z.B. aus Rechnungskorrektur mit WR)"},"pickingRequired":{"type":"boolean","default":false,"description":"Muss in diesem Lager kommissioniert werden?"},"withStorageBins":{"type":"boolean","default":false,"description":"Sollen in diesem Lager Lagerplätze verwendet werden"},"allowNegativeStock":{"type":"boolean","default":false,"description":"Darf in diesem Lager negativer Bestand gebucht werden"},"transit":{"type":"boolean","default":false,"description":"Ist es das Transitlager"},"identifier":{"type":"string","description":"Nur bei Lagern ohne Lagerplätze: Barcode (vom Standard-Lagerplatz)"},"onlyOneBatchPerStorageBin":{"type":"boolean","default":false,"description":"Nur eine Charge je Artikel pro Lagerplatz"},"supplyStorage":{"type":"boolean","default":false,"description":"Nachschublager"},"forFabricationComponents":{"type":"boolean","default":false,"description":"Material-Lager"},"defaultForFabricationComponents":{"type":"boolean","default":false,"description":"Standard-Material-Lager"},"fabricationWorkbenchStorage":{"type":"boolean","default":false,"description":"Produktion: Werkbank-Lager"},"fabricationQualityAssurance":{"type":"boolean","default":false,"description":"Produktion: QS-Lager"},"fabricationDefectiveStorage":{"type":"boolean","default":false,"description":"Produktion: Defekt-Lager"},"fabricationTargetStorage":{"type":"boolean","default":false,"description":"Produktion: Ziel-Lager"},"considerForOrderProposal":{"type":"boolean","default":false,"description":"Für Bestellvorschlag berücksichtigen"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/storages/rename-transit-storage > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/rename-transit-storage":{"put":{"tags":["Storage"],"operationId":"renameTransitStorage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageChangeNameAndNumberRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-Storage"}}}}}}}},"components":{"schemas":{"erp-stock-StorageChangeNameAndNumberRequest":{"properties":{"number":{"type":"string","description":"Nummer für das Lager"},"name":{"type":"string","description":"der Name für das Lager"}},"required":["number"]},"erp-stock-Storage":{"description":"Lager","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Ist das Lager aktiv?","readOnly":true},"number":{"type":"string","description":"Lager-Nr."},"displayName":{"type":"string","description":"Anzeigename"},"salesStorage":{"type":"boolean","default":false,"description":"Lieferlager?"},"purchaseOrderStorage":{"type":"boolean","default":false,"description":"Bestelllager?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll das Lager in die Summierung der Bestände/Verfügbarkeiten mit einbezogen werden?"},"returnOrderStorage":{"type":"boolean","default":false,"description":"Ziel-Lager für Retouren (z.B. aus Rechnungskorrektur mit WR)"},"pickingRequired":{"type":"boolean","default":false,"description":"Muss in diesem Lager kommissioniert werden?"},"withStorageBins":{"type":"boolean","default":false,"description":"Sollen in diesem Lager Lagerplätze verwendet werden"},"allowNegativeStock":{"type":"boolean","default":false,"description":"Darf in diesem Lager negativer Bestand gebucht werden"},"transit":{"type":"boolean","default":false,"description":"Ist es das Transitlager"},"identifier":{"type":"string","description":"Nur bei Lagern ohne Lagerplätze: Barcode (vom Standard-Lagerplatz)"},"onlyOneBatchPerStorageBin":{"type":"boolean","default":false,"description":"Nur eine Charge je Artikel pro Lagerplatz"},"supplyStorage":{"type":"boolean","default":false,"description":"Nachschublager"},"forFabricationComponents":{"type":"boolean","default":false,"description":"Material-Lager"},"defaultForFabricationComponents":{"type":"boolean","default":false,"description":"Standard-Material-Lager"},"fabricationWorkbenchStorage":{"type":"boolean","default":false,"description":"Produktion: Werkbank-Lager"},"fabricationQualityAssurance":{"type":"boolean","default":false,"description":"Produktion: QS-Lager"},"fabricationDefectiveStorage":{"type":"boolean","default":false,"description":"Produktion: Defekt-Lager"},"fabricationTargetStorage":{"type":"boolean","default":false,"description":"Produktion: Ziel-Lager"},"considerForOrderProposal":{"type":"boolean","default":false,"description":"Für Bestellvorschlag berücksichtigen"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## PUT /erp/storages/bins/print-labels > Führt dem Etikettendruck zu gegebenen Lagerplätzen durch ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/bins/print-labels":{"put":{"tags":["Storage"],"summary":"Führt dem Etikettendruck zu gegebenen Lagerplätzen durch","operationId":"printLabels","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBinLabelPrintRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"erp-stock-StorageBinLabelPrintRequest":{"description":"Request zur Durchführung des Etikettendrucks von Lagerplätzen","properties":{"variables":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"exportFilename":{"type":"string","description":"Dateiname des Ausdrucks"}}},"common-cunit-QueryPresetVariableSubstitutionList":{"description":"Werte von Variablen","properties":{"variableSubstitutions":{"type":"array","description":"Die Variablenbelegungen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitution"}}}},"common-cunit-QueryPresetVariableSubstitution":{"description":"Die Variablenbelegungen","properties":{"variable":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"},"values":{"type":"array","description":"Die einzusetzenden Werte","items":{"type":"string","description":"Die einzusetzenden Werte"}}}},"common-cunit-QueryPresetVariable":{"description":"Die zu ersetzende Variable","properties":{"path":{"type":"string","description":"Der pfad, der dieses Attribut eindeutig beschreibt"},"definition":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}],"readOnly":true},"mandatory":{"type":"boolean","description":"Ob die Variable ein Pflichtfeld ist oder nicht"},"variableName":{"type":"string","description":"Name der Variablen"},"visible":{"type":"boolean","default":true,"description":"Handelt es sich um eine sichtbare Variable?"},"alignX":{"type":"integer","format":"int32","description":"Anordnung im UI - X-Koordinate"},"alignY":{"type":"integer","format":"int32","description":"Anordnung im UI - Y-Koordinate"},"alignWidth":{"type":"integer","format":"int32","description":"Anordnung im UI - Breite"},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Eindeutiger Schlüssel zur Identifikation des Attributs"},"attribute":{"type":"string","description":"name des attributes der das ergebnis enthält"},"path":{"type":"string","description":"der pfad, der dieses attribut eindeutig beschreibt"},"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"parentDisplayName":{"type":"string","description":"der Name des Referenzierenden Feldes"},"resultable":{"type":"boolean","default":true,"description":"kann dieses Feld ein Ergebnisfeld sein"},"filterable":{"type":"boolean","default":true,"description":"kann nach diesem feld gefiltert werden"},"sortable":{"type":"boolean","default":true,"description":"ist dieses Feld sortierbar"},"visible":{"type":"boolean","default":true,"description":"soll dieses Feld angezeigt werden"},"functions":{"type":"array","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)","items":{"type":"string","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)"}},"sortDirection":{"type":"string","description":"Info, wie diese spalte sortiert worden ist"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"modelType":{"type":"string","description":"Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')","readOnly":true},"headers":{"type":"array","description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-MetaContent":{"description":"Definition dieser Variable","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]}}}},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"}}}]},"core-cunit-CuAttributeConstraint":{"description":"constraints für dieses Attribut","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"minimaler Wert","readOnly":true},"includeMinValue":{"type":"boolean","description":"ist der minimale Wert inklusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"maximaler Wert","readOnly":true},"includeMaxValue":{"type":"boolean","description":"ist der maximale Wert inklusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"ist der Wert 'null' verboten?","readOnly":true},"notBlank":{"type":"boolean","description":"Bei Strings: ist ein String nur aus Whitespace verboten?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximale Anzahl Nachkommastellen","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"data-type für dieses Attribut (falls dataTypeIdentifier leer ist)","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"welcher Typ ist es","readOnly":true},"objectRefIdentifier":{"type":"string","description":"bei Object_Ref: welcher Typ ist es genau","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"welche Funktionen sind erlaubt?","items":{"type":"string","description":"welche Funktionen sind erlaubt?"},"readOnly":true},"predicateOperations":{"type":"array","description":"welche Operations sind erlaubt?","items":{"type":"string","description":"welche Operations sind erlaubt?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit Attribut Filter Optionen","properties":{"filterValues":{"type":"array","description":"Mögliche Filterwerte","items":{"type":"string","description":"Mögliche Filterwerte"}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-cunit-CuAttribute.HeaderGroup":{"description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","properties":{"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Bedingungen zur Selektion von Lagerplätzen","properties":{"type":{"type":"string","description":"die Operation für diesen Filter","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"(bei junction) child-definitionen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"filter werte","items":{"type":"string","description":"filter werte"}},"visible":{"type":"boolean","default":true,"description":"Sichtbarkeit bei Variablen"},"functions":{"type":"array","description":"Eine SQL-Funktion, die im Predicate angewendet wird","items":{"type":"string","description":"Eine SQL-Funktion, die im Predicate angewendet wird"}}},"required":["operator","type"]}}}} ``` ## POST /erp/storages > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages":{"post":{"tags":["Storage"],"summary":"Create new Resource","operationId":"create_14","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-Storage"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-Storage"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-Storage":{"description":"Lager","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Ist das Lager aktiv?","readOnly":true},"number":{"type":"string","description":"Lager-Nr."},"displayName":{"type":"string","description":"Anzeigename"},"salesStorage":{"type":"boolean","default":false,"description":"Lieferlager?"},"purchaseOrderStorage":{"type":"boolean","default":false,"description":"Bestelllager?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll das Lager in die Summierung der Bestände/Verfügbarkeiten mit einbezogen werden?"},"returnOrderStorage":{"type":"boolean","default":false,"description":"Ziel-Lager für Retouren (z.B. aus Rechnungskorrektur mit WR)"},"pickingRequired":{"type":"boolean","default":false,"description":"Muss in diesem Lager kommissioniert werden?"},"withStorageBins":{"type":"boolean","default":false,"description":"Sollen in diesem Lager Lagerplätze verwendet werden"},"allowNegativeStock":{"type":"boolean","default":false,"description":"Darf in diesem Lager negativer Bestand gebucht werden"},"transit":{"type":"boolean","default":false,"description":"Ist es das Transitlager"},"identifier":{"type":"string","description":"Nur bei Lagern ohne Lagerplätze: Barcode (vom Standard-Lagerplatz)"},"onlyOneBatchPerStorageBin":{"type":"boolean","default":false,"description":"Nur eine Charge je Artikel pro Lagerplatz"},"supplyStorage":{"type":"boolean","default":false,"description":"Nachschublager"},"forFabricationComponents":{"type":"boolean","default":false,"description":"Material-Lager"},"defaultForFabricationComponents":{"type":"boolean","default":false,"description":"Standard-Material-Lager"},"fabricationWorkbenchStorage":{"type":"boolean","default":false,"description":"Produktion: Werkbank-Lager"},"fabricationQualityAssurance":{"type":"boolean","default":false,"description":"Produktion: QS-Lager"},"fabricationDefectiveStorage":{"type":"boolean","default":false,"description":"Produktion: Defekt-Lager"},"fabricationTargetStorage":{"type":"boolean","default":false,"description":"Produktion: Ziel-Lager"},"considerForOrderProposal":{"type":"boolean","default":false,"description":"Für Bestellvorschlag berücksichtigen"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/storages/{id}/bins > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/bins":{"get":{"tags":["Storage"],"operationId":"getBins","parameters":[{"name":"id","in":"path","description":"identifier of storage","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}}}}}}}},"components":{"schemas":{"erp-stock-StorageBin":{"description":"Lagerplatz","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"string","description":"Lager, in dem sich der Lagerplatz befindet"},"level1":{"type":"string","description":"Ebene1","maxLength":40,"minLength":0},"level2":{"type":"string","description":"Ebene2","maxLength":40,"minLength":0},"level3":{"type":"string","description":"Ebene3","maxLength":40,"minLength":0},"level4":{"type":"string","description":"Ebene4","maxLength":40,"minLength":0},"level5":{"type":"string","description":"Ebene5","maxLength":40,"minLength":0},"level6":{"type":"string","description":"Ebene6","maxLength":40,"minLength":0},"identifier":{"type":"string","description":"Barcode"},"displayName":{"type":"string","description":"Anzeigename"},"description":{"type":"string","description":"Beschreibung"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","default":"ACTIVE","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"comment":{"type":"string","description":"Kommentar"},"storageAreaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["displayName","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## POST /erp/storages/{id}/bins > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/bins":{"post":{"tags":["Storage"],"operationId":"createStorageBin","parameters":[{"name":"id","in":"path","description":"identifier of storage","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}}}}}}},"components":{"schemas":{"erp-stock-StorageBin":{"description":"Lagerplatz","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"string","description":"Lager, in dem sich der Lagerplatz befindet"},"level1":{"type":"string","description":"Ebene1","maxLength":40,"minLength":0},"level2":{"type":"string","description":"Ebene2","maxLength":40,"minLength":0},"level3":{"type":"string","description":"Ebene3","maxLength":40,"minLength":0},"level4":{"type":"string","description":"Ebene4","maxLength":40,"minLength":0},"level5":{"type":"string","description":"Ebene5","maxLength":40,"minLength":0},"level6":{"type":"string","description":"Ebene6","maxLength":40,"minLength":0},"identifier":{"type":"string","description":"Barcode"},"displayName":{"type":"string","description":"Anzeigename"},"description":{"type":"string","description":"Beschreibung"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","default":"ACTIVE","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"comment":{"type":"string","description":"Kommentar"},"storageAreaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["displayName","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## POST /erp/storages/{id}/bins/generate > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/bins/generate":{"post":{"tags":["Storage"],"operationId":"generateStorageBins","parameters":[{"name":"id","in":"path","description":"identifier of storage","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"erp-stock-StorageBinGenerateRequest":{"description":"Infos zur Generierung von Lagerplätzen","properties":{"storageId":{"type":"integer","format":"int64","description":"ID des Lagers, für das die Lagerplätze generiert werden sollen"},"storageAreaId":{"type":"integer","format":"int64","description":"Lagerbereich, zu dem dieser Lagerplatz gehört"},"numOfLevels":{"type":"integer","format":"int32","description":"Anzahl der Ebenen","maximum":6,"minimum":1},"rangeLevel1":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel2":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel3":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel4":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel5":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel6":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"generateUniqueIdentifier":{"type":"boolean","default":false,"description":"Sollen eindeutige Identifier für die Lagerplätze generiert werden"},"startOfRoutePosition":{"type":"integer","format":"int32","description":"Start der Laufwegposition für diese generierten Lagerplätze"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"separator":{"type":"string","description":"Trenner","pattern":"^[-/_\\\\| ]+$"}},"required":["numOfLevels"]},"erp-stock-StorageBinGenerateRequest.LevelRange":{"description":"Bereich für eine Ebene","properties":{"from":{"type":"string"},"to":{"type":"string"}}},"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## POST /erp/storages/{id}/bins/generate-count > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/bins/generate-count":{"post":{"tags":["Storage"],"operationId":"generateStorageBinsCount","parameters":[{"name":"id","in":"path","description":"identifier of storage","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"integer","format":"int64"}}}}}}}},"components":{"schemas":{"erp-stock-StorageBinGenerateRequest":{"description":"Infos zur Generierung von Lagerplätzen","properties":{"storageId":{"type":"integer","format":"int64","description":"ID des Lagers, für das die Lagerplätze generiert werden sollen"},"storageAreaId":{"type":"integer","format":"int64","description":"Lagerbereich, zu dem dieser Lagerplatz gehört"},"numOfLevels":{"type":"integer","format":"int32","description":"Anzahl der Ebenen","maximum":6,"minimum":1},"rangeLevel1":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel2":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel3":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel4":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel5":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"rangeLevel6":{"$ref":"#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange"},"generateUniqueIdentifier":{"type":"boolean","default":false,"description":"Sollen eindeutige Identifier für die Lagerplätze generiert werden"},"startOfRoutePosition":{"type":"integer","format":"int32","description":"Start der Laufwegposition für diese generierten Lagerplätze"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"separator":{"type":"string","description":"Trenner","pattern":"^[-/_\\\\| ]+$"}},"required":["numOfLevels"]},"erp-stock-StorageBinGenerateRequest.LevelRange":{"description":"Bereich für eine Ebene","properties":{"from":{"type":"string"},"to":{"type":"string"}}}}}} ``` ## POST /erp/storages/bins > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/bins":{"post":{"tags":["Storage"],"operationId":"queryBins","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}}}}}}}},"components":{"schemas":{"erp-stock-StorageBinSelectionApi":{"description":"Selektionskriterien zur Ermittlung von Lagerplätzen","properties":{"pageable":{"$ref":"#/components/schemas/core-api-QueryPageableApi"},"storageId":{"type":"integer","format":"int64","description":"Lager zu dem ein Lagerplatz gehört"},"storageAreaId":{"type":"integer","format":"int64","description":"Lagerbereich zu dem ein Lagerplatz gehört"},"onlyWithoutStorageArea":{"type":"boolean","default":false,"description":"Nur Lagerplätze ohne Lagerbereich"},"defaultBin":{"type":"boolean","default":false,"description":"Standard-Lagerplatz eines Lagers (nur relevant für Lager ohne Lagerplätze"},"level1":{"type":"string","description":"Ebene1"},"level2":{"type":"string","description":"Ebene2"},"level3":{"type":"string","description":"Ebene3"},"level4":{"type":"string","description":"Ebene4"},"level5":{"type":"string","description":"Ebene5"},"level6":{"type":"string","description":"Ebene6"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"},"heightInCM":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"},"widthInCM":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"},"depthInCM":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"}}},"core-api-QueryPageableApi":{"description":"Paging","properties":{"sort":{"type":"string","description":"Liste an Feldern zur Sortierung (komma-getrennt)"},"_start":{"type":"integer","format":"int32","description":"Start-Offset"},"_limit":{"type":"integer","format":"int32","description":"Ergebnis-Limit"},"_order":{"type":"string","description":"Sortierart der Felder (asc/desc, Liste, komma-getrennt)"}}},"erp-stock-StorageBinSelectionApi.Range":{"description":"Selektionsbereich von/bis","properties":{"from":{"type":"number"},"to":{"type":"number"}}},"erp-stock-StorageBin":{"description":"Lagerplatz","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"string","description":"Lager, in dem sich der Lagerplatz befindet"},"level1":{"type":"string","description":"Ebene1","maxLength":40,"minLength":0},"level2":{"type":"string","description":"Ebene2","maxLength":40,"minLength":0},"level3":{"type":"string","description":"Ebene3","maxLength":40,"minLength":0},"level4":{"type":"string","description":"Ebene4","maxLength":40,"minLength":0},"level5":{"type":"string","description":"Ebene5","maxLength":40,"minLength":0},"level6":{"type":"string","description":"Ebene6","maxLength":40,"minLength":0},"identifier":{"type":"string","description":"Barcode"},"displayName":{"type":"string","description":"Anzeigename"},"description":{"type":"string","description":"Beschreibung"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","default":"ACTIVE","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"comment":{"type":"string","description":"Kommentar"},"storageAreaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["displayName","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/storages/{id}/bins/{binId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Storage","description":"Lager"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storages/{id}/bins/{binId}":{"get":{"tags":["Storage"],"operationId":"getStorageBin","parameters":[{"name":"id","in":"path","description":"identifier of storage","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"binId","in":"path","description":"identifier of storage bin","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}}}}}}},"components":{"schemas":{"erp-stock-StorageBin":{"description":"Lagerplatz","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"string","description":"Lager, in dem sich der Lagerplatz befindet"},"level1":{"type":"string","description":"Ebene1","maxLength":40,"minLength":0},"level2":{"type":"string","description":"Ebene2","maxLength":40,"minLength":0},"level3":{"type":"string","description":"Ebene3","maxLength":40,"minLength":0},"level4":{"type":"string","description":"Ebene4","maxLength":40,"minLength":0},"level5":{"type":"string","description":"Ebene5","maxLength":40,"minLength":0},"level6":{"type":"string","description":"Ebene6","maxLength":40,"minLength":0},"identifier":{"type":"string","description":"Barcode"},"displayName":{"type":"string","description":"Anzeigename"},"description":{"type":"string","description":"Beschreibung"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","default":"ACTIVE","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"comment":{"type":"string","description":"Kommentar"},"storageAreaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["displayName","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` # Picklisten Vorlagen Picklisten-Vorlagen ## GET /wms/picklist-templates/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Picklisten-Vorlagen","description":"Picklisten-Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/wms/picklist-templates/{id}":{"get":{"tags":["Picklisten-Vorlagen"],"summary":"Find an existing Resource by identifier","operationId":"getById_5","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-wms-PicklistTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"picklistCreationOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistCreationOptions"},"orderSelectionOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.OrderSelectionOptions"},"picklistProcessingOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistProcessingOptions"},"label":{"type":"string","description":"Name der Vorlage"},"description":{"type":"string","description":"Beschreibung der Vorlage"},"pickingType":{"type":"string","description":"Art der Kommissionierung","enum":["FAST_ORDER_PICKING","SINGLE_ORDER_PICKING","COLLECTIVE_ORDER_PICKING","ROLLING_ORDER_PICKING","CONSOLIDATION","REPLENISHMENT","FABRICATION","MISSING_GOODS_PICKING","INCORRECTLY_PICKED_GOODS"]},"defaultTemplate":{"type":"boolean","default":false,"description":"Handelt es sich um eine Standard-Vorlage?"},"active":{"type":"boolean","default":true,"description":"Is Template active?","readOnly":true},"picklistScripts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistScript"},"description":"Skripte für die Erstellung und Verarbeitung von Picklisten"}},"required":["label","pickingType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-wms-PicklistTemplate.PicklistCreationOptions":{"description":"Optionen zur Erstellung von Picklisten","properties":{"sortByRoutePosition":{"type":"boolean","default":true,"description":"Positionen der Pickliste nach Laufwegposition sortieren"},"maxPicklistLineCount":{"type":"integer","format":"int64","description":"Maximale Anzahl an Positionen einer Pickliste"},"maxQuantityOfOrderLineForFastOrderPicking":{"type":"integer","format":"int64","default":1,"description":"Maximale Menge einer Auftragsposition für Schnellkommissionierungs-Picklisten"},"orderPickingTrolleyRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderPickingTrolleyGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"useAllAvailOrderPickingTrolleys":{"type":"boolean","default":false,"description":"Sollen alle verfügbaren Pickwagen verwendet werden?"},"cycleToCreatePicklistsCronExpression":{"type":"string","description":"Zyklus zur Erstellung von Picklisten (für Background-Jobs, als Quartz-Cron-Expression) (https://www.freeformatter.com/cron-expression-generator-quartz.html)"},"specifyStorageBins":{"type":"boolean","default":true,"description":"Lagerplätze vorgeben"},"specifySerialWithOldestExpiryDate":{"type":"boolean","default":false,"description":"Für Serien-Artikel mit Verfallsdatum/MHD: älteste Serie in Pickliste vorgeben"},"firstCreateFastOrderPickingPicklists":{"type":"boolean","default":false,"description":"Sollen zuerst noch Picklisten für die Schnellkommissionierung erzeugt werden?"},"fastOrderPickingTemplateToUseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printPicklist":{"type":"boolean","default":false,"description":"Soll die Pickliste gedruckt werden?"},"picklistOutputReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printLabelsOnCreation":{"type":"boolean","default":false,"description":"Soll nach der Erstellung automatisch die Etiketten gedruckt werden?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-wms-PicklistTemplate.OrderSelectionOptions":{"description":"Optionen zur Selektion von Aufträgen","properties":{"maxOrderCount":{"type":"integer","format":"int64","description":"Nur für Einzelkommissionierung und Konsolidierung: maximale Anzahl zu übernehmender Aufträge"},"alternativeSelectionInVql":{"type":"string","description":"Alternative Selektion in VQL"},"additionalExistsStatementsInVql":{"type":"array","description":"Zusätzliche Exists-Statements in VQL","items":{"type":"string","description":"Zusätzliche Exists-Statements in VQL"}},"deliveryMethodRefs":{"type":"array","description":"Liste der gültigen Lieferarten","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentTypeRefs":{"type":"array","description":"Liste der Belegarten vom Belegtyp \"Auftrag\"","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"deliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"confirmedDeliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"onlyFullDeliverableOrders":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Aufträge"},"onlyFullDeliverableOrderLines":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Positionen"},"storageAreaRefs":{"type":"array","description":"Liste von gültigen Lagerbereichen","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelId":{"type":"integer","format":"int64","description":"Id des salesChannels der bei der Selektion berücksichtigt wird"},"minArticleCountPerOrder":{"type":"integer","format":"int32","description":"Minimale Anzahl Artikel pro Auftrag"},"maxArticleCountPerOrder":{"type":"integer","format":"int32","description":"Maximale Anzahl Artikel pro Auftrag"},"maxShippingWeightPerOrder":{"type":"number","description":"Maximales Versandgewicht pro Auftrag"},"maxTotalVolumePerOrderInCCM":{"type":"number","description":"Maximales Gesamtvolumen pro Auftrag (in ccm)"},"maxOrderValue":{"type":"number","description":"Maximaler Auftragswert"}}},"erp-wms-PicklistTemplate.DateRange":{"description":"Selektion über einen Datumsbereich","properties":{"from":{"type":"string","description":"Datum von (ggf. als relatives Datum)"},"to":{"type":"string","description":"Datum bis (ggf. als relatives Datum)"},"allowEmpty":{"type":"boolean","default":true,"description":"Datumsbereich darf leer sein"}}},"erp-wms-PicklistTemplate.PicklistProcessingOptions":{"description":"Optionen für die Verarbeitung von Picklisten","properties":{"autoPrintDeliveryDocument":{"type":"boolean","default":false,"description":"Soll die Lieferbelege automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"autoPrintShippingLabel":{"type":"boolean","default":false,"description":"Sollen die Paketlabel automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"allowOnlyScanOfArticles":{"type":"boolean","default":false,"description":"Dürfen Artikel nur per Scan (oder z.B. auch Eingabe der Artikelnummer) erfasst werden"},"autoDeterminationOfLots":{"type":"boolean","default":false,"description":"Chargen automatisch bestätigen, wenn sie vorgegeben oder bereits beim Picken erfasst wurden"},"hideTargetQuantityInViews":{"type":"boolean","default":false,"description":"Zielmengen in Masken verstecken?"},"allowPickingOfServiceArticles":{"type":"boolean","default":false,"description":"Sollen Dienstleistungen kommissioniert werden?"},"allowPickingOfNonInventoryManagedArticles":{"type":"boolean","default":false,"description":"Sollen nicht-bestandsgeführte Artikel kommissioniert werden?"},"allowFullConfirmation":{"type":"boolean","default":false,"description":"Sammelbestätigung erlauben"},"deviatingQuantity":{"type":"string","description":"Kommissionierung von abweichenden Mengen","enum":["ALLOW_ONLY_ORDERED_QUANTITY","ALLOW_MINOR_QUANTITY","ALLOW_OVER_DELIVERY","ALLOW_DEVIATING_QUANTITY"]},"assemblyGroupAtOnce":{"type":"boolean","default":false,"description":"Baugruppen als Ganzes kommissionieren"},"alwaysShowDeliveryMethod":{"type":"boolean","default":true,"description":"Immer die Lieferbedingung in Masken zeigen"},"showShippingFormOnPickingFinish":{"type":"boolean","default":false,"description":"Versand-Dialog beim Abschluss zeigen"},"autoPickingFinishAfterLastArticleInOrder":{"type":"boolean","default":false,"description":"Automatischer Abschluss nach letztem Artikel vom aktuellen Auftrag"},"useDigitalPicklist":{"type":"boolean","default":false,"description":"Digitale Pickliste verwenden: dabei werden nur die Positionen im Frontend gezeigt und durch Tippen oder Wischen bestätigt"},"usePickNPack":{"type":"boolean","default":false,"description":"Pick'n'Pack verwenden"},"scanDeliveryDocumentAndShippingLabelOnFinish":{"type":"boolean","default":false,"description":"Nur für Konsolidierung: Lieferbeleg und Versandlabel zum Abschluss scannen"},"scanPickTrolleyBoxToConfirmPickedArticle":{"type":"boolean","default":false,"description":"Rollende Kommissionierung/Konsolidierung: beim Sammeln muss die Box nach dem Scan eines Artikels per Scan bestätigt werden"},"blockIfMaximumPackageWeightIsExceeded":{"type":"boolean","default":true,"description":"Überschreitung vom maximalen Paketgewicht blockieren?"},"useSalesUnit":{"type":"boolean","default":false,"description":"Verwende die Verkaufseinheit als Standardmenge"},"printLabelOnScan":{"type":"boolean","default":false,"description":"Sollen bei der Erfassung automatisch die Etiketten gedruckt werden?"},"printLabelOnCompleteOrder":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des Auftrages automatisch die Etiketten gedruckt werden?"},"printLabelAfterPicking":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des des Pickens automatisch die Etiketten gedruckt werden?"}}},"erp-wms-PicklistTemplate.PicklistScript":{"description":"Ein Picklisten-Skript","properties":{"source":{"type":"string","description":"Der Quelltext vom Skript"},"active":{"type":"boolean","default":false,"description":"Ist das Skript aktiv?"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /wms/picklist-templates/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Picklisten-Vorlagen","description":"Picklisten-Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/wms/picklist-templates/{id}":{"put":{"tags":["Picklisten-Vorlagen"],"summary":"Update existing Resource ","operationId":"update_4","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-wms-PicklistTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"picklistCreationOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistCreationOptions"},"orderSelectionOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.OrderSelectionOptions"},"picklistProcessingOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistProcessingOptions"},"label":{"type":"string","description":"Name der Vorlage"},"description":{"type":"string","description":"Beschreibung der Vorlage"},"pickingType":{"type":"string","description":"Art der Kommissionierung","enum":["FAST_ORDER_PICKING","SINGLE_ORDER_PICKING","COLLECTIVE_ORDER_PICKING","ROLLING_ORDER_PICKING","CONSOLIDATION","REPLENISHMENT","FABRICATION","MISSING_GOODS_PICKING","INCORRECTLY_PICKED_GOODS"]},"defaultTemplate":{"type":"boolean","default":false,"description":"Handelt es sich um eine Standard-Vorlage?"},"active":{"type":"boolean","default":true,"description":"Is Template active?","readOnly":true},"picklistScripts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistScript"},"description":"Skripte für die Erstellung und Verarbeitung von Picklisten"}},"required":["label","pickingType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-wms-PicklistTemplate.PicklistCreationOptions":{"description":"Optionen zur Erstellung von Picklisten","properties":{"sortByRoutePosition":{"type":"boolean","default":true,"description":"Positionen der Pickliste nach Laufwegposition sortieren"},"maxPicklistLineCount":{"type":"integer","format":"int64","description":"Maximale Anzahl an Positionen einer Pickliste"},"maxQuantityOfOrderLineForFastOrderPicking":{"type":"integer","format":"int64","default":1,"description":"Maximale Menge einer Auftragsposition für Schnellkommissionierungs-Picklisten"},"orderPickingTrolleyRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderPickingTrolleyGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"useAllAvailOrderPickingTrolleys":{"type":"boolean","default":false,"description":"Sollen alle verfügbaren Pickwagen verwendet werden?"},"cycleToCreatePicklistsCronExpression":{"type":"string","description":"Zyklus zur Erstellung von Picklisten (für Background-Jobs, als Quartz-Cron-Expression) (https://www.freeformatter.com/cron-expression-generator-quartz.html)"},"specifyStorageBins":{"type":"boolean","default":true,"description":"Lagerplätze vorgeben"},"specifySerialWithOldestExpiryDate":{"type":"boolean","default":false,"description":"Für Serien-Artikel mit Verfallsdatum/MHD: älteste Serie in Pickliste vorgeben"},"firstCreateFastOrderPickingPicklists":{"type":"boolean","default":false,"description":"Sollen zuerst noch Picklisten für die Schnellkommissionierung erzeugt werden?"},"fastOrderPickingTemplateToUseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printPicklist":{"type":"boolean","default":false,"description":"Soll die Pickliste gedruckt werden?"},"picklistOutputReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printLabelsOnCreation":{"type":"boolean","default":false,"description":"Soll nach der Erstellung automatisch die Etiketten gedruckt werden?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-wms-PicklistTemplate.OrderSelectionOptions":{"description":"Optionen zur Selektion von Aufträgen","properties":{"maxOrderCount":{"type":"integer","format":"int64","description":"Nur für Einzelkommissionierung und Konsolidierung: maximale Anzahl zu übernehmender Aufträge"},"alternativeSelectionInVql":{"type":"string","description":"Alternative Selektion in VQL"},"additionalExistsStatementsInVql":{"type":"array","description":"Zusätzliche Exists-Statements in VQL","items":{"type":"string","description":"Zusätzliche Exists-Statements in VQL"}},"deliveryMethodRefs":{"type":"array","description":"Liste der gültigen Lieferarten","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentTypeRefs":{"type":"array","description":"Liste der Belegarten vom Belegtyp \"Auftrag\"","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"deliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"confirmedDeliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"onlyFullDeliverableOrders":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Aufträge"},"onlyFullDeliverableOrderLines":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Positionen"},"storageAreaRefs":{"type":"array","description":"Liste von gültigen Lagerbereichen","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelId":{"type":"integer","format":"int64","description":"Id des salesChannels der bei der Selektion berücksichtigt wird"},"minArticleCountPerOrder":{"type":"integer","format":"int32","description":"Minimale Anzahl Artikel pro Auftrag"},"maxArticleCountPerOrder":{"type":"integer","format":"int32","description":"Maximale Anzahl Artikel pro Auftrag"},"maxShippingWeightPerOrder":{"type":"number","description":"Maximales Versandgewicht pro Auftrag"},"maxTotalVolumePerOrderInCCM":{"type":"number","description":"Maximales Gesamtvolumen pro Auftrag (in ccm)"},"maxOrderValue":{"type":"number","description":"Maximaler Auftragswert"}}},"erp-wms-PicklistTemplate.DateRange":{"description":"Selektion über einen Datumsbereich","properties":{"from":{"type":"string","description":"Datum von (ggf. als relatives Datum)"},"to":{"type":"string","description":"Datum bis (ggf. als relatives Datum)"},"allowEmpty":{"type":"boolean","default":true,"description":"Datumsbereich darf leer sein"}}},"erp-wms-PicklistTemplate.PicklistProcessingOptions":{"description":"Optionen für die Verarbeitung von Picklisten","properties":{"autoPrintDeliveryDocument":{"type":"boolean","default":false,"description":"Soll die Lieferbelege automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"autoPrintShippingLabel":{"type":"boolean","default":false,"description":"Sollen die Paketlabel automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"allowOnlyScanOfArticles":{"type":"boolean","default":false,"description":"Dürfen Artikel nur per Scan (oder z.B. auch Eingabe der Artikelnummer) erfasst werden"},"autoDeterminationOfLots":{"type":"boolean","default":false,"description":"Chargen automatisch bestätigen, wenn sie vorgegeben oder bereits beim Picken erfasst wurden"},"hideTargetQuantityInViews":{"type":"boolean","default":false,"description":"Zielmengen in Masken verstecken?"},"allowPickingOfServiceArticles":{"type":"boolean","default":false,"description":"Sollen Dienstleistungen kommissioniert werden?"},"allowPickingOfNonInventoryManagedArticles":{"type":"boolean","default":false,"description":"Sollen nicht-bestandsgeführte Artikel kommissioniert werden?"},"allowFullConfirmation":{"type":"boolean","default":false,"description":"Sammelbestätigung erlauben"},"deviatingQuantity":{"type":"string","description":"Kommissionierung von abweichenden Mengen","enum":["ALLOW_ONLY_ORDERED_QUANTITY","ALLOW_MINOR_QUANTITY","ALLOW_OVER_DELIVERY","ALLOW_DEVIATING_QUANTITY"]},"assemblyGroupAtOnce":{"type":"boolean","default":false,"description":"Baugruppen als Ganzes kommissionieren"},"alwaysShowDeliveryMethod":{"type":"boolean","default":true,"description":"Immer die Lieferbedingung in Masken zeigen"},"showShippingFormOnPickingFinish":{"type":"boolean","default":false,"description":"Versand-Dialog beim Abschluss zeigen"},"autoPickingFinishAfterLastArticleInOrder":{"type":"boolean","default":false,"description":"Automatischer Abschluss nach letztem Artikel vom aktuellen Auftrag"},"useDigitalPicklist":{"type":"boolean","default":false,"description":"Digitale Pickliste verwenden: dabei werden nur die Positionen im Frontend gezeigt und durch Tippen oder Wischen bestätigt"},"usePickNPack":{"type":"boolean","default":false,"description":"Pick'n'Pack verwenden"},"scanDeliveryDocumentAndShippingLabelOnFinish":{"type":"boolean","default":false,"description":"Nur für Konsolidierung: Lieferbeleg und Versandlabel zum Abschluss scannen"},"scanPickTrolleyBoxToConfirmPickedArticle":{"type":"boolean","default":false,"description":"Rollende Kommissionierung/Konsolidierung: beim Sammeln muss die Box nach dem Scan eines Artikels per Scan bestätigt werden"},"blockIfMaximumPackageWeightIsExceeded":{"type":"boolean","default":true,"description":"Überschreitung vom maximalen Paketgewicht blockieren?"},"useSalesUnit":{"type":"boolean","default":false,"description":"Verwende die Verkaufseinheit als Standardmenge"},"printLabelOnScan":{"type":"boolean","default":false,"description":"Sollen bei der Erfassung automatisch die Etiketten gedruckt werden?"},"printLabelOnCompleteOrder":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des Auftrages automatisch die Etiketten gedruckt werden?"},"printLabelAfterPicking":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des des Pickens automatisch die Etiketten gedruckt werden?"}}},"erp-wms-PicklistTemplate.PicklistScript":{"description":"Ein Picklisten-Skript","properties":{"source":{"type":"string","description":"Der Quelltext vom Skript"},"active":{"type":"boolean","default":false,"description":"Ist das Skript aktiv?"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /wms/picklist-templates/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Picklisten-Vorlagen","description":"Picklisten-Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/wms/picklist-templates/{id}":{"delete":{"tags":["Picklisten-Vorlagen"],"summary":"Delete an existing Resource","operationId":"delete_4","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /wms/picklist-templates/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Picklisten-Vorlagen","description":"Picklisten-Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/wms/picklist-templates/{id}/deactivate":{"put":{"tags":["Picklisten-Vorlagen"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_1","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-wms-PicklistTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"picklistCreationOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistCreationOptions"},"orderSelectionOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.OrderSelectionOptions"},"picklistProcessingOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistProcessingOptions"},"label":{"type":"string","description":"Name der Vorlage"},"description":{"type":"string","description":"Beschreibung der Vorlage"},"pickingType":{"type":"string","description":"Art der Kommissionierung","enum":["FAST_ORDER_PICKING","SINGLE_ORDER_PICKING","COLLECTIVE_ORDER_PICKING","ROLLING_ORDER_PICKING","CONSOLIDATION","REPLENISHMENT","FABRICATION","MISSING_GOODS_PICKING","INCORRECTLY_PICKED_GOODS"]},"defaultTemplate":{"type":"boolean","default":false,"description":"Handelt es sich um eine Standard-Vorlage?"},"active":{"type":"boolean","default":true,"description":"Is Template active?","readOnly":true},"picklistScripts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistScript"},"description":"Skripte für die Erstellung und Verarbeitung von Picklisten"}},"required":["label","pickingType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-wms-PicklistTemplate.PicklistCreationOptions":{"description":"Optionen zur Erstellung von Picklisten","properties":{"sortByRoutePosition":{"type":"boolean","default":true,"description":"Positionen der Pickliste nach Laufwegposition sortieren"},"maxPicklistLineCount":{"type":"integer","format":"int64","description":"Maximale Anzahl an Positionen einer Pickliste"},"maxQuantityOfOrderLineForFastOrderPicking":{"type":"integer","format":"int64","default":1,"description":"Maximale Menge einer Auftragsposition für Schnellkommissionierungs-Picklisten"},"orderPickingTrolleyRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderPickingTrolleyGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"useAllAvailOrderPickingTrolleys":{"type":"boolean","default":false,"description":"Sollen alle verfügbaren Pickwagen verwendet werden?"},"cycleToCreatePicklistsCronExpression":{"type":"string","description":"Zyklus zur Erstellung von Picklisten (für Background-Jobs, als Quartz-Cron-Expression) (https://www.freeformatter.com/cron-expression-generator-quartz.html)"},"specifyStorageBins":{"type":"boolean","default":true,"description":"Lagerplätze vorgeben"},"specifySerialWithOldestExpiryDate":{"type":"boolean","default":false,"description":"Für Serien-Artikel mit Verfallsdatum/MHD: älteste Serie in Pickliste vorgeben"},"firstCreateFastOrderPickingPicklists":{"type":"boolean","default":false,"description":"Sollen zuerst noch Picklisten für die Schnellkommissionierung erzeugt werden?"},"fastOrderPickingTemplateToUseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printPicklist":{"type":"boolean","default":false,"description":"Soll die Pickliste gedruckt werden?"},"picklistOutputReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printLabelsOnCreation":{"type":"boolean","default":false,"description":"Soll nach der Erstellung automatisch die Etiketten gedruckt werden?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-wms-PicklistTemplate.OrderSelectionOptions":{"description":"Optionen zur Selektion von Aufträgen","properties":{"maxOrderCount":{"type":"integer","format":"int64","description":"Nur für Einzelkommissionierung und Konsolidierung: maximale Anzahl zu übernehmender Aufträge"},"alternativeSelectionInVql":{"type":"string","description":"Alternative Selektion in VQL"},"additionalExistsStatementsInVql":{"type":"array","description":"Zusätzliche Exists-Statements in VQL","items":{"type":"string","description":"Zusätzliche Exists-Statements in VQL"}},"deliveryMethodRefs":{"type":"array","description":"Liste der gültigen Lieferarten","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentTypeRefs":{"type":"array","description":"Liste der Belegarten vom Belegtyp \"Auftrag\"","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"deliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"confirmedDeliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"onlyFullDeliverableOrders":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Aufträge"},"onlyFullDeliverableOrderLines":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Positionen"},"storageAreaRefs":{"type":"array","description":"Liste von gültigen Lagerbereichen","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelId":{"type":"integer","format":"int64","description":"Id des salesChannels der bei der Selektion berücksichtigt wird"},"minArticleCountPerOrder":{"type":"integer","format":"int32","description":"Minimale Anzahl Artikel pro Auftrag"},"maxArticleCountPerOrder":{"type":"integer","format":"int32","description":"Maximale Anzahl Artikel pro Auftrag"},"maxShippingWeightPerOrder":{"type":"number","description":"Maximales Versandgewicht pro Auftrag"},"maxTotalVolumePerOrderInCCM":{"type":"number","description":"Maximales Gesamtvolumen pro Auftrag (in ccm)"},"maxOrderValue":{"type":"number","description":"Maximaler Auftragswert"}}},"erp-wms-PicklistTemplate.DateRange":{"description":"Selektion über einen Datumsbereich","properties":{"from":{"type":"string","description":"Datum von (ggf. als relatives Datum)"},"to":{"type":"string","description":"Datum bis (ggf. als relatives Datum)"},"allowEmpty":{"type":"boolean","default":true,"description":"Datumsbereich darf leer sein"}}},"erp-wms-PicklistTemplate.PicklistProcessingOptions":{"description":"Optionen für die Verarbeitung von Picklisten","properties":{"autoPrintDeliveryDocument":{"type":"boolean","default":false,"description":"Soll die Lieferbelege automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"autoPrintShippingLabel":{"type":"boolean","default":false,"description":"Sollen die Paketlabel automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"allowOnlyScanOfArticles":{"type":"boolean","default":false,"description":"Dürfen Artikel nur per Scan (oder z.B. auch Eingabe der Artikelnummer) erfasst werden"},"autoDeterminationOfLots":{"type":"boolean","default":false,"description":"Chargen automatisch bestätigen, wenn sie vorgegeben oder bereits beim Picken erfasst wurden"},"hideTargetQuantityInViews":{"type":"boolean","default":false,"description":"Zielmengen in Masken verstecken?"},"allowPickingOfServiceArticles":{"type":"boolean","default":false,"description":"Sollen Dienstleistungen kommissioniert werden?"},"allowPickingOfNonInventoryManagedArticles":{"type":"boolean","default":false,"description":"Sollen nicht-bestandsgeführte Artikel kommissioniert werden?"},"allowFullConfirmation":{"type":"boolean","default":false,"description":"Sammelbestätigung erlauben"},"deviatingQuantity":{"type":"string","description":"Kommissionierung von abweichenden Mengen","enum":["ALLOW_ONLY_ORDERED_QUANTITY","ALLOW_MINOR_QUANTITY","ALLOW_OVER_DELIVERY","ALLOW_DEVIATING_QUANTITY"]},"assemblyGroupAtOnce":{"type":"boolean","default":false,"description":"Baugruppen als Ganzes kommissionieren"},"alwaysShowDeliveryMethod":{"type":"boolean","default":true,"description":"Immer die Lieferbedingung in Masken zeigen"},"showShippingFormOnPickingFinish":{"type":"boolean","default":false,"description":"Versand-Dialog beim Abschluss zeigen"},"autoPickingFinishAfterLastArticleInOrder":{"type":"boolean","default":false,"description":"Automatischer Abschluss nach letztem Artikel vom aktuellen Auftrag"},"useDigitalPicklist":{"type":"boolean","default":false,"description":"Digitale Pickliste verwenden: dabei werden nur die Positionen im Frontend gezeigt und durch Tippen oder Wischen bestätigt"},"usePickNPack":{"type":"boolean","default":false,"description":"Pick'n'Pack verwenden"},"scanDeliveryDocumentAndShippingLabelOnFinish":{"type":"boolean","default":false,"description":"Nur für Konsolidierung: Lieferbeleg und Versandlabel zum Abschluss scannen"},"scanPickTrolleyBoxToConfirmPickedArticle":{"type":"boolean","default":false,"description":"Rollende Kommissionierung/Konsolidierung: beim Sammeln muss die Box nach dem Scan eines Artikels per Scan bestätigt werden"},"blockIfMaximumPackageWeightIsExceeded":{"type":"boolean","default":true,"description":"Überschreitung vom maximalen Paketgewicht blockieren?"},"useSalesUnit":{"type":"boolean","default":false,"description":"Verwende die Verkaufseinheit als Standardmenge"},"printLabelOnScan":{"type":"boolean","default":false,"description":"Sollen bei der Erfassung automatisch die Etiketten gedruckt werden?"},"printLabelOnCompleteOrder":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des Auftrages automatisch die Etiketten gedruckt werden?"},"printLabelAfterPicking":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des des Pickens automatisch die Etiketten gedruckt werden?"}}},"erp-wms-PicklistTemplate.PicklistScript":{"description":"Ein Picklisten-Skript","properties":{"source":{"type":"string","description":"Der Quelltext vom Skript"},"active":{"type":"boolean","default":false,"description":"Ist das Skript aktiv?"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /wms/picklist-templates/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Picklisten-Vorlagen","description":"Picklisten-Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/wms/picklist-templates/{id}/activate":{"put":{"tags":["Picklisten-Vorlagen"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_1","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-wms-PicklistTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"picklistCreationOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistCreationOptions"},"orderSelectionOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.OrderSelectionOptions"},"picklistProcessingOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistProcessingOptions"},"label":{"type":"string","description":"Name der Vorlage"},"description":{"type":"string","description":"Beschreibung der Vorlage"},"pickingType":{"type":"string","description":"Art der Kommissionierung","enum":["FAST_ORDER_PICKING","SINGLE_ORDER_PICKING","COLLECTIVE_ORDER_PICKING","ROLLING_ORDER_PICKING","CONSOLIDATION","REPLENISHMENT","FABRICATION","MISSING_GOODS_PICKING","INCORRECTLY_PICKED_GOODS"]},"defaultTemplate":{"type":"boolean","default":false,"description":"Handelt es sich um eine Standard-Vorlage?"},"active":{"type":"boolean","default":true,"description":"Is Template active?","readOnly":true},"picklistScripts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistScript"},"description":"Skripte für die Erstellung und Verarbeitung von Picklisten"}},"required":["label","pickingType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-wms-PicklistTemplate.PicklistCreationOptions":{"description":"Optionen zur Erstellung von Picklisten","properties":{"sortByRoutePosition":{"type":"boolean","default":true,"description":"Positionen der Pickliste nach Laufwegposition sortieren"},"maxPicklistLineCount":{"type":"integer","format":"int64","description":"Maximale Anzahl an Positionen einer Pickliste"},"maxQuantityOfOrderLineForFastOrderPicking":{"type":"integer","format":"int64","default":1,"description":"Maximale Menge einer Auftragsposition für Schnellkommissionierungs-Picklisten"},"orderPickingTrolleyRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderPickingTrolleyGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"useAllAvailOrderPickingTrolleys":{"type":"boolean","default":false,"description":"Sollen alle verfügbaren Pickwagen verwendet werden?"},"cycleToCreatePicklistsCronExpression":{"type":"string","description":"Zyklus zur Erstellung von Picklisten (für Background-Jobs, als Quartz-Cron-Expression) (https://www.freeformatter.com/cron-expression-generator-quartz.html)"},"specifyStorageBins":{"type":"boolean","default":true,"description":"Lagerplätze vorgeben"},"specifySerialWithOldestExpiryDate":{"type":"boolean","default":false,"description":"Für Serien-Artikel mit Verfallsdatum/MHD: älteste Serie in Pickliste vorgeben"},"firstCreateFastOrderPickingPicklists":{"type":"boolean","default":false,"description":"Sollen zuerst noch Picklisten für die Schnellkommissionierung erzeugt werden?"},"fastOrderPickingTemplateToUseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printPicklist":{"type":"boolean","default":false,"description":"Soll die Pickliste gedruckt werden?"},"picklistOutputReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printLabelsOnCreation":{"type":"boolean","default":false,"description":"Soll nach der Erstellung automatisch die Etiketten gedruckt werden?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-wms-PicklistTemplate.OrderSelectionOptions":{"description":"Optionen zur Selektion von Aufträgen","properties":{"maxOrderCount":{"type":"integer","format":"int64","description":"Nur für Einzelkommissionierung und Konsolidierung: maximale Anzahl zu übernehmender Aufträge"},"alternativeSelectionInVql":{"type":"string","description":"Alternative Selektion in VQL"},"additionalExistsStatementsInVql":{"type":"array","description":"Zusätzliche Exists-Statements in VQL","items":{"type":"string","description":"Zusätzliche Exists-Statements in VQL"}},"deliveryMethodRefs":{"type":"array","description":"Liste der gültigen Lieferarten","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentTypeRefs":{"type":"array","description":"Liste der Belegarten vom Belegtyp \"Auftrag\"","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"deliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"confirmedDeliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"onlyFullDeliverableOrders":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Aufträge"},"onlyFullDeliverableOrderLines":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Positionen"},"storageAreaRefs":{"type":"array","description":"Liste von gültigen Lagerbereichen","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelId":{"type":"integer","format":"int64","description":"Id des salesChannels der bei der Selektion berücksichtigt wird"},"minArticleCountPerOrder":{"type":"integer","format":"int32","description":"Minimale Anzahl Artikel pro Auftrag"},"maxArticleCountPerOrder":{"type":"integer","format":"int32","description":"Maximale Anzahl Artikel pro Auftrag"},"maxShippingWeightPerOrder":{"type":"number","description":"Maximales Versandgewicht pro Auftrag"},"maxTotalVolumePerOrderInCCM":{"type":"number","description":"Maximales Gesamtvolumen pro Auftrag (in ccm)"},"maxOrderValue":{"type":"number","description":"Maximaler Auftragswert"}}},"erp-wms-PicklistTemplate.DateRange":{"description":"Selektion über einen Datumsbereich","properties":{"from":{"type":"string","description":"Datum von (ggf. als relatives Datum)"},"to":{"type":"string","description":"Datum bis (ggf. als relatives Datum)"},"allowEmpty":{"type":"boolean","default":true,"description":"Datumsbereich darf leer sein"}}},"erp-wms-PicklistTemplate.PicklistProcessingOptions":{"description":"Optionen für die Verarbeitung von Picklisten","properties":{"autoPrintDeliveryDocument":{"type":"boolean","default":false,"description":"Soll die Lieferbelege automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"autoPrintShippingLabel":{"type":"boolean","default":false,"description":"Sollen die Paketlabel automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"allowOnlyScanOfArticles":{"type":"boolean","default":false,"description":"Dürfen Artikel nur per Scan (oder z.B. auch Eingabe der Artikelnummer) erfasst werden"},"autoDeterminationOfLots":{"type":"boolean","default":false,"description":"Chargen automatisch bestätigen, wenn sie vorgegeben oder bereits beim Picken erfasst wurden"},"hideTargetQuantityInViews":{"type":"boolean","default":false,"description":"Zielmengen in Masken verstecken?"},"allowPickingOfServiceArticles":{"type":"boolean","default":false,"description":"Sollen Dienstleistungen kommissioniert werden?"},"allowPickingOfNonInventoryManagedArticles":{"type":"boolean","default":false,"description":"Sollen nicht-bestandsgeführte Artikel kommissioniert werden?"},"allowFullConfirmation":{"type":"boolean","default":false,"description":"Sammelbestätigung erlauben"},"deviatingQuantity":{"type":"string","description":"Kommissionierung von abweichenden Mengen","enum":["ALLOW_ONLY_ORDERED_QUANTITY","ALLOW_MINOR_QUANTITY","ALLOW_OVER_DELIVERY","ALLOW_DEVIATING_QUANTITY"]},"assemblyGroupAtOnce":{"type":"boolean","default":false,"description":"Baugruppen als Ganzes kommissionieren"},"alwaysShowDeliveryMethod":{"type":"boolean","default":true,"description":"Immer die Lieferbedingung in Masken zeigen"},"showShippingFormOnPickingFinish":{"type":"boolean","default":false,"description":"Versand-Dialog beim Abschluss zeigen"},"autoPickingFinishAfterLastArticleInOrder":{"type":"boolean","default":false,"description":"Automatischer Abschluss nach letztem Artikel vom aktuellen Auftrag"},"useDigitalPicklist":{"type":"boolean","default":false,"description":"Digitale Pickliste verwenden: dabei werden nur die Positionen im Frontend gezeigt und durch Tippen oder Wischen bestätigt"},"usePickNPack":{"type":"boolean","default":false,"description":"Pick'n'Pack verwenden"},"scanDeliveryDocumentAndShippingLabelOnFinish":{"type":"boolean","default":false,"description":"Nur für Konsolidierung: Lieferbeleg und Versandlabel zum Abschluss scannen"},"scanPickTrolleyBoxToConfirmPickedArticle":{"type":"boolean","default":false,"description":"Rollende Kommissionierung/Konsolidierung: beim Sammeln muss die Box nach dem Scan eines Artikels per Scan bestätigt werden"},"blockIfMaximumPackageWeightIsExceeded":{"type":"boolean","default":true,"description":"Überschreitung vom maximalen Paketgewicht blockieren?"},"useSalesUnit":{"type":"boolean","default":false,"description":"Verwende die Verkaufseinheit als Standardmenge"},"printLabelOnScan":{"type":"boolean","default":false,"description":"Sollen bei der Erfassung automatisch die Etiketten gedruckt werden?"},"printLabelOnCompleteOrder":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des Auftrages automatisch die Etiketten gedruckt werden?"},"printLabelAfterPicking":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des des Pickens automatisch die Etiketten gedruckt werden?"}}},"erp-wms-PicklistTemplate.PicklistScript":{"description":"Ein Picklisten-Skript","properties":{"source":{"type":"string","description":"Der Quelltext vom Skript"},"active":{"type":"boolean","default":false,"description":"Ist das Skript aktiv?"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /wms/picklist-templates > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Picklisten-Vorlagen","description":"Picklisten-Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/wms/picklist-templates":{"post":{"tags":["Picklisten-Vorlagen"],"summary":"Create new Resource","operationId":"create_3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-wms-PicklistTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"picklistCreationOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistCreationOptions"},"orderSelectionOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.OrderSelectionOptions"},"picklistProcessingOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistProcessingOptions"},"label":{"type":"string","description":"Name der Vorlage"},"description":{"type":"string","description":"Beschreibung der Vorlage"},"pickingType":{"type":"string","description":"Art der Kommissionierung","enum":["FAST_ORDER_PICKING","SINGLE_ORDER_PICKING","COLLECTIVE_ORDER_PICKING","ROLLING_ORDER_PICKING","CONSOLIDATION","REPLENISHMENT","FABRICATION","MISSING_GOODS_PICKING","INCORRECTLY_PICKED_GOODS"]},"defaultTemplate":{"type":"boolean","default":false,"description":"Handelt es sich um eine Standard-Vorlage?"},"active":{"type":"boolean","default":true,"description":"Is Template active?","readOnly":true},"picklistScripts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistScript"},"description":"Skripte für die Erstellung und Verarbeitung von Picklisten"}},"required":["label","pickingType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-wms-PicklistTemplate.PicklistCreationOptions":{"description":"Optionen zur Erstellung von Picklisten","properties":{"sortByRoutePosition":{"type":"boolean","default":true,"description":"Positionen der Pickliste nach Laufwegposition sortieren"},"maxPicklistLineCount":{"type":"integer","format":"int64","description":"Maximale Anzahl an Positionen einer Pickliste"},"maxQuantityOfOrderLineForFastOrderPicking":{"type":"integer","format":"int64","default":1,"description":"Maximale Menge einer Auftragsposition für Schnellkommissionierungs-Picklisten"},"orderPickingTrolleyRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderPickingTrolleyGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"useAllAvailOrderPickingTrolleys":{"type":"boolean","default":false,"description":"Sollen alle verfügbaren Pickwagen verwendet werden?"},"cycleToCreatePicklistsCronExpression":{"type":"string","description":"Zyklus zur Erstellung von Picklisten (für Background-Jobs, als Quartz-Cron-Expression) (https://www.freeformatter.com/cron-expression-generator-quartz.html)"},"specifyStorageBins":{"type":"boolean","default":true,"description":"Lagerplätze vorgeben"},"specifySerialWithOldestExpiryDate":{"type":"boolean","default":false,"description":"Für Serien-Artikel mit Verfallsdatum/MHD: älteste Serie in Pickliste vorgeben"},"firstCreateFastOrderPickingPicklists":{"type":"boolean","default":false,"description":"Sollen zuerst noch Picklisten für die Schnellkommissionierung erzeugt werden?"},"fastOrderPickingTemplateToUseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printPicklist":{"type":"boolean","default":false,"description":"Soll die Pickliste gedruckt werden?"},"picklistOutputReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printLabelsOnCreation":{"type":"boolean","default":false,"description":"Soll nach der Erstellung automatisch die Etiketten gedruckt werden?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-wms-PicklistTemplate.OrderSelectionOptions":{"description":"Optionen zur Selektion von Aufträgen","properties":{"maxOrderCount":{"type":"integer","format":"int64","description":"Nur für Einzelkommissionierung und Konsolidierung: maximale Anzahl zu übernehmender Aufträge"},"alternativeSelectionInVql":{"type":"string","description":"Alternative Selektion in VQL"},"additionalExistsStatementsInVql":{"type":"array","description":"Zusätzliche Exists-Statements in VQL","items":{"type":"string","description":"Zusätzliche Exists-Statements in VQL"}},"deliveryMethodRefs":{"type":"array","description":"Liste der gültigen Lieferarten","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentTypeRefs":{"type":"array","description":"Liste der Belegarten vom Belegtyp \"Auftrag\"","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"deliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"confirmedDeliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"onlyFullDeliverableOrders":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Aufträge"},"onlyFullDeliverableOrderLines":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Positionen"},"storageAreaRefs":{"type":"array","description":"Liste von gültigen Lagerbereichen","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelId":{"type":"integer","format":"int64","description":"Id des salesChannels der bei der Selektion berücksichtigt wird"},"minArticleCountPerOrder":{"type":"integer","format":"int32","description":"Minimale Anzahl Artikel pro Auftrag"},"maxArticleCountPerOrder":{"type":"integer","format":"int32","description":"Maximale Anzahl Artikel pro Auftrag"},"maxShippingWeightPerOrder":{"type":"number","description":"Maximales Versandgewicht pro Auftrag"},"maxTotalVolumePerOrderInCCM":{"type":"number","description":"Maximales Gesamtvolumen pro Auftrag (in ccm)"},"maxOrderValue":{"type":"number","description":"Maximaler Auftragswert"}}},"erp-wms-PicklistTemplate.DateRange":{"description":"Selektion über einen Datumsbereich","properties":{"from":{"type":"string","description":"Datum von (ggf. als relatives Datum)"},"to":{"type":"string","description":"Datum bis (ggf. als relatives Datum)"},"allowEmpty":{"type":"boolean","default":true,"description":"Datumsbereich darf leer sein"}}},"erp-wms-PicklistTemplate.PicklistProcessingOptions":{"description":"Optionen für die Verarbeitung von Picklisten","properties":{"autoPrintDeliveryDocument":{"type":"boolean","default":false,"description":"Soll die Lieferbelege automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"autoPrintShippingLabel":{"type":"boolean","default":false,"description":"Sollen die Paketlabel automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"allowOnlyScanOfArticles":{"type":"boolean","default":false,"description":"Dürfen Artikel nur per Scan (oder z.B. auch Eingabe der Artikelnummer) erfasst werden"},"autoDeterminationOfLots":{"type":"boolean","default":false,"description":"Chargen automatisch bestätigen, wenn sie vorgegeben oder bereits beim Picken erfasst wurden"},"hideTargetQuantityInViews":{"type":"boolean","default":false,"description":"Zielmengen in Masken verstecken?"},"allowPickingOfServiceArticles":{"type":"boolean","default":false,"description":"Sollen Dienstleistungen kommissioniert werden?"},"allowPickingOfNonInventoryManagedArticles":{"type":"boolean","default":false,"description":"Sollen nicht-bestandsgeführte Artikel kommissioniert werden?"},"allowFullConfirmation":{"type":"boolean","default":false,"description":"Sammelbestätigung erlauben"},"deviatingQuantity":{"type":"string","description":"Kommissionierung von abweichenden Mengen","enum":["ALLOW_ONLY_ORDERED_QUANTITY","ALLOW_MINOR_QUANTITY","ALLOW_OVER_DELIVERY","ALLOW_DEVIATING_QUANTITY"]},"assemblyGroupAtOnce":{"type":"boolean","default":false,"description":"Baugruppen als Ganzes kommissionieren"},"alwaysShowDeliveryMethod":{"type":"boolean","default":true,"description":"Immer die Lieferbedingung in Masken zeigen"},"showShippingFormOnPickingFinish":{"type":"boolean","default":false,"description":"Versand-Dialog beim Abschluss zeigen"},"autoPickingFinishAfterLastArticleInOrder":{"type":"boolean","default":false,"description":"Automatischer Abschluss nach letztem Artikel vom aktuellen Auftrag"},"useDigitalPicklist":{"type":"boolean","default":false,"description":"Digitale Pickliste verwenden: dabei werden nur die Positionen im Frontend gezeigt und durch Tippen oder Wischen bestätigt"},"usePickNPack":{"type":"boolean","default":false,"description":"Pick'n'Pack verwenden"},"scanDeliveryDocumentAndShippingLabelOnFinish":{"type":"boolean","default":false,"description":"Nur für Konsolidierung: Lieferbeleg und Versandlabel zum Abschluss scannen"},"scanPickTrolleyBoxToConfirmPickedArticle":{"type":"boolean","default":false,"description":"Rollende Kommissionierung/Konsolidierung: beim Sammeln muss die Box nach dem Scan eines Artikels per Scan bestätigt werden"},"blockIfMaximumPackageWeightIsExceeded":{"type":"boolean","default":true,"description":"Überschreitung vom maximalen Paketgewicht blockieren?"},"useSalesUnit":{"type":"boolean","default":false,"description":"Verwende die Verkaufseinheit als Standardmenge"},"printLabelOnScan":{"type":"boolean","default":false,"description":"Sollen bei der Erfassung automatisch die Etiketten gedruckt werden?"},"printLabelOnCompleteOrder":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des Auftrages automatisch die Etiketten gedruckt werden?"},"printLabelAfterPicking":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des des Pickens automatisch die Etiketten gedruckt werden?"}}},"erp-wms-PicklistTemplate.PicklistScript":{"description":"Ein Picklisten-Skript","properties":{"source":{"type":"string","description":"Der Quelltext vom Skript"},"active":{"type":"boolean","default":false,"description":"Ist das Skript aktiv?"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # App Settings settings for apps ## GET /cmn/apps/{appIdentifier}/settings > find settings by app-identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"AppSettings","description":"settings for apps"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/apps/{appIdentifier}/settings":{"get":{"tags":["AppSettings"],"summary":"find settings by app-identifier","operationId":"get_1","parameters":[{"name":"appIdentifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-api-AppSettings"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-AppSettings":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["appIdentifier"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## POST /cmn/apps/{appIdentifier}/settings > create/update settings ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"AppSettings","description":"settings for apps"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/apps/{appIdentifier}/settings":{"post":{"tags":["AppSettings"],"summary":"create/update settings","operationId":"update_151","parameters":[{"name":"appIdentifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-AppSettings"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-api-AppSettings"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-AppSettings":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["appIdentifier"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /cmn/apps/{appIdentifier}/settings > deletes a settings entry ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"AppSettings","description":"settings for apps"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/apps/{appIdentifier}/settings":{"delete":{"tags":["AppSettings"],"summary":"deletes a settings entry","operationId":"delete_136","parameters":[{"name":"appIdentifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Variant Schema Variantenschemas ## GET /cmn/variant/schema/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantSchema","description":"Variantenschemas"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/variant/schema/{id}":{"get":{"tags":["VariantSchema"],"summary":"Find an existing Resource by identifier","operationId":"getById_127","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-variant-VariantSchema"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-variant-VariantSchema":{"description":"Variantenschema","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"attributeRefs":{"type":"array","description":"Zugeordnete Attribute","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"eligibleValueRefs":{"type":"array","description":"Wählbare Werte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["attributeRefs","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/variant/schema/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantSchema","description":"Variantenschemas"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/variant/schema/{id}":{"put":{"tags":["VariantSchema"],"summary":"Update existing Resource ","operationId":"update_116","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-variant-VariantSchema"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-variant-VariantSchema"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-variant-VariantSchema":{"description":"Variantenschema","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"attributeRefs":{"type":"array","description":"Zugeordnete Attribute","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"eligibleValueRefs":{"type":"array","description":"Wählbare Werte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["attributeRefs","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/variant/schema/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantSchema","description":"Variantenschemas"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/variant/schema/{id}":{"delete":{"tags":["VariantSchema"],"summary":"Delete an existing Resource","operationId":"delete_106","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/variant/schema/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantSchema","description":"Variantenschemas"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/variant/schema/{id}/deactivate":{"put":{"tags":["VariantSchema"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_56","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-variant-VariantSchema"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-variant-VariantSchema":{"description":"Variantenschema","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"attributeRefs":{"type":"array","description":"Zugeordnete Attribute","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"eligibleValueRefs":{"type":"array","description":"Wählbare Werte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["attributeRefs","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/variant/schema/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantSchema","description":"Variantenschemas"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/variant/schema/{id}/activate":{"put":{"tags":["VariantSchema"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_56","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-variant-VariantSchema"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-variant-VariantSchema":{"description":"Variantenschema","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"attributeRefs":{"type":"array","description":"Zugeordnete Attribute","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"eligibleValueRefs":{"type":"array","description":"Wählbare Werte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["attributeRefs","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/variant/schema > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantSchema","description":"Variantenschemas"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/variant/schema":{"post":{"tags":["VariantSchema"],"summary":"Create new Resource","operationId":"create_108","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-variant-VariantSchema"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-variant-VariantSchema"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-variant-VariantSchema":{"description":"Variantenschema","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"attributeRefs":{"type":"array","description":"Zugeordnete Attribute","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"eligibleValueRefs":{"type":"array","description":"Wählbare Werte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["attributeRefs","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /cmn/variant/schema/{id}/attributes > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantSchema","description":"Variantenschemas"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/variant/schema/{id}/attributes":{"get":{"tags":["VariantSchema"],"operationId":"getAllAttributesForVariantSchema","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-variant-VariantAttribute"}}}}}}}}},"components":{"schemas":{"common-variant-VariantAttribute":{"description":"Variantenattribut","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"identifier":{"type":"string","description":"Eindeutiger Identifier","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"labels":{"type":"array","description":"Bezeichnung (mehrsprachig)","items":{"$ref":"#/components/schemas/common-variant-VariantDescription"}}},"required":["identifier","labels"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-variant-VariantDescription":{"description":"Variantenbeschreibung (mehrsprachig)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"languageCode":{"type":"string","description":"Sprache"}},"required":["label","languageCode"]}}}} ``` # Bank Banks and accounts ## GET /erp/bank/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}":{"get":{"tags":["Bank"],"summary":"Find an existing Resource by identifier","operationId":"getById_75","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-Bank"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-Bank":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"description"},"bankingBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankName":{"type":"string","description":"bank name"},"bic":{"type":"string","description":"BIC"},"blz":{"type":"string","description":"BLZ"},"externalId":{"type":"string","description":"External BankID"},"creditorId":{"type":"string","description":"Gläubiger-Identifikationsnummer"},"userActionRequired":{"type":"boolean","description":"Wether a call to bank init is needed.","readOnly":true},"accounts":{"type":"array","description":"accounts","items":{"$ref":"#/components/schemas/erp-bank-BankAccount"}},"providerId":{"type":"integer","format":"int64","description":"ID of the banking provider"},"userForSyncRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Ist die Bank aktiv","readOnly":true},"logoUrl":{"type":"string","description":"URL des Bank-Logos"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-bank-BankAccount":{"description":"accounts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankId":{"type":"integer","format":"int64","description":"id of the bank"},"label":{"type":"string","description":"description"},"iban":{"type":"string","description":"IBAN"},"accountNumber":{"type":"string","description":"account number"},"subAccountNumber":{"type":"string","description":"sub account number"},"holderName":{"type":"string","description":"account holder"},"currency":{"type":"string","description":"currency"},"accountCredit":{"type":"number","description":"Kontokorrent-Betrag"},"sortOrder":{"type":"integer","format":"int32","description":"Konto-Position"},"defaultBankAccount":{"type":"boolean","default":false,"description":"Standard-Konto"},"active":{"type":"boolean","description":"Aktiv?"},"externalReferenceId":{"type":"string","description":"Referenz ID aus externem System","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/bank/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}":{"put":{"tags":["Bank"],"summary":"Update existing Resource ","operationId":"update_69","parameters":[{"name":"id","in":"path","description":"ID der Bank","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-Bank"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-Bank"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-Bank":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"description"},"bankingBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankName":{"type":"string","description":"bank name"},"bic":{"type":"string","description":"BIC"},"blz":{"type":"string","description":"BLZ"},"externalId":{"type":"string","description":"External BankID"},"creditorId":{"type":"string","description":"Gläubiger-Identifikationsnummer"},"userActionRequired":{"type":"boolean","description":"Wether a call to bank init is needed.","readOnly":true},"accounts":{"type":"array","description":"accounts","items":{"$ref":"#/components/schemas/erp-bank-BankAccount"}},"providerId":{"type":"integer","format":"int64","description":"ID of the banking provider"},"userForSyncRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Ist die Bank aktiv","readOnly":true},"logoUrl":{"type":"string","description":"URL des Bank-Logos"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-bank-BankAccount":{"description":"accounts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankId":{"type":"integer","format":"int64","description":"id of the bank"},"label":{"type":"string","description":"description"},"iban":{"type":"string","description":"IBAN"},"accountNumber":{"type":"string","description":"account number"},"subAccountNumber":{"type":"string","description":"sub account number"},"holderName":{"type":"string","description":"account holder"},"currency":{"type":"string","description":"currency"},"accountCredit":{"type":"number","description":"Kontokorrent-Betrag"},"sortOrder":{"type":"integer","format":"int32","description":"Konto-Position"},"defaultBankAccount":{"type":"boolean","default":false,"description":"Standard-Konto"},"active":{"type":"boolean","description":"Aktiv?"},"externalReferenceId":{"type":"string","description":"Referenz ID aus externem System","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/bank/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}":{"delete":{"tags":["Bank"],"summary":"Delete an existing Resource","operationId":"delete_67","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/bank/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}/deactivate":{"put":{"tags":["Bank"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_32","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-Bank"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-Bank":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"description"},"bankingBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankName":{"type":"string","description":"bank name"},"bic":{"type":"string","description":"BIC"},"blz":{"type":"string","description":"BLZ"},"externalId":{"type":"string","description":"External BankID"},"creditorId":{"type":"string","description":"Gläubiger-Identifikationsnummer"},"userActionRequired":{"type":"boolean","description":"Wether a call to bank init is needed.","readOnly":true},"accounts":{"type":"array","description":"accounts","items":{"$ref":"#/components/schemas/erp-bank-BankAccount"}},"providerId":{"type":"integer","format":"int64","description":"ID of the banking provider"},"userForSyncRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Ist die Bank aktiv","readOnly":true},"logoUrl":{"type":"string","description":"URL des Bank-Logos"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-bank-BankAccount":{"description":"accounts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankId":{"type":"integer","format":"int64","description":"id of the bank"},"label":{"type":"string","description":"description"},"iban":{"type":"string","description":"IBAN"},"accountNumber":{"type":"string","description":"account number"},"subAccountNumber":{"type":"string","description":"sub account number"},"holderName":{"type":"string","description":"account holder"},"currency":{"type":"string","description":"currency"},"accountCredit":{"type":"number","description":"Kontokorrent-Betrag"},"sortOrder":{"type":"integer","format":"int32","description":"Konto-Position"},"defaultBankAccount":{"type":"boolean","default":false,"description":"Standard-Konto"},"active":{"type":"boolean","description":"Aktiv?"},"externalReferenceId":{"type":"string","description":"Referenz ID aus externem System","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/bank/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}/activate":{"put":{"tags":["Bank"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_32","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-Bank"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-Bank":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"description"},"bankingBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankName":{"type":"string","description":"bank name"},"bic":{"type":"string","description":"BIC"},"blz":{"type":"string","description":"BLZ"},"externalId":{"type":"string","description":"External BankID"},"creditorId":{"type":"string","description":"Gläubiger-Identifikationsnummer"},"userActionRequired":{"type":"boolean","description":"Wether a call to bank init is needed.","readOnly":true},"accounts":{"type":"array","description":"accounts","items":{"$ref":"#/components/schemas/erp-bank-BankAccount"}},"providerId":{"type":"integer","format":"int64","description":"ID of the banking provider"},"userForSyncRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Ist die Bank aktiv","readOnly":true},"logoUrl":{"type":"string","description":"URL des Bank-Logos"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-bank-BankAccount":{"description":"accounts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankId":{"type":"integer","format":"int64","description":"id of the bank"},"label":{"type":"string","description":"description"},"iban":{"type":"string","description":"IBAN"},"accountNumber":{"type":"string","description":"account number"},"subAccountNumber":{"type":"string","description":"sub account number"},"holderName":{"type":"string","description":"account holder"},"currency":{"type":"string","description":"currency"},"accountCredit":{"type":"number","description":"Kontokorrent-Betrag"},"sortOrder":{"type":"integer","format":"int32","description":"Konto-Position"},"defaultBankAccount":{"type":"boolean","default":false,"description":"Standard-Konto"},"active":{"type":"boolean","description":"Aktiv?"},"externalReferenceId":{"type":"string","description":"Referenz ID aus externem System","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/bank > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank":{"post":{"tags":["Bank"],"summary":"Create new Resource","operationId":"create_65","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-Bank"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-Bank"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-Bank":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"description"},"bankingBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankName":{"type":"string","description":"bank name"},"bic":{"type":"string","description":"BIC"},"blz":{"type":"string","description":"BLZ"},"externalId":{"type":"string","description":"External BankID"},"creditorId":{"type":"string","description":"Gläubiger-Identifikationsnummer"},"userActionRequired":{"type":"boolean","description":"Wether a call to bank init is needed.","readOnly":true},"accounts":{"type":"array","description":"accounts","items":{"$ref":"#/components/schemas/erp-bank-BankAccount"}},"providerId":{"type":"integer","format":"int64","description":"ID of the banking provider"},"userForSyncRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Ist die Bank aktiv","readOnly":true},"logoUrl":{"type":"string","description":"URL des Bank-Logos"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-bank-BankAccount":{"description":"accounts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankId":{"type":"integer","format":"int64","description":"id of the bank"},"label":{"type":"string","description":"description"},"iban":{"type":"string","description":"IBAN"},"accountNumber":{"type":"string","description":"account number"},"subAccountNumber":{"type":"string","description":"sub account number"},"holderName":{"type":"string","description":"account holder"},"currency":{"type":"string","description":"currency"},"accountCredit":{"type":"number","description":"Kontokorrent-Betrag"},"sortOrder":{"type":"integer","format":"int32","description":"Konto-Position"},"defaultBankAccount":{"type":"boolean","default":false,"description":"Standard-Konto"},"active":{"type":"boolean","description":"Aktiv?"},"externalReferenceId":{"type":"string","description":"Referenz ID aus externem System","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/bank/{id}/new\_connection > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}/new_connection":{"post":{"tags":["Bank"],"operationId":"makeNewConnection","parameters":[{"name":"id","in":"path","description":"ID der Bank","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## POST /erp/bank/{id}/authentication\_status > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}/authentication_status":{"post":{"tags":["Bank"],"operationId":"getAuthStatus","parameters":[{"name":"id","in":"path","description":"ID der Bank","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}}}}}}}}} ``` ## GET /erp/bank/{id}/accounts > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}/accounts":{"get":{"tags":["Bank"],"operationId":"getBankAccounts","parameters":[{"name":"id","in":"path","description":"ID der Bank","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-bank-BankAccount"}}}}}}}}},"components":{"schemas":{"erp-bank-BankAccount":{"description":"accounts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankId":{"type":"integer","format":"int64","description":"id of the bank"},"label":{"type":"string","description":"description"},"iban":{"type":"string","description":"IBAN"},"accountNumber":{"type":"string","description":"account number"},"subAccountNumber":{"type":"string","description":"sub account number"},"holderName":{"type":"string","description":"account holder"},"currency":{"type":"string","description":"currency"},"accountCredit":{"type":"number","description":"Kontokorrent-Betrag"},"sortOrder":{"type":"integer","format":"int32","description":"Konto-Position"},"defaultBankAccount":{"type":"boolean","default":false,"description":"Standard-Konto"},"active":{"type":"boolean","description":"Aktiv?"},"externalReferenceId":{"type":"string","description":"Referenz ID aus externem System","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## POST /erp/bank/{id}/accounts > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}/accounts":{"post":{"tags":["Bank"],"operationId":"createBankAccount","parameters":[{"name":"id","in":"path","description":"ID der Bank","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankAccount"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankAccount"}}}}}}}},"components":{"schemas":{"erp-bank-BankAccount":{"description":"accounts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankId":{"type":"integer","format":"int64","description":"id of the bank"},"label":{"type":"string","description":"description"},"iban":{"type":"string","description":"IBAN"},"accountNumber":{"type":"string","description":"account number"},"subAccountNumber":{"type":"string","description":"sub account number"},"holderName":{"type":"string","description":"account holder"},"currency":{"type":"string","description":"currency"},"accountCredit":{"type":"number","description":"Kontokorrent-Betrag"},"sortOrder":{"type":"integer","format":"int32","description":"Konto-Position"},"defaultBankAccount":{"type":"boolean","default":false,"description":"Standard-Konto"},"active":{"type":"boolean","description":"Aktiv?"},"externalReferenceId":{"type":"string","description":"Referenz ID aus externem System","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## POST /erp/bank/{id}/accounts/sync > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}/accounts/sync":{"post":{"tags":["Bank"],"operationId":"syncBankAccount","parameters":[{"name":"id","in":"path","description":"ID der Bank","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","description":"Save sync","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-bank-BankAccount"}}}}}}}}},"components":{"schemas":{"erp-bank-BankAccount":{"description":"accounts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankId":{"type":"integer","format":"int64","description":"id of the bank"},"label":{"type":"string","description":"description"},"iban":{"type":"string","description":"IBAN"},"accountNumber":{"type":"string","description":"account number"},"subAccountNumber":{"type":"string","description":"sub account number"},"holderName":{"type":"string","description":"account holder"},"currency":{"type":"string","description":"currency"},"accountCredit":{"type":"number","description":"Kontokorrent-Betrag"},"sortOrder":{"type":"integer","format":"int32","description":"Konto-Position"},"defaultBankAccount":{"type":"boolean","default":false,"description":"Standard-Konto"},"active":{"type":"boolean","description":"Aktiv?"},"externalReferenceId":{"type":"string","description":"Referenz ID aus externem System","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## POST /erp/bank/update\_connection/{bankId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/update_connection/{bankId}":{"post":{"tags":["Bank"],"operationId":"updateConnection","parameters":[{"name":"bankId","in":"path","description":"bankId","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankConnectionUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-ApiTaskInfo"}}}}}}}},"components":{"schemas":{"erp-bank-BankConnectionUpdateRequest":{"properties":{"importNewAccounts":{"type":"boolean","default":false,"description":"Sollen neue Bankkonten importiert werden?"},"manageSavedSettings":{"type":"string","default":"NONE","description":"Sollen die gespeicherten Einwilligungen bearbeitet werden?","enum":["CREDENTIALS","DEFAULT_TWO_STEP_PROCEDURE","NONE"]}}},"erp-bank-ApiTaskInfo":{"properties":{"id":{"type":"string","description":"Die ID des externen Tasks"},"createdAt":{"type":"string","format":"date-time","description":"Wann der Task angelegt wurde"},"status":{"type":"string","description":"Was ist der Status des Tasks derzeit","enum":["NOT_YET_STARTED","IN_PROGRESS","WEB_FORM_REQUIRED","COMPLETED","COMPLETED_WITH_ERROR"]},"payload":{"$ref":"#/components/schemas/erp-bank-ApiPayload"},"webform":{"$ref":"#/components/schemas/erp-bank-ApiWebform"}}},"erp-bank-ApiPayload":{"description":"api Payload","properties":{"bankConnectionId":{"type":"integer","format":"int64","description":"bank connection ID"},"paymentId":{"type":"integer","format":"int64","description":"payment Id"},"standingOrderId":{"type":"integer","format":"int64","description":"standing order Id"}}},"erp-bank-ApiWebform":{"description":"Informationen über ein Webform wenn eines angelegt wurde","properties":{"webformId":{"type":"string","description":"web form Id"},"type":{"type":"string","description":"web form Type","enum":["BANK_CONNECTION_IMPORT","BANK_CONNECTION_UPDATE","PAYMENT_WITH_ACCOUNT_ID","STANDALONE_PAYMENT","DIRECT_DEBIT_WITH_ACCOUNT_ID","STANDING_ORDER"]},"status":{"type":"string","description":"web form Status","enum":["NOT_YET_OPENED","IN_PROGRESS","COMPLETED","COMPLETED_WITH_ERROR","EXPIRED","ABORTED","CANCELLED"]},"payload":{"$ref":"#/components/schemas/erp-bank-ApiPayload"},"expiresAt":{"type":"string","format":"date-time","description":"time expires at"},"createdAt":{"type":"string","format":"date-time","description":"time created At"},"url":{"type":"string","description":"web form Url"}}}}}} ``` ## POST /erp/bank/sync/{backendType}/{providerId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/sync/{backendType}/{providerId}":{"post":{"tags":["Bank"],"operationId":"syncBank","parameters":[{"name":"backendType","in":"path","description":"Bankschnittstelle","required":true,"schema":{"type":"string","enum":["OFFLINE","FINAPI","FINAPI_SANDBOX","MOCKBANK","APP"]}},{"name":"providerId","in":"path","description":"ID des Banking-Providers","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-bank-Bank"}}}}}}}}},"components":{"schemas":{"erp-bank-Bank":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"description"},"bankingBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankName":{"type":"string","description":"bank name"},"bic":{"type":"string","description":"BIC"},"blz":{"type":"string","description":"BLZ"},"externalId":{"type":"string","description":"External BankID"},"creditorId":{"type":"string","description":"Gläubiger-Identifikationsnummer"},"userActionRequired":{"type":"boolean","description":"Wether a call to bank init is needed.","readOnly":true},"accounts":{"type":"array","description":"accounts","items":{"$ref":"#/components/schemas/erp-bank-BankAccount"}},"providerId":{"type":"integer","format":"int64","description":"ID of the banking provider"},"userForSyncRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Ist die Bank aktiv","readOnly":true},"logoUrl":{"type":"string","description":"URL des Bank-Logos"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-bank-BankAccount":{"description":"accounts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankId":{"type":"integer","format":"int64","description":"id of the bank"},"label":{"type":"string","description":"description"},"iban":{"type":"string","description":"IBAN"},"accountNumber":{"type":"string","description":"account number"},"subAccountNumber":{"type":"string","description":"sub account number"},"holderName":{"type":"string","description":"account holder"},"currency":{"type":"string","description":"currency"},"accountCredit":{"type":"number","description":"Kontokorrent-Betrag"},"sortOrder":{"type":"integer","format":"int32","description":"Konto-Position"},"defaultBankAccount":{"type":"boolean","default":false,"description":"Standard-Konto"},"active":{"type":"boolean","description":"Aktiv?"},"externalReferenceId":{"type":"string","description":"Referenz ID aus externem System","readOnly":true}}}}}} ``` ## POST /erp/bank/start\_transaction\_download/{bankId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/start_transaction_download/{bankId}":{"post":{"tags":["Bank"],"operationId":"startExternalDownload","parameters":[{"name":"bankId","in":"path","description":"bankId","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-ApiTaskInfo"}}}}}}}},"components":{"schemas":{"erp-bank-ApiTaskInfo":{"properties":{"id":{"type":"string","description":"Die ID des externen Tasks"},"createdAt":{"type":"string","format":"date-time","description":"Wann der Task angelegt wurde"},"status":{"type":"string","description":"Was ist der Status des Tasks derzeit","enum":["NOT_YET_STARTED","IN_PROGRESS","WEB_FORM_REQUIRED","COMPLETED","COMPLETED_WITH_ERROR"]},"payload":{"$ref":"#/components/schemas/erp-bank-ApiPayload"},"webform":{"$ref":"#/components/schemas/erp-bank-ApiWebform"}}},"erp-bank-ApiPayload":{"description":"api Payload","properties":{"bankConnectionId":{"type":"integer","format":"int64","description":"bank connection ID"},"paymentId":{"type":"integer","format":"int64","description":"payment Id"},"standingOrderId":{"type":"integer","format":"int64","description":"standing order Id"}}},"erp-bank-ApiWebform":{"description":"Informationen über ein Webform wenn eines angelegt wurde","properties":{"webformId":{"type":"string","description":"web form Id"},"type":{"type":"string","description":"web form Type","enum":["BANK_CONNECTION_IMPORT","BANK_CONNECTION_UPDATE","PAYMENT_WITH_ACCOUNT_ID","STANDALONE_PAYMENT","DIRECT_DEBIT_WITH_ACCOUNT_ID","STANDING_ORDER"]},"status":{"type":"string","description":"web form Status","enum":["NOT_YET_OPENED","IN_PROGRESS","COMPLETED","COMPLETED_WITH_ERROR","EXPIRED","ABORTED","CANCELLED"]},"payload":{"$ref":"#/components/schemas/erp-bank-ApiPayload"},"expiresAt":{"type":"string","format":"date-time","description":"time expires at"},"createdAt":{"type":"string","format":"date-time","description":"time created At"},"url":{"type":"string","description":"web form Url"}}}}}} ``` ## GET /erp/bank/{id}/actions > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}/actions":{"get":{"tags":["Bank"],"operationId":"getBankActions","parameters":[{"name":"id","in":"path","description":"ID der Bank","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-bank-BankAction"}}}}}}}}},"components":{"schemas":{"erp-bank-BankAction":{"properties":{"description":{"type":"string","description":"Description of the action"},"type":{"type":"string","description":"action type","enum":["OPEN_URL"]},"expiration":{"type":"string","format":"date-time","description":"Expiration of the action"},"payload":{"type":"object","additionalProperties":{"type":"string","description":"Payload of actions to take (i.e. URL for type=OPEN_URL"},"description":"Payload of actions to take (i.e. URL for type=OPEN_URL"}}}}}} ``` ## GET /erp/bank/search/{backendType}/{searchTerm}/{providerId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/search/{backendType}/{searchTerm}/{providerId}":{"get":{"tags":["Bank"],"operationId":"searchExternalBankAccounts","parameters":[{"name":"backendType","in":"path","description":"Bankschnittstelle","required":true,"schema":{"type":"string","enum":["OFFLINE","FINAPI","FINAPI_SANDBOX","MOCKBANK","APP"]}},{"name":"searchTerm","in":"path","description":"Suchbegriff","required":true,"schema":{"type":"string"}},{"name":"providerId","in":"path","description":"ID des Banking-Providers","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-bank-BankRef"}}}}}}}}},"components":{"schemas":{"erp-bank-BankRef":{"properties":{"referenceId":{"type":"string","description":"reference id"},"label":{"type":"string","description":"description"},"bankName":{"type":"string","description":"bank name"},"bic":{"type":"string","description":"BIC"},"blz":{"type":"string","description":"BLZ"},"logoUrl":{"type":"string","description":"URL des Bank-Logos"}}}}}} ``` ## GET /erp/bank/get\_webform\_by\_id/{bankId}/{webformId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/get_webform_by_id/{bankId}/{webformId}":{"get":{"tags":["Bank"],"operationId":"getWebformById","parameters":[{"name":"bankId","in":"path","description":"bankId","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"webformId","in":"path","description":"webformIdentifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-ApiWebform"}}}}}}}},"components":{"schemas":{"erp-bank-ApiWebform":{"description":"Informationen über ein Webform wenn eines angelegt wurde","properties":{"webformId":{"type":"string","description":"web form Id"},"type":{"type":"string","description":"web form Type","enum":["BANK_CONNECTION_IMPORT","BANK_CONNECTION_UPDATE","PAYMENT_WITH_ACCOUNT_ID","STANDALONE_PAYMENT","DIRECT_DEBIT_WITH_ACCOUNT_ID","STANDING_ORDER"]},"status":{"type":"string","description":"web form Status","enum":["NOT_YET_OPENED","IN_PROGRESS","COMPLETED","COMPLETED_WITH_ERROR","EXPIRED","ABORTED","CANCELLED"]},"payload":{"$ref":"#/components/schemas/erp-bank-ApiPayload"},"expiresAt":{"type":"string","format":"date-time","description":"time expires at"},"createdAt":{"type":"string","format":"date-time","description":"time created At"},"url":{"type":"string","description":"web form Url"}}},"erp-bank-ApiPayload":{"description":"api Payload","properties":{"bankConnectionId":{"type":"integer","format":"int64","description":"bank connection ID"},"paymentId":{"type":"integer","format":"int64","description":"payment Id"},"standingOrderId":{"type":"integer","format":"int64","description":"standing order Id"}}}}}} ``` ## GET /erp/bank/get\_external\_task/{bankId}/{taskId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/get_external_task/{bankId}/{taskId}":{"get":{"tags":["Bank"],"operationId":"getTaskInfo","parameters":[{"name":"bankId","in":"path","description":"bankId","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"taskId","in":"path","description":"taskIdentifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-ApiTaskInfo"}}}}}}}},"components":{"schemas":{"erp-bank-ApiTaskInfo":{"properties":{"id":{"type":"string","description":"Die ID des externen Tasks"},"createdAt":{"type":"string","format":"date-time","description":"Wann der Task angelegt wurde"},"status":{"type":"string","description":"Was ist der Status des Tasks derzeit","enum":["NOT_YET_STARTED","IN_PROGRESS","WEB_FORM_REQUIRED","COMPLETED","COMPLETED_WITH_ERROR"]},"payload":{"$ref":"#/components/schemas/erp-bank-ApiPayload"},"webform":{"$ref":"#/components/schemas/erp-bank-ApiWebform"}}},"erp-bank-ApiPayload":{"description":"api Payload","properties":{"bankConnectionId":{"type":"integer","format":"int64","description":"bank connection ID"},"paymentId":{"type":"integer","format":"int64","description":"payment Id"},"standingOrderId":{"type":"integer","format":"int64","description":"standing order Id"}}},"erp-bank-ApiWebform":{"description":"Informationen über ein Webform wenn eines angelegt wurde","properties":{"webformId":{"type":"string","description":"web form Id"},"type":{"type":"string","description":"web form Type","enum":["BANK_CONNECTION_IMPORT","BANK_CONNECTION_UPDATE","PAYMENT_WITH_ACCOUNT_ID","STANDALONE_PAYMENT","DIRECT_DEBIT_WITH_ACCOUNT_ID","STANDING_ORDER"]},"status":{"type":"string","description":"web form Status","enum":["NOT_YET_OPENED","IN_PROGRESS","COMPLETED","COMPLETED_WITH_ERROR","EXPIRED","ABORTED","CANCELLED"]},"payload":{"$ref":"#/components/schemas/erp-bank-ApiPayload"},"expiresAt":{"type":"string","format":"date-time","description":"time expires at"},"createdAt":{"type":"string","format":"date-time","description":"time created At"},"url":{"type":"string","description":"web form Url"}}}}}} ``` ## GET /erp/bank/get\_external\_state/{bankId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/get_external_state/{bankId}":{"get":{"tags":["Bank"],"operationId":"getExternalState","parameters":[{"name":"bankId","in":"path","description":"bankId","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankConnectionDto"}}}}}}}},"components":{"schemas":{"erp-bank-BankConnectionDto":{"properties":{"referenceId":{"type":"string"},"bankReferenceId":{"type":"string"},"label":{"type":"string"},"bankName":{"type":"string"},"bic":{"type":"string"},"blz":{"type":"string"},"lastManualUpdate":{"type":"string","format":"date-time"},"lastManualUpdateMessage":{"type":"string"},"lastManualUpdateState":{"type":"string","enum":["OK","BANK_SERVER_REJECTION","INTERNAL_SERVER_ERROR","NONE"]},"lastAutoUpdate":{"type":"string","format":"date-time"},"lastAutoUpdateMessage":{"type":"string"},"lastAutoUpdateState":{"type":"string","enum":["OK","BANK_SERVER_REJECTION","INTERNAL_SERVER_ERROR","NONE"]},"consentExpiresAt":{"type":"string","format":"date-time"}}}}}} ``` ## DELETE /erp/bank/{id}/delete\_connection > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/{id}/delete_connection":{"delete":{"tags":["Bank"],"operationId":"deleteConnection","parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## DELETE /erp/bank/reset\_for\_provider\_type/{backendType} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bank","description":"Banks and accounts"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/reset_for_provider_type/{backendType}":{"delete":{"tags":["Bank"],"operationId":"resetForProvider","parameters":[{"name":"backendType","in":"path","required":true,"schema":{"type":"string","enum":["OFFLINE","FINAPI","FINAPI_SANDBOX","MOCKBANK","APP"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` # Document the Document API ## POST /erp/documents > create a new document ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents":{"post":{"tags":["Document"],"summary":"create a new document","operationId":"createDocument","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentTypeTransitionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentTypeTransitionRequest":{"properties":{"transitionId":{"type":"string","description":"transition id"},"targetTypeId":{"type":"integer","format":"int64","description":"Ggf. die ID der Ziel-Belegart"},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"document":{"$ref":"#/components/schemas/erp-document-RequestDocument"}},"required":["transitionId"]},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-RequestDocument":{"description":"Details zum zu erstellenden oder zu bearbeitenden Beleg","properties":{"accountId":{"type":"string","description":"account-id to create a new Document"},"salesChannelId":{"type":"string","description":"sales-channel-id to create a new Document"},"externalId":{"type":"string","description":"reference to the corresponding document in an external system"},"externalNumber":{"type":"string","description":"externe Belegnummer"},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"calculationMode":{"type":"string","description":"calculation mode","enum":["HORIZONTAL","VERTICAL"]},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"supplierAccountId":{"type":"integer","format":"int64","description":"Vorgabelieferant bei Übernahme von Auftrag zu Bestellung(en)"},"lines":{"type":"array","description":"Dokumentzeilen","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLine"}},"targetDocumentType":{"$ref":"#/components/schemas/erp-document-DocumentType"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"ID vom Pickwagen für den Wareneingang (wenn incomingGoodsStorageBinId = null)"},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"ID vom Lagerplatz für den Wareneingang (wenn incomingGoodsPickTrolleyId = null)"},"priceModifiers":{"type":"array","description":"Die Rabatte des Beleges","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"posRegisterId":{"type":"integer","format":"int64","description":"ID der Kasse (bei POS)"},"cashDrawerId":{"type":"integer","format":"int64","description":"ID der Kassenschublade (bei POS)"},"depositPaymentAmount":{"type":"number","description":"Der Anzahlungsbetrag"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"posPayments":{"type":"array","description":"Eine oder mehr Kassenzahlungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"texts":{"type":"array","description":"Kopf-/Fußtexte des Belegs","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"einvoice":{"type":"boolean"}}},"erp-document-RequestDocumentLine":{"description":"Details zum zu erstellenden oder zu bearbeitenden Beleg","properties":{"name":{"type":"string","description":"Artikelname"},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer der Artikel"},"description":{"type":"string","description":"Artikelbeschreibung"},"lineId":{"type":"string","description":"ID der Belegposition im aktuellen Beleg"},"sourceLineId":{"type":"string","description":"ID der Quell-Belegposition"},"refLineId":{"type":"string","description":"(optional) ID der referenzierten Belegposition"},"articleId":{"type":"string","description":"(optional) ID des Artikels dieser Position"},"externalId":{"type":"string","description":"Referenz auf die zugehörige Position in einem externen System"},"productPrice":{"type":"number","description":"(optional) Preis des Artikels dieser Position"},"totalLinePrice":{"type":"number","description":"(optional) Gesamtpreis dieser Position"},"priceModifiers":{"type":"array","description":"(optional) Liste von Preismodifikatoren für diese Position","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"texts":{"type":"array","description":"(optional) Liste von Texten für diese Position","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentText"}},"quantity":{"type":"number","description":"Menge, die in dieser Transaktion verarbeitet werden soll"},"storageId":{"type":"string","description":"(optional) Lager-ID"},"markCompleted":{"type":"boolean","default":false,"description":"Soll die Quellposition nach erfolgreicher Verarbeitung als abgeschlossen markiert werden?"},"supplierAccountId":{"type":"integer","format":"int64","description":"Wird für die Umwandlung von Kundenauftrag in Lieferantenauftrag benötigt"},"bookings":{"type":"array","description":"Buchungen zu dieser Belegposition","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen zu dieser Belegposition","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineCommission"}},"commissionOrigin":{"type":"string","description":"Provisionsherkunft dieser Belegposition","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"lineType":{"type":"string","description":"Typ dieser Position","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"settledOpenItemId":{"type":"string","description":"ID des auszugleichenden Offenen Postens (nur bei OPEN_ITEM_SETTLEMENT)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"ID des Pickwagens für den Wareneingang (wenn `incomingGoodsStorageBinId` = null)"},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"ID des Lagerplatzes für den Wareneingang (wenn `incomingGoodsPickTrolleyId` = null)"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineFabricationDetail"},"doLabelPrint":{"type":"boolean","default":false,"description":"Zu der Zeile Etikettendruck anstoßen"}}},"erp-document-RequestDocumentPriceModifier":{"description":"Die Rabatte des Beleges","properties":{"modifierValue":{"type":"number","description":"modifierValue of this line"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierName":{"type":"string","description":"modifierName of this line"},"modifierType":{"type":"string","description":"type of this price modifier (discount/surcharge)","enum":["DISCOUNT","SURCHARGE"]},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]}},"required":["modifierType","modifierValue","valueType"]},"erp-document-RequestDocumentText":{"description":"(optional) Liste von Texten für diese Position","properties":{"textPosition":{"type":"string","description":"header or footer text","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"text content"}}},"erp-document-RequestDocumentLineBooking":{"description":"Buchungen zu dieser Belegposition","properties":{"sourceComponentId":{"type":"integer","format":"int64","description":"ID der bebuchten Quell-DocumentLineComponent"},"quantity":{"type":"number","description":"Gebuchte Menge"},"storageBinId":{"type":"integer","format":"int64","description":"ID vom bebuchten Lagerplatz"},"serialNumberId":{"type":"integer","format":"int64","description":"Ggf. ID einer zu buchenden Seriennummer"}},"required":["quantity","sourceComponentId","storageBinId"]},"erp-document-RequestDocumentLineCommission":{"description":"Provisionen zu dieser Belegposition","properties":{"salesAgentAccountRef":{"$ref":"#/components/schemas/erp-account-Account"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-account-Account":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"types":{"type":"array","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","items":{"type":"string","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","enum":["CUSTOMER","SUPPLIER","MANUFACTURER","SERVICE_PROVIDER","MERCHANT","SALES_AGENT","COMPANY","PROSPECTIVE"]}},"number":{"type":"string","description":"Address-Number"},"displayName":{"type":"string","description":"Kurzbezeichnung zur Darstellung","readOnly":true},"active":{"type":"boolean","default":true,"description":"Is account active?","readOnly":true},"taxNumber":{"type":"string","description":"tax number/ Steuernummer","maxLength":255,"minLength":0},"remark":{"type":"string","description":"Sonderbemerkung","maxLength":1024,"minLength":0},"note":{"type":"string","description":"Notiz"},"companyLegalRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"address":{"$ref":"#/components/schemas/erp-account-AccountAddress"},"person":{"$ref":"#/components/schemas/erp-account-AccountPerson"},"addresses":{"type":"array","description":"Alle Adressen außer der Standard-Adresse","items":{"$ref":"#/components/schemas/erp-account-AccountAddress"}},"persons":{"type":"array","description":"Ansprechpartner","items":{"$ref":"#/components/schemas/erp-account-AccountPerson"}},"customer":{"$ref":"#/components/schemas/erp-account-Customer"},"supplier":{"$ref":"#/components/schemas/erp-account-Supplier"},"salesAgent":{"$ref":"#/components/schemas/erp-account-SalesAgent"},"manufacturer":{"$ref":"#/components/schemas/erp-account-AccountManufacturer"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"localCourt":{"type":"string","description":"Zuständiges Amtsgericht","maxLength":255,"minLength":0},"companyRegister":{"type":"string","description":"Handelsregister-Kennung","maxLength":255,"minLength":0},"costCenter":{"type":"string","description":"Kostenstelle"},"languageCode":{"type":"string","description":"Sprache des Accounts"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"initialContactAt":{"type":"string","format":"date","description":"Erstkontakt am"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Umkehrung der Steuerschuld nach §13b UStG?"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxIds":{"type":"array","description":"Eine List von Steuernummern","items":{"$ref":"#/components/schemas/erp-account-TaxIdForeignCountry"}},"relations":{"type":"array","description":"Account-Beziehungen","items":{"$ref":"#/components/schemas/erp-account-AccountRelation"}},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"payablesSum":{"type":"number","description":"Summe Verbindlichkeiten","readOnly":true},"payablesSumCurrencyCode":{"type":"string","description":"Währung Summe Verbindlichkeiten IsoAlpha3","readOnly":true},"anonymized":{"type":"boolean","description":"ist der Account anonymisiert?","readOnly":true},"receivablesSum":{"type":"number","description":"Summe Forderungen","readOnly":true},"receivablesSumCurrencyCode":{"type":"string","description":"Währung Summe Forderungen IsoAlpha3","readOnly":true},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"loanCurrencyCode":{"type":"string","description":"Währung Kreditlimit IsoAlpha3","readOnly":true},"accountZoneId":{"type":"string","description":"Zeitzone (bzw. Zeitzonen-Offset) des Accounts","enum":["ACT","AET","AGT","ART","AST","BET","BST","CAT","CNT","CST","CTT","EAT","ECT","IET","IST","JST","MIT","NET","NST","PLT","PNT","PRT","PST","SST","VST","EST","MST","HST"]},"calculationMode":{"type":"string","description":"calculation mode of this document","enum":["HORIZONTAL","VERTICAL"]},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"hasActiveDuplicates":{"type":"boolean","default":false,"description":"Has this Account a possible duplicate"},"businessRelationType":{"type":"string","description":"Geschäftsbeziehungs-Typen für Geschäftspartner","enum":["B2B","B2C","B2G"]}},"required":["address","businessRelationType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-account-AccountAddress":{"description":"Alle Adressen außer der Standard-Adresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"name1":{"type":"string","description":"Name1","maxLength":255,"minLength":0},"name2":{"type":"string","description":"Name2","maxLength":255,"minLength":0},"name3":{"type":"string","description":"Name3","maxLength":255,"minLength":0},"defaultAddress":{"type":"boolean","default":false,"description":"is this the default address of the account","readOnly":true},"types":{"type":"array","description":"the kind of usages for this address","items":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"street":{"type":"string","description":"Street","maxLength":255,"minLength":0},"globalLocationNumber":{"type":"string","description":"GLN/ILN as location identifier for this address","maxLength":255,"minLength":0},"streetAddressNumber":{"type":"string","description":"Street address number","maxLength":255,"minLength":0},"additionalAddressLine1":{"type":"string","description":"Additional address line1","maxLength":255,"minLength":0},"additionalAddressLine2":{"type":"string","description":"Additional address line2","maxLength":255,"minLength":0},"city":{"type":"string","description":"City","maxLength":255,"minLength":0},"postcode":{"type":"string","description":"Postcode","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 Profil","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"taxIdentificationNumber":{"type":"string","description":"tax identification number/ UST-ID-Nr.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"homepageUrl":{"type":"string","description":"Homepage URL"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"countryCode":{"type":"string","description":"Country code"},"longitude":{"type":"number","format":"double","description":"Longitude"},"latitude":{"type":"number","format":"double","description":"latitude"},"remark":{"type":"string","description":"Sonderbemerkung","maxLength":1024,"minLength":0},"postOfficeBox":{"type":"string","description":"Post office box","maxLength":255,"minLength":0},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"eoriNumber":{"type":"string","description":"EORI-Nummer","maxLength":255,"minLength":0},"contacts":{"type":"array","description":"Contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"calculationMode":{"type":"string","description":"calculation mode of this address","enum":["HORIZONTAL","VERTICAL"]},"deviatingPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"languageCode":{"type":"string","description":"Sprache der Adresse"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultForType":{"type":"boolean","default":false,"description":"Standard für den Account-Typ"}},"required":["name1"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-account-Contact":{"description":"List of contacts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"value":{"type":"string","description":"A Value","maxLength":255,"minLength":0},"typeId":{"type":"string","description":"Type identifier"},"type":{"type":"string","description":"Contact type","enum":["PHONE","SOCIAL","EMAIL","FAX","SKYPE","MS_TEAMS","CUSTOM","MOBILE"]},"label":{"type":"string","description":"Contact label","maxLength":255,"minLength":0},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"default":{"type":"boolean","default":false,"description":"Is default contact?"}},"required":["value"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-account-AccountPerson":{"description":"Ansprechpartner","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"comment":{"type":"string","description":"Comment"},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"firstName":{"type":"string","description":"First name","maxLength":255,"minLength":0},"middleName":{"type":"string","description":"Middle name","maxLength":255,"minLength":0},"lastName":{"type":"string","description":"Lastname","maxLength":255,"minLength":0},"gender":{"type":"string","description":"Gender","enum":["MALE","FEMALE","ETC"]},"locale":{"type":"string","description":"Locale","maxLength":255,"minLength":0},"jobArea":{"type":"string","description":"Job area","maxLength":255,"minLength":0},"jobTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth"},"sortOrder":{"type":"integer","format":"int64","description":"sortierreihenfolge"},"remark":{"type":"string","description":"Sonderbemerkung","maxLength":1024,"minLength":0},"contacts":{"type":"array","description":"List of contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactAt":{"type":"string","format":"date","description":"Erstkontakt am"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"defaultPerson":{"type":"boolean","default":false,"description":"Standard-Ansprechpartner","readOnly":true}},"required":["lastName"]},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-account-Customer":{"description":"Customer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"number of customer","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"accountingNumber":{"type":"string","description":"finance account-number of customer","maxLength":255,"minLength":0},"taxable":{"type":"boolean","default":true,"description":"tax able or tax free"},"deliveryBlocked":{"type":"boolean","default":false,"description":"Hat der Kunde eine Liefersperre?"},"billingType":{"type":"string","description":"presetting of billing type","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productPriceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität für die Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"ourNumber":{"type":"string","description":"customers number for us"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"collectiveBillable":{"type":"boolean","default":false,"description":"collective billable"},"collectiveInvoiceManually":{"type":"boolean","default":true,"description":"Sammelabrechnung nur manuell auslösen?"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Sammelabrechnung"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit der nächsten Sammelabrechnung"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit nach der aktuellen"}}},"erp-account-Supplier":{"description":"Supplier of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountingNumber":{"type":"string","description":"finance account-number of supplier","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"dunning":{"type":"boolean","default":false,"description":"Mahnen?"},"number":{"type":"string","description":"number of supplier","maxLength":255,"minLength":0},"ourNumber":{"type":"string","description":"suppliers number for us","maxLength":255,"minLength":0},"billingType":{"type":"string","description":"Fakturisierungsart Netto oder Brutto","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderBlocked":{"type":"boolean","default":false,"description":"Bestellsperre"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultDeliveryTime":{"type":"integer","format":"int32","description":"Lieferzeit in (Werk-)Tagen"},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"taxable":{"type":"boolean","default":true,"description":"tax able or tax free"},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"permissibleForOrderProposal":{"type":"boolean","default":true,"description":"zulässig für Aufnahme in Bestellvorschläge"},"minimumOrderValue":{"type":"number","description":"Mindestbestellwert"},"freeShippingValue":{"type":"number","description":"Frachtkostenfrei ab"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"createCustomerDeliveryWhenDropShipping":{"type":"boolean","default":false,"description":"Erzeugung Ausgangs-Lieferschein bei Streckengeschäft-Bestellung"},"dropShippingAllowed":{"type":"boolean","default":false,"description":"Kennzeichen, ob Streckengeschäft erlaubt"}}},"erp-account-SalesAgent":{"description":"Sales Agent of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"number":{"type":"string","description":"number of sales agent","maxLength":255,"minLength":0},"commissionType":{"type":"string","description":"commission type of sales agent","enum":["INVOICE","ORDER","PAYMENT"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxable":{"type":"boolean","description":"is sales agent taxable"},"accountingNumber":{"type":"string","description":"accounting number"},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"note":{"type":"string","description":"Bemerkung"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["billingType","commissionType","deliveryMethodRef","deliveryTermRef","paymentMethodRef","paymentTermRef","taxRateRef","taxable"]},"erp-account-AccountManufacturer":{"description":"Manufacturer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"labels":{"type":"array","description":"Beschreibungen","items":{"$ref":"#/components/schemas/erp-account-AccountManufacturerDescription"}},"forcedRecommendedRetailPrice":{"type":"boolean","default":false,"description":"Ist der UVP verpflichtend?"}},"required":["labels"]},"erp-account-AccountManufacturerDescription":{"description":"Beschreibungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"languageCode":{"type":"string","description":"Sprache der Beschreibung"},"manufacturerUrl":{"type":"string","description":"Hersteller-URL"}},"required":["label","languageCode"]},"erp-account-TaxIdForeignCountry":{"description":"Eine List von Steuernummern","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxId":{"type":"string","description":"Tax ID of the company in the associated country"},"countryCode":{"type":"string","description":"ISO 2 Code of the country this tax ID is used for"}}},"erp-account-AccountRelation":{"description":"Account-Beziehungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"relatedAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"comment":{"type":"string","description":"Comment"},"relationTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["relatedAccountRef","relationTypeRef"]},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"erp-document-RequestDocumentLineFabricationDetail":{"description":"Details zur verarbeiteten Produktionsbelegposition","properties":{"fabricationSerialNumbers":{"type":"array","description":"Nur füllen, wenn die Seriennummern vor der Start der Produktion manuell bestimmt werden sollen","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}}}},"erp-fabrication-FabricationSerialNumber":{"description":"Zu produzierende Seriennummer","properties":{"quantity":{"type":"number","description":"Abweichende Menge für Chargen"},"serialNumberId":{"type":"integer","format":"int64","description":"ID der zu produzierenden Seriennummer (nur zur gezielten Produktion von bereits definierten Seriennummern)"},"serialNumber1":{"type":"string","description":"Seriennummer 1"},"serialNumber2":{"type":"string","description":"Seriennummer 2"},"expiryDate":{"type":"string","format":"date","description":"MHD / Verfallsdatum"},"note":{"type":"string","description":"Bemerkung"}}},"erp-document-DocumentType":{"description":"target document type for document copy","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"labels":{"type":"array","description":"label/name of this type","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"}},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"showForManualDocumentCreation":{"type":"boolean","default":true,"description":"Darf dieser Typ zur Neuanlage von Belegen verwendet werden?"},"nextNumber":{"type":"string","description":"nächste Belegnummer","maxLength":255,"minLength":0,"readOnly":true},"followUpDocumentTypes":{"type":"array","description":"follow up document types","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeFollowUp"},"readOnly":true},"defaultTypeOfCategory":{"type":"boolean","default":false,"description":"ist diese Belegart die Standard-Belegart für ihre Kategorie?"},"active":{"type":"boolean","default":true,"description":"ist diese Belegart aktiv"},"shelfDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sequencerConfiguration":{"$ref":"#/components/schemas/common-sequencer-SequencerConfiguration"},"requiresBusinessRelationship":{"type":"boolean","default":true,"description":"Geschäftsbeziehung verpflichtend"},"publishingPolicy":{"type":"string","default":"AUTOMATIC","description":"Verhalten zugeordnetem DMS-Dokument","enum":["AUTOMATIC","MANUAL"]},"sortOrder":{"type":"integer","format":"int32","description":"Sortierung"}},"required":["category"]},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)"},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)"}},"required":["label","labelPrintout","languageCode"]},"erp-document-DocumentTypeFollowUp":{"description":"follow up document types","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"sourceDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"ist diese Folge-Belegart aktiv","readOnly":true}},"required":["sourceDocumentTypeRef","targetDocumentTypeRef"]},"common-sequencer-SequencerConfiguration":{"description":"Eigener Zählerkreis für Seriennummern","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Unique key to identify the sequencer configuration","readOnly":true},"configurationGroup":{"type":"string","description":"Group of the sequencer configuration (e.g. Document, Account, ...)","readOnly":true},"configurationDetail":{"$ref":"#/components/schemas/common-sequencer-SequencerConfigurationDetail"},"alternativeConfiguration":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Sequencer aktiv?"}},"required":["configurationDetail"]},"common-sequencer-SequencerConfigurationDetail":{"description":"Contains details about the sequencer configuration","properties":{"type":{"type":"string","description":"Typ der Sequenz","enum":["NON_POOLED_SEQUENCES","POOLED_SEQUENCES","PREFETCHED_SEQUENCES"]},"assignmentMode":{"type":"string","description":"Vergabeverfahren","enum":["MANUAL","AUTOMATIC","SEMI_AUTOMATIC","FREE"]},"length":{"type":"integer","format":"int32","description":"Länge"},"padChar":{"type":"string","description":"Auffüllzeichen","maxLength":1,"minLength":1,"pattern":"^[0-9]*$"},"expression":{"type":"string","description":"Präfix-Ausdruck"},"postExpression":{"type":"string","description":"Postfix-Ausdruck"},"initialValue":{"type":"integer","format":"int64","description":"Initialer Wert"},"numberUnique":{"type":"boolean","default":true,"description":"Eindeutigkeitsprüfung"}},"required":["assignmentMode","initialValue","length","padChar","type"]},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## PUT /erp/documents > update an existing document ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents":{"put":{"tags":["Document"],"summary":"update an existing document","operationId":"updateDocument","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentUpdateRequest":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}},"required":["document"]},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## GET /erp/documents/{id}/states > return all possible states, the document can transferred into ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/states":{"get":{"tags":["Document"],"summary":"return all possible states, the document can transferred into","operationId":"getPossibleStates","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"languageCode","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentTransitionRef"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentTransitionRef":{"properties":{"id":{"type":"string","description":"das gleiche wie transition id für das UI"},"transitionId":{"type":"string","description":"transition id"},"transitionLabel":{"type":"string","description":"label of this transition","readOnly":true},"uiHint":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stateDefinition":{"type":"string","description":"state definition of the target state","readOnly":true},"typeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"typeId":{"type":"string","description":"document-type-id des ziels","readOnly":true},"typeKey":{"type":"string","description":"document-type-key des ziels","readOnly":true},"typeLabel":{"type":"string","description":"type-label","readOnly":true},"isDefaultTypeForCategory":{"type":"boolean","description":"document-type ist Default für die Kategorie","readOnly":true},"targetState":{"type":"string","description":"Der Ziel-Status der Transition","readOnly":true},"sortOrder":{"type":"integer","format":"int32","description":"Sortier-Reihenfolge","readOnly":true}},"required":["id","transitionId"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/documents/{id}/states > transfer the document into the given state ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/states":{"put":{"tags":["Document"],"summary":"transfer the document into the given state","operationId":"transferToState_1","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentStateTransitionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentStateTransitionRequest":{"properties":{"transitionId":{"type":"string","description":"transition id"},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"document":{"$ref":"#/components/schemas/erp-document-RequestDocument"}},"required":["transitionId"]},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-RequestDocument":{"description":"Details zum zu erstellenden oder zu bearbeitenden Beleg","properties":{"accountId":{"type":"string","description":"account-id to create a new Document"},"salesChannelId":{"type":"string","description":"sales-channel-id to create a new Document"},"externalId":{"type":"string","description":"reference to the corresponding document in an external system"},"externalNumber":{"type":"string","description":"externe Belegnummer"},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"calculationMode":{"type":"string","description":"calculation mode","enum":["HORIZONTAL","VERTICAL"]},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"supplierAccountId":{"type":"integer","format":"int64","description":"Vorgabelieferant bei Übernahme von Auftrag zu Bestellung(en)"},"lines":{"type":"array","description":"Dokumentzeilen","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLine"}},"targetDocumentType":{"$ref":"#/components/schemas/erp-document-DocumentType"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"ID vom Pickwagen für den Wareneingang (wenn incomingGoodsStorageBinId = null)"},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"ID vom Lagerplatz für den Wareneingang (wenn incomingGoodsPickTrolleyId = null)"},"priceModifiers":{"type":"array","description":"Die Rabatte des Beleges","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"posRegisterId":{"type":"integer","format":"int64","description":"ID der Kasse (bei POS)"},"cashDrawerId":{"type":"integer","format":"int64","description":"ID der Kassenschublade (bei POS)"},"depositPaymentAmount":{"type":"number","description":"Der Anzahlungsbetrag"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"posPayments":{"type":"array","description":"Eine oder mehr Kassenzahlungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"texts":{"type":"array","description":"Kopf-/Fußtexte des Belegs","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"einvoice":{"type":"boolean"}}},"erp-document-RequestDocumentLine":{"description":"Details zum zu erstellenden oder zu bearbeitenden Beleg","properties":{"name":{"type":"string","description":"Artikelname"},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer der Artikel"},"description":{"type":"string","description":"Artikelbeschreibung"},"lineId":{"type":"string","description":"ID der Belegposition im aktuellen Beleg"},"sourceLineId":{"type":"string","description":"ID der Quell-Belegposition"},"refLineId":{"type":"string","description":"(optional) ID der referenzierten Belegposition"},"articleId":{"type":"string","description":"(optional) ID des Artikels dieser Position"},"externalId":{"type":"string","description":"Referenz auf die zugehörige Position in einem externen System"},"productPrice":{"type":"number","description":"(optional) Preis des Artikels dieser Position"},"totalLinePrice":{"type":"number","description":"(optional) Gesamtpreis dieser Position"},"priceModifiers":{"type":"array","description":"(optional) Liste von Preismodifikatoren für diese Position","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"texts":{"type":"array","description":"(optional) Liste von Texten für diese Position","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentText"}},"quantity":{"type":"number","description":"Menge, die in dieser Transaktion verarbeitet werden soll"},"storageId":{"type":"string","description":"(optional) Lager-ID"},"markCompleted":{"type":"boolean","default":false,"description":"Soll die Quellposition nach erfolgreicher Verarbeitung als abgeschlossen markiert werden?"},"supplierAccountId":{"type":"integer","format":"int64","description":"Wird für die Umwandlung von Kundenauftrag in Lieferantenauftrag benötigt"},"bookings":{"type":"array","description":"Buchungen zu dieser Belegposition","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen zu dieser Belegposition","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineCommission"}},"commissionOrigin":{"type":"string","description":"Provisionsherkunft dieser Belegposition","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"lineType":{"type":"string","description":"Typ dieser Position","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"settledOpenItemId":{"type":"string","description":"ID des auszugleichenden Offenen Postens (nur bei OPEN_ITEM_SETTLEMENT)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"ID des Pickwagens für den Wareneingang (wenn `incomingGoodsStorageBinId` = null)"},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"ID des Lagerplatzes für den Wareneingang (wenn `incomingGoodsPickTrolleyId` = null)"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineFabricationDetail"},"doLabelPrint":{"type":"boolean","default":false,"description":"Zu der Zeile Etikettendruck anstoßen"}}},"erp-document-RequestDocumentPriceModifier":{"description":"Die Rabatte des Beleges","properties":{"modifierValue":{"type":"number","description":"modifierValue of this line"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierName":{"type":"string","description":"modifierName of this line"},"modifierType":{"type":"string","description":"type of this price modifier (discount/surcharge)","enum":["DISCOUNT","SURCHARGE"]},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]}},"required":["modifierType","modifierValue","valueType"]},"erp-document-RequestDocumentText":{"description":"(optional) Liste von Texten für diese Position","properties":{"textPosition":{"type":"string","description":"header or footer text","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"text content"}}},"erp-document-RequestDocumentLineBooking":{"description":"Buchungen zu dieser Belegposition","properties":{"sourceComponentId":{"type":"integer","format":"int64","description":"ID der bebuchten Quell-DocumentLineComponent"},"quantity":{"type":"number","description":"Gebuchte Menge"},"storageBinId":{"type":"integer","format":"int64","description":"ID vom bebuchten Lagerplatz"},"serialNumberId":{"type":"integer","format":"int64","description":"Ggf. ID einer zu buchenden Seriennummer"}},"required":["quantity","sourceComponentId","storageBinId"]},"erp-document-RequestDocumentLineCommission":{"description":"Provisionen zu dieser Belegposition","properties":{"salesAgentAccountRef":{"$ref":"#/components/schemas/erp-account-Account"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-account-Account":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"types":{"type":"array","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","items":{"type":"string","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","enum":["CUSTOMER","SUPPLIER","MANUFACTURER","SERVICE_PROVIDER","MERCHANT","SALES_AGENT","COMPANY","PROSPECTIVE"]}},"number":{"type":"string","description":"Address-Number"},"displayName":{"type":"string","description":"Kurzbezeichnung zur Darstellung","readOnly":true},"active":{"type":"boolean","default":true,"description":"Is account active?","readOnly":true},"taxNumber":{"type":"string","description":"tax number/ Steuernummer","maxLength":255,"minLength":0},"remark":{"type":"string","description":"Sonderbemerkung","maxLength":1024,"minLength":0},"note":{"type":"string","description":"Notiz"},"companyLegalRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"address":{"$ref":"#/components/schemas/erp-account-AccountAddress"},"person":{"$ref":"#/components/schemas/erp-account-AccountPerson"},"addresses":{"type":"array","description":"Alle Adressen außer der Standard-Adresse","items":{"$ref":"#/components/schemas/erp-account-AccountAddress"}},"persons":{"type":"array","description":"Ansprechpartner","items":{"$ref":"#/components/schemas/erp-account-AccountPerson"}},"customer":{"$ref":"#/components/schemas/erp-account-Customer"},"supplier":{"$ref":"#/components/schemas/erp-account-Supplier"},"salesAgent":{"$ref":"#/components/schemas/erp-account-SalesAgent"},"manufacturer":{"$ref":"#/components/schemas/erp-account-AccountManufacturer"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"localCourt":{"type":"string","description":"Zuständiges Amtsgericht","maxLength":255,"minLength":0},"companyRegister":{"type":"string","description":"Handelsregister-Kennung","maxLength":255,"minLength":0},"costCenter":{"type":"string","description":"Kostenstelle"},"languageCode":{"type":"string","description":"Sprache des Accounts"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"initialContactAt":{"type":"string","format":"date","description":"Erstkontakt am"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Umkehrung der Steuerschuld nach §13b UStG?"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxIds":{"type":"array","description":"Eine List von Steuernummern","items":{"$ref":"#/components/schemas/erp-account-TaxIdForeignCountry"}},"relations":{"type":"array","description":"Account-Beziehungen","items":{"$ref":"#/components/schemas/erp-account-AccountRelation"}},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"payablesSum":{"type":"number","description":"Summe Verbindlichkeiten","readOnly":true},"payablesSumCurrencyCode":{"type":"string","description":"Währung Summe Verbindlichkeiten IsoAlpha3","readOnly":true},"anonymized":{"type":"boolean","description":"ist der Account anonymisiert?","readOnly":true},"receivablesSum":{"type":"number","description":"Summe Forderungen","readOnly":true},"receivablesSumCurrencyCode":{"type":"string","description":"Währung Summe Forderungen IsoAlpha3","readOnly":true},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"loanCurrencyCode":{"type":"string","description":"Währung Kreditlimit IsoAlpha3","readOnly":true},"accountZoneId":{"type":"string","description":"Zeitzone (bzw. Zeitzonen-Offset) des Accounts","enum":["ACT","AET","AGT","ART","AST","BET","BST","CAT","CNT","CST","CTT","EAT","ECT","IET","IST","JST","MIT","NET","NST","PLT","PNT","PRT","PST","SST","VST","EST","MST","HST"]},"calculationMode":{"type":"string","description":"calculation mode of this document","enum":["HORIZONTAL","VERTICAL"]},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"hasActiveDuplicates":{"type":"boolean","default":false,"description":"Has this Account a possible duplicate"},"businessRelationType":{"type":"string","description":"Geschäftsbeziehungs-Typen für Geschäftspartner","enum":["B2B","B2C","B2G"]}},"required":["address","businessRelationType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-account-AccountAddress":{"description":"Alle Adressen außer der Standard-Adresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"name1":{"type":"string","description":"Name1","maxLength":255,"minLength":0},"name2":{"type":"string","description":"Name2","maxLength":255,"minLength":0},"name3":{"type":"string","description":"Name3","maxLength":255,"minLength":0},"defaultAddress":{"type":"boolean","default":false,"description":"is this the default address of the account","readOnly":true},"types":{"type":"array","description":"the kind of usages for this address","items":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"street":{"type":"string","description":"Street","maxLength":255,"minLength":0},"globalLocationNumber":{"type":"string","description":"GLN/ILN as location identifier for this address","maxLength":255,"minLength":0},"streetAddressNumber":{"type":"string","description":"Street address number","maxLength":255,"minLength":0},"additionalAddressLine1":{"type":"string","description":"Additional address line1","maxLength":255,"minLength":0},"additionalAddressLine2":{"type":"string","description":"Additional address line2","maxLength":255,"minLength":0},"city":{"type":"string","description":"City","maxLength":255,"minLength":0},"postcode":{"type":"string","description":"Postcode","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 Profil","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"taxIdentificationNumber":{"type":"string","description":"tax identification number/ UST-ID-Nr.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"homepageUrl":{"type":"string","description":"Homepage URL"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"countryCode":{"type":"string","description":"Country code"},"longitude":{"type":"number","format":"double","description":"Longitude"},"latitude":{"type":"number","format":"double","description":"latitude"},"remark":{"type":"string","description":"Sonderbemerkung","maxLength":1024,"minLength":0},"postOfficeBox":{"type":"string","description":"Post office box","maxLength":255,"minLength":0},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"eoriNumber":{"type":"string","description":"EORI-Nummer","maxLength":255,"minLength":0},"contacts":{"type":"array","description":"Contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"calculationMode":{"type":"string","description":"calculation mode of this address","enum":["HORIZONTAL","VERTICAL"]},"deviatingPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"languageCode":{"type":"string","description":"Sprache der Adresse"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultForType":{"type":"boolean","default":false,"description":"Standard für den Account-Typ"}},"required":["name1"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-account-Contact":{"description":"List of contacts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"value":{"type":"string","description":"A Value","maxLength":255,"minLength":0},"typeId":{"type":"string","description":"Type identifier"},"type":{"type":"string","description":"Contact type","enum":["PHONE","SOCIAL","EMAIL","FAX","SKYPE","MS_TEAMS","CUSTOM","MOBILE"]},"label":{"type":"string","description":"Contact label","maxLength":255,"minLength":0},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"default":{"type":"boolean","default":false,"description":"Is default contact?"}},"required":["value"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-account-AccountPerson":{"description":"Ansprechpartner","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"comment":{"type":"string","description":"Comment"},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"firstName":{"type":"string","description":"First name","maxLength":255,"minLength":0},"middleName":{"type":"string","description":"Middle name","maxLength":255,"minLength":0},"lastName":{"type":"string","description":"Lastname","maxLength":255,"minLength":0},"gender":{"type":"string","description":"Gender","enum":["MALE","FEMALE","ETC"]},"locale":{"type":"string","description":"Locale","maxLength":255,"minLength":0},"jobArea":{"type":"string","description":"Job area","maxLength":255,"minLength":0},"jobTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth"},"sortOrder":{"type":"integer","format":"int64","description":"sortierreihenfolge"},"remark":{"type":"string","description":"Sonderbemerkung","maxLength":1024,"minLength":0},"contacts":{"type":"array","description":"List of contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactAt":{"type":"string","format":"date","description":"Erstkontakt am"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"defaultPerson":{"type":"boolean","default":false,"description":"Standard-Ansprechpartner","readOnly":true}},"required":["lastName"]},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-account-Customer":{"description":"Customer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"number of customer","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"accountingNumber":{"type":"string","description":"finance account-number of customer","maxLength":255,"minLength":0},"taxable":{"type":"boolean","default":true,"description":"tax able or tax free"},"deliveryBlocked":{"type":"boolean","default":false,"description":"Hat der Kunde eine Liefersperre?"},"billingType":{"type":"string","description":"presetting of billing type","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productPriceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität für die Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"ourNumber":{"type":"string","description":"customers number for us"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"collectiveBillable":{"type":"boolean","default":false,"description":"collective billable"},"collectiveInvoiceManually":{"type":"boolean","default":true,"description":"Sammelabrechnung nur manuell auslösen?"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Sammelabrechnung"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit der nächsten Sammelabrechnung"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit nach der aktuellen"}}},"erp-account-Supplier":{"description":"Supplier of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountingNumber":{"type":"string","description":"finance account-number of supplier","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"dunning":{"type":"boolean","default":false,"description":"Mahnen?"},"number":{"type":"string","description":"number of supplier","maxLength":255,"minLength":0},"ourNumber":{"type":"string","description":"suppliers number for us","maxLength":255,"minLength":0},"billingType":{"type":"string","description":"Fakturisierungsart Netto oder Brutto","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderBlocked":{"type":"boolean","default":false,"description":"Bestellsperre"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultDeliveryTime":{"type":"integer","format":"int32","description":"Lieferzeit in (Werk-)Tagen"},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"taxable":{"type":"boolean","default":true,"description":"tax able or tax free"},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"permissibleForOrderProposal":{"type":"boolean","default":true,"description":"zulässig für Aufnahme in Bestellvorschläge"},"minimumOrderValue":{"type":"number","description":"Mindestbestellwert"},"freeShippingValue":{"type":"number","description":"Frachtkostenfrei ab"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"createCustomerDeliveryWhenDropShipping":{"type":"boolean","default":false,"description":"Erzeugung Ausgangs-Lieferschein bei Streckengeschäft-Bestellung"},"dropShippingAllowed":{"type":"boolean","default":false,"description":"Kennzeichen, ob Streckengeschäft erlaubt"}}},"erp-account-SalesAgent":{"description":"Sales Agent of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"number":{"type":"string","description":"number of sales agent","maxLength":255,"minLength":0},"commissionType":{"type":"string","description":"commission type of sales agent","enum":["INVOICE","ORDER","PAYMENT"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxable":{"type":"boolean","description":"is sales agent taxable"},"accountingNumber":{"type":"string","description":"accounting number"},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"note":{"type":"string","description":"Bemerkung"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["billingType","commissionType","deliveryMethodRef","deliveryTermRef","paymentMethodRef","paymentTermRef","taxRateRef","taxable"]},"erp-account-AccountManufacturer":{"description":"Manufacturer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"labels":{"type":"array","description":"Beschreibungen","items":{"$ref":"#/components/schemas/erp-account-AccountManufacturerDescription"}},"forcedRecommendedRetailPrice":{"type":"boolean","default":false,"description":"Ist der UVP verpflichtend?"}},"required":["labels"]},"erp-account-AccountManufacturerDescription":{"description":"Beschreibungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"languageCode":{"type":"string","description":"Sprache der Beschreibung"},"manufacturerUrl":{"type":"string","description":"Hersteller-URL"}},"required":["label","languageCode"]},"erp-account-TaxIdForeignCountry":{"description":"Eine List von Steuernummern","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxId":{"type":"string","description":"Tax ID of the company in the associated country"},"countryCode":{"type":"string","description":"ISO 2 Code of the country this tax ID is used for"}}},"erp-account-AccountRelation":{"description":"Account-Beziehungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"relatedAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"comment":{"type":"string","description":"Comment"},"relationTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["relatedAccountRef","relationTypeRef"]},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"erp-document-RequestDocumentLineFabricationDetail":{"description":"Details zur verarbeiteten Produktionsbelegposition","properties":{"fabricationSerialNumbers":{"type":"array","description":"Nur füllen, wenn die Seriennummern vor der Start der Produktion manuell bestimmt werden sollen","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}}}},"erp-fabrication-FabricationSerialNumber":{"description":"Zu produzierende Seriennummer","properties":{"quantity":{"type":"number","description":"Abweichende Menge für Chargen"},"serialNumberId":{"type":"integer","format":"int64","description":"ID der zu produzierenden Seriennummer (nur zur gezielten Produktion von bereits definierten Seriennummern)"},"serialNumber1":{"type":"string","description":"Seriennummer 1"},"serialNumber2":{"type":"string","description":"Seriennummer 2"},"expiryDate":{"type":"string","format":"date","description":"MHD / Verfallsdatum"},"note":{"type":"string","description":"Bemerkung"}}},"erp-document-DocumentType":{"description":"target document type for document copy","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"labels":{"type":"array","description":"label/name of this type","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"}},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"showForManualDocumentCreation":{"type":"boolean","default":true,"description":"Darf dieser Typ zur Neuanlage von Belegen verwendet werden?"},"nextNumber":{"type":"string","description":"nächste Belegnummer","maxLength":255,"minLength":0,"readOnly":true},"followUpDocumentTypes":{"type":"array","description":"follow up document types","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeFollowUp"},"readOnly":true},"defaultTypeOfCategory":{"type":"boolean","default":false,"description":"ist diese Belegart die Standard-Belegart für ihre Kategorie?"},"active":{"type":"boolean","default":true,"description":"ist diese Belegart aktiv"},"shelfDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sequencerConfiguration":{"$ref":"#/components/schemas/common-sequencer-SequencerConfiguration"},"requiresBusinessRelationship":{"type":"boolean","default":true,"description":"Geschäftsbeziehung verpflichtend"},"publishingPolicy":{"type":"string","default":"AUTOMATIC","description":"Verhalten zugeordnetem DMS-Dokument","enum":["AUTOMATIC","MANUAL"]},"sortOrder":{"type":"integer","format":"int32","description":"Sortierung"}},"required":["category"]},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)"},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)"}},"required":["label","labelPrintout","languageCode"]},"erp-document-DocumentTypeFollowUp":{"description":"follow up document types","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"sourceDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"ist diese Folge-Belegart aktiv","readOnly":true}},"required":["sourceDocumentTypeRef","targetDocumentTypeRef"]},"common-sequencer-SequencerConfiguration":{"description":"Eigener Zählerkreis für Seriennummern","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Unique key to identify the sequencer configuration","readOnly":true},"configurationGroup":{"type":"string","description":"Group of the sequencer configuration (e.g. Document, Account, ...)","readOnly":true},"configurationDetail":{"$ref":"#/components/schemas/common-sequencer-SequencerConfigurationDetail"},"alternativeConfiguration":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Sequencer aktiv?"}},"required":["configurationDetail"]},"common-sequencer-SequencerConfigurationDetail":{"description":"Contains details about the sequencer configuration","properties":{"type":{"type":"string","description":"Typ der Sequenz","enum":["NON_POOLED_SEQUENCES","POOLED_SEQUENCES","PREFETCHED_SEQUENCES"]},"assignmentMode":{"type":"string","description":"Vergabeverfahren","enum":["MANUAL","AUTOMATIC","SEMI_AUTOMATIC","FREE"]},"length":{"type":"integer","format":"int32","description":"Länge"},"padChar":{"type":"string","description":"Auffüllzeichen","maxLength":1,"minLength":1,"pattern":"^[0-9]*$"},"expression":{"type":"string","description":"Präfix-Ausdruck"},"postExpression":{"type":"string","description":"Postfix-Ausdruck"},"initialValue":{"type":"integer","format":"int64","description":"Initialer Wert"},"numberUnique":{"type":"boolean","default":true,"description":"Eindeutigkeitsprüfung"}},"required":["assignmentMode","initialValue","length","padChar","type"]},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## PUT /erp/documents/{id}/protocol/{protocolId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/protocol/{protocolId}":{"put":{"tags":["Document"],"operationId":"updateManualDocumentProtocolEntry","parameters":[{"name":"id","in":"path","description":"ID des Belegs","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"protocolId","in":"path","description":"ID des Eintrags im Belegprotokoll","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-CreateOrUpdateManualDocumentProtocolRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentProtocol"}}}}}}}},"components":{"schemas":{"erp-document-CreateOrUpdateManualDocumentProtocolRequest":{"description":"Request zur Anlage eines manuellen Eintrags ins Belegprotokoll","properties":{"customMessage":{"type":"string","description":"Text für das Belegprotokoll"}},"required":["customMessage"]},"erp-document-DocumentProtocol":{"description":"Belegprotokoll","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentTypeId":{"type":"integer","format":"int64","description":"Typ des Dokuments zu diesem Protokolleintrag","readOnly":true},"documentTypeLabels":{"type":"array","description":"Label vom Typ des Dokuments zu diesem Protokolleintrag","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"},"readOnly":true},"documentNumber":{"type":"string","description":"Nummer des Dokuments zu diesem Protokolleintrag","readOnly":true},"type":{"type":"string","description":"Eintragsarten im DocumentProtocol","enum":["MANUAL","CREATED","SAVED","BEGIN_EDITING","CANCEL_EDITING","PUBLISHED","FROZEN","NEW_VERSION_STARTED","TRANSFERRED_TO_DELIVERY","TRANSFERRED_FROM_OTHER","TRANSFERRED_TO_OTHER","TRANSFER_CANCELLED","DELETED","IN_PICKING","RESET_FROM_PICKING","COPIED","ELECTRONIC_INVOICE_VALIDATED","FINANCE_BOOKING","CANCELLED","DISSOLVED","DOCUMENT_STATE_MANUALLY_CHANGED","DOCUMENT_MAINTAINED","COMPLETED_WITH_UNDER_DELIVERY","ORDER_REOPENED","REVERT_AFTER_WORKFLOW_FAILURE","ORDER_DELIVERY_APPROVED","ORDER_DELIVERY_UNAPPROVED","DOCUMENT_PRINTED","MANUAL_DUE_DATE_CHANGE","MANUAL_NEXT_DUE_DATE_CHANGE","DROP_SHIPPING_DELIVERY_APPROVED_FOR_INVOICE_DUE_TO_SUPPLIER_DELIVERY","DROP_SHIPPING_DELIVERY_UNAPPROVED_FOR_INVOICE_DUE_TO_DELETION_SUPPLIER_DELIVERY","FABRICATION_STARTED","FABRICATION_CANCELLED","FABRICATION_PAUSED","FABRICATION_RESUMED","FABRICATION_COMPLETED","FABRICATION_RESTARTED","FABRICATION_STARTED_QA","FABRICATION_CANCELLED_QA","FABRICATION_FINISHED_QA","FABRICATION_FINISHED"]},"customMessage":{"type":"string","description":"Text dieses Protokolleintrags"},"localizeableMessage":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"userName":{"type":"string","description":"Benutzer von dem der Eintrag angelegt wurde","readOnly":true},"timestamp":{"type":"string","format":"date-time","description":"Zeitstempel dieses Protokolleintrags"}},"required":["type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)"},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)"}},"required":["label","labelPrintout","languageCode"]},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}}}}} ``` ## GET /erp/documents/{id}/print > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/print":{"get":{"tags":["Document"],"operationId":"getPrintPreview_2","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{}}}}}}}}} ``` ## PUT /erp/documents/{id}/print > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/print":{"put":{"tags":["Document"],"operationId":"printDocument","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/octet-stream":{"schema":{}},"application/json":{"schema":{}}}},"405":{"description":"printing not allowed for the current document state","content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}},"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-output-OutputRequest":{"properties":{"exportFormat":{"type":"string","description":"output-format für mail/file-export","enum":["PDF","XLSX","JSON_RAW","REPORT_TEMPLATE"]},"exportFilename":{"type":"string","description":"filename (ohne extension) bei einem file-export"},"mailRecipients":{"type":"array","description":"Empfänger","items":{"$ref":"#/components/schemas/common-output-OutputRecipient.MailRecipient"}},"outputType":{"type":"string","description":"outputType"},"groupIdentifier":{"type":"string","description":"OutputReportGroup Identifier (optional), sonst Default-Group des Moduls"},"published":{"type":"boolean","default":false,"description":"sollen nur bereits veröffentlichte Dokumente beachtet werden?"}}},"common-output-OutputRecipient.MailRecipient":{"description":"Empfänger","properties":{"type":{"type":"string","description":"(mail) recipient type","enum":["TO","CC","BCC"]},"address":{"type":"string","description":"(mail) recipient address"},"name":{"type":"string","description":"(mail) recipient name"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/documents/{id}/leasable-lock/{lockToken} > Verlängert eine Sperre ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/leasable-lock/{lockToken}":{"put":{"tags":["Document"],"summary":"Verlängert eine Sperre","operationId":"refreshLeasableLock","parameters":[{"name":"id","in":"path","description":"ID der gesperrten Resource","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lockToken","in":"path","description":"Token der zu verlängernden Sperre","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"leasePeriod","in":"query","description":"Optionale Lease-Dauer in Sekunden","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-unknownmodule-LeasableLock"}}}}}}}},"components":{"schemas":{"core-unknownmodule-LeasableLock":{"properties":{"key":{"type":"string"},"token":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"},"lockedBySystem":{"type":"boolean"},"validUntil":{"type":"string","format":"date-time"},"id":{"type":"string","description":"Unique identifier of the Object","readOnly":true}},"required":["key","token"]}}}} ``` ## DELETE /erp/documents/{id}/leasable-lock/{lockToken} > Gibt ein Sperre frei ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/leasable-lock/{lockToken}":{"delete":{"tags":["Document"],"summary":"Gibt ein Sperre frei","operationId":"releaseLeasableLock","parameters":[{"name":"id","in":"path","description":"ID der gesperrten Resource","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lockToken","in":"path","description":"Token der freizugebenden Sperre","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## PUT /erp/documents/{documentId}/parcel/{parcelId} > Aktualisiert ein Paket zu einem Beleg ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{documentId}/parcel/{parcelId}":{"put":{"tags":["Document"],"summary":"Aktualisiert ein Paket zu einem Beleg","operationId":"createOrUpdateParcel","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"parcelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}}}}}}},"components":{"schemas":{"erp-document-DocumentParcel":{"description":"Pakete zu Belegen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentRef":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"position":{"type":"integer","format":"int32","description":"Position des Pakets"},"weight":{"type":"number","description":"Gewicht des Pakets"},"weightUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"length":{"type":"number","description":"Länge"},"width":{"type":"number","description":"Breite"},"height":{"type":"number","description":"Höhe"},"sizeUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"trackingNumber":{"type":"string","description":"Trackingnummer","readOnly":true},"lines":{"type":"array","description":"Inhalt des Pakets","items":{"$ref":"#/components/schemas/erp-document-DocumentParcelLine"}}},"required":["documentRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-document-DocumentParcelLine":{"description":"Inhalt der Pakete zu Belegen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineBookingId":{"type":"integer","format":"int64","description":"Referenz zur Belegpositionsbuchung"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Menge"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/documents/document/{documentId}/line/{lineId} > update an existing document with changed position ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}":{"put":{"tags":["Document"],"summary":"update an existing document with changed position","operationId":"updateDocumentLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentPartialUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentPartialUpdateRequest":{"properties":{"documentLine":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"additionalParameters":{"type":"array","description":"Zusätzliche Parameter und Benutzerentscheidungen","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}}},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## DELETE /erp/documents/document/{documentId}/line/{lineId} > delete a line ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}":{"delete":{"tags":["Document"],"summary":"delete a line","operationId":"deleteLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## PUT /erp/documents/document/{documentId}/line/{lineId}/move/{position} > moves a line to a new position ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}/move/{position}":{"put":{"tags":["Document"],"summary":"moves a line to a new position","operationId":"moveLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"position","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## GET /erp/documents/document/{documentId}/line/{lineId}/financebooking > get finance booking information for documentLine ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}/financebooking":{"get":{"tags":["Document"],"summary":"get finance booking information for documentLine","operationId":"getFinanceBookingForDocumentLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"}}}}}}}},"components":{"schemas":{"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## PUT /erp/documents/document/{documentId}/line/{lineId}/financebooking > update finance booking information for documentLine ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}/financebooking":{"put":{"tags":["Document"],"summary":"update finance booking information for documentLine","operationId":"updateFinanceBookingForDocumentLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"}}}}}}}},"components":{"schemas":{"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## DELETE /erp/documents/document/{documentId}/line/{lineId}/financebooking > delete finance booking information for documentLine ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/document/{documentId}/line/{lineId}/financebooking":{"delete":{"tags":["Document"],"summary":"delete finance booking information for documentLine","operationId":"deleteFinanceBookingForDocumentLine","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## POST /erp/documents/{id}/verifyTaxId > verify the taxIdentificationNumber ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/verifyTaxId":{"post":{"tags":["Document"],"summary":"verify the taxIdentificationNumber","operationId":"verifyTaxId","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-account-TaxIDProtocol"}}}}}}}},"components":{"schemas":{"erp-account-TaxIDProtocol":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentAddressRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxIdentificationNumber":{"type":"string","description":"Geprüfte Ust-ID","maxLength":255,"minLength":0},"validity":{"type":"string","description":"Gültigkeit einer Ust-ID","enum":["NOT_YET_VALIDATED","VALID","VALID_WITH_INVALID_ADDRESS","NOT_VALID"]},"validatedCompanyName":{"type":"string","description":"Geprüfter Firmenname"},"companyNameValidationResult":{"type":"string","description":"Ergebnis der Detail-Prüfung einer Ust-ID","enum":["VALID","NOT_VALID","NOT_REQUESTED","NOT_DELIVERED","UNKNOWN"]},"validatedCity":{"type":"string","description":"Geprüfter Ort"},"cityValidationResult":{"type":"string","description":"Ergebnis der Detail-Prüfung einer Ust-ID","enum":["VALID","NOT_VALID","NOT_REQUESTED","NOT_DELIVERED","UNKNOWN"]},"validatedPostalCode":{"type":"string","description":"Geprüfte PLZ"},"postalCodeValidationResult":{"type":"string","description":"Ergebnis der Detail-Prüfung einer Ust-ID","enum":["VALID","NOT_VALID","NOT_REQUESTED","NOT_DELIVERED","UNKNOWN"]},"validatedStreet":{"type":"string","description":"Geprüfte Straße"},"streetValidationResult":{"type":"string","description":"Ergebnis der Detail-Prüfung einer Ust-ID","enum":["VALID","NOT_VALID","NOT_REQUESTED","NOT_DELIVERED","UNKNOWN"]},"usedApi":{"type":"string","description":"USt-ID Prüfverfahren","enum":["NONE","BZST","VIES"]},"apiResultCode":{"type":"string","description":"Ergebnis-Code der Prüfung"},"apiResultMessage":{"type":"string","description":"Ergebnis-Meldung der Prüfung (falls vorhanden"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/documents/{id}/types > list all available document-type-states to clone the current object into ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/types":{"get":{"tags":["Document"],"summary":"list all available document-type-states to clone the current object into","operationId":"getPossibleTypeClones","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"languageCode","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentTransitionRef"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentTransitionRef":{"properties":{"id":{"type":"string","description":"das gleiche wie transition id für das UI"},"transitionId":{"type":"string","description":"transition id"},"transitionLabel":{"type":"string","description":"label of this transition","readOnly":true},"uiHint":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stateDefinition":{"type":"string","description":"state definition of the target state","readOnly":true},"typeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"typeId":{"type":"string","description":"document-type-id des ziels","readOnly":true},"typeKey":{"type":"string","description":"document-type-key des ziels","readOnly":true},"typeLabel":{"type":"string","description":"type-label","readOnly":true},"isDefaultTypeForCategory":{"type":"boolean","description":"document-type ist Default für die Kategorie","readOnly":true},"targetState":{"type":"string","description":"Der Ziel-Status der Transition","readOnly":true},"sortOrder":{"type":"integer","format":"int32","description":"Sortier-Reihenfolge","readOnly":true}},"required":["id","transitionId"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/documents/{id}/types > create a new document, based on an existing one ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/types":{"post":{"tags":["Document"],"summary":"create a new document, based on an existing one","operationId":"transformDocument","parameters":[{"name":"id","in":"path","description":"the document identifier used as spec for the new document","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentTypeTransitionRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentTypeTransitionRequest":{"properties":{"transitionId":{"type":"string","description":"transition id"},"targetTypeId":{"type":"integer","format":"int64","description":"Ggf. die ID der Ziel-Belegart"},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"document":{"$ref":"#/components/schemas/erp-document-RequestDocument"}},"required":["transitionId"]},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-RequestDocument":{"description":"Details zum zu erstellenden oder zu bearbeitenden Beleg","properties":{"accountId":{"type":"string","description":"account-id to create a new Document"},"salesChannelId":{"type":"string","description":"sales-channel-id to create a new Document"},"externalId":{"type":"string","description":"reference to the corresponding document in an external system"},"externalNumber":{"type":"string","description":"externe Belegnummer"},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"calculationMode":{"type":"string","description":"calculation mode","enum":["HORIZONTAL","VERTICAL"]},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"supplierAccountId":{"type":"integer","format":"int64","description":"Vorgabelieferant bei Übernahme von Auftrag zu Bestellung(en)"},"lines":{"type":"array","description":"Dokumentzeilen","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLine"}},"targetDocumentType":{"$ref":"#/components/schemas/erp-document-DocumentType"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"ID vom Pickwagen für den Wareneingang (wenn incomingGoodsStorageBinId = null)"},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"ID vom Lagerplatz für den Wareneingang (wenn incomingGoodsPickTrolleyId = null)"},"priceModifiers":{"type":"array","description":"Die Rabatte des Beleges","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"posRegisterId":{"type":"integer","format":"int64","description":"ID der Kasse (bei POS)"},"cashDrawerId":{"type":"integer","format":"int64","description":"ID der Kassenschublade (bei POS)"},"depositPaymentAmount":{"type":"number","description":"Der Anzahlungsbetrag"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"posPayments":{"type":"array","description":"Eine oder mehr Kassenzahlungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"texts":{"type":"array","description":"Kopf-/Fußtexte des Belegs","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"einvoice":{"type":"boolean"}}},"erp-document-RequestDocumentLine":{"description":"Details zum zu erstellenden oder zu bearbeitenden Beleg","properties":{"name":{"type":"string","description":"Artikelname"},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer der Artikel"},"description":{"type":"string","description":"Artikelbeschreibung"},"lineId":{"type":"string","description":"ID der Belegposition im aktuellen Beleg"},"sourceLineId":{"type":"string","description":"ID der Quell-Belegposition"},"refLineId":{"type":"string","description":"(optional) ID der referenzierten Belegposition"},"articleId":{"type":"string","description":"(optional) ID des Artikels dieser Position"},"externalId":{"type":"string","description":"Referenz auf die zugehörige Position in einem externen System"},"productPrice":{"type":"number","description":"(optional) Preis des Artikels dieser Position"},"totalLinePrice":{"type":"number","description":"(optional) Gesamtpreis dieser Position"},"priceModifiers":{"type":"array","description":"(optional) Liste von Preismodifikatoren für diese Position","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentPriceModifier"}},"texts":{"type":"array","description":"(optional) Liste von Texten für diese Position","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentText"}},"quantity":{"type":"number","description":"Menge, die in dieser Transaktion verarbeitet werden soll"},"storageId":{"type":"string","description":"(optional) Lager-ID"},"markCompleted":{"type":"boolean","default":false,"description":"Soll die Quellposition nach erfolgreicher Verarbeitung als abgeschlossen markiert werden?"},"supplierAccountId":{"type":"integer","format":"int64","description":"Wird für die Umwandlung von Kundenauftrag in Lieferantenauftrag benötigt"},"bookings":{"type":"array","description":"Buchungen zu dieser Belegposition","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen zu dieser Belegposition","items":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineCommission"}},"commissionOrigin":{"type":"string","description":"Provisionsherkunft dieser Belegposition","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"lineType":{"type":"string","description":"Typ dieser Position","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"settledOpenItemId":{"type":"string","description":"ID des auszugleichenden Offenen Postens (nur bei OPEN_ITEM_SETTLEMENT)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"incomingGoodsPickTrolleyId":{"type":"integer","format":"int64","description":"ID des Pickwagens für den Wareneingang (wenn `incomingGoodsStorageBinId` = null)"},"incomingGoodsStorageBinId":{"type":"integer","format":"int64","description":"ID des Lagerplatzes für den Wareneingang (wenn `incomingGoodsPickTrolleyId` = null)"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineFabricationDetail"},"doLabelPrint":{"type":"boolean","default":false,"description":"Zu der Zeile Etikettendruck anstoßen"}}},"erp-document-RequestDocumentPriceModifier":{"description":"Die Rabatte des Beleges","properties":{"modifierValue":{"type":"number","description":"modifierValue of this line"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierName":{"type":"string","description":"modifierName of this line"},"modifierType":{"type":"string","description":"type of this price modifier (discount/surcharge)","enum":["DISCOUNT","SURCHARGE"]},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]}},"required":["modifierType","modifierValue","valueType"]},"erp-document-RequestDocumentText":{"description":"(optional) Liste von Texten für diese Position","properties":{"textPosition":{"type":"string","description":"header or footer text","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"text content"}}},"erp-document-RequestDocumentLineBooking":{"description":"Buchungen zu dieser Belegposition","properties":{"sourceComponentId":{"type":"integer","format":"int64","description":"ID der bebuchten Quell-DocumentLineComponent"},"quantity":{"type":"number","description":"Gebuchte Menge"},"storageBinId":{"type":"integer","format":"int64","description":"ID vom bebuchten Lagerplatz"},"serialNumberId":{"type":"integer","format":"int64","description":"Ggf. ID einer zu buchenden Seriennummer"}},"required":["quantity","sourceComponentId","storageBinId"]},"erp-document-RequestDocumentLineCommission":{"description":"Provisionen zu dieser Belegposition","properties":{"salesAgentAccountRef":{"$ref":"#/components/schemas/erp-account-Account"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-account-Account":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"types":{"type":"array","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","items":{"type":"string","description":"list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ","enum":["CUSTOMER","SUPPLIER","MANUFACTURER","SERVICE_PROVIDER","MERCHANT","SALES_AGENT","COMPANY","PROSPECTIVE"]}},"number":{"type":"string","description":"Address-Number"},"displayName":{"type":"string","description":"Kurzbezeichnung zur Darstellung","readOnly":true},"active":{"type":"boolean","default":true,"description":"Is account active?","readOnly":true},"taxNumber":{"type":"string","description":"tax number/ Steuernummer","maxLength":255,"minLength":0},"remark":{"type":"string","description":"Sonderbemerkung","maxLength":1024,"minLength":0},"note":{"type":"string","description":"Notiz"},"companyLegalRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"address":{"$ref":"#/components/schemas/erp-account-AccountAddress"},"person":{"$ref":"#/components/schemas/erp-account-AccountPerson"},"addresses":{"type":"array","description":"Alle Adressen außer der Standard-Adresse","items":{"$ref":"#/components/schemas/erp-account-AccountAddress"}},"persons":{"type":"array","description":"Ansprechpartner","items":{"$ref":"#/components/schemas/erp-account-AccountPerson"}},"customer":{"$ref":"#/components/schemas/erp-account-Customer"},"supplier":{"$ref":"#/components/schemas/erp-account-Supplier"},"salesAgent":{"$ref":"#/components/schemas/erp-account-SalesAgent"},"manufacturer":{"$ref":"#/components/schemas/erp-account-AccountManufacturer"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"localCourt":{"type":"string","description":"Zuständiges Amtsgericht","maxLength":255,"minLength":0},"companyRegister":{"type":"string","description":"Handelsregister-Kennung","maxLength":255,"minLength":0},"costCenter":{"type":"string","description":"Kostenstelle"},"languageCode":{"type":"string","description":"Sprache des Accounts"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"initialContactAt":{"type":"string","format":"date","description":"Erstkontakt am"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Umkehrung der Steuerschuld nach §13b UStG?"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxIds":{"type":"array","description":"Eine List von Steuernummern","items":{"$ref":"#/components/schemas/erp-account-TaxIdForeignCountry"}},"relations":{"type":"array","description":"Account-Beziehungen","items":{"$ref":"#/components/schemas/erp-account-AccountRelation"}},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"payablesSum":{"type":"number","description":"Summe Verbindlichkeiten","readOnly":true},"payablesSumCurrencyCode":{"type":"string","description":"Währung Summe Verbindlichkeiten IsoAlpha3","readOnly":true},"anonymized":{"type":"boolean","description":"ist der Account anonymisiert?","readOnly":true},"receivablesSum":{"type":"number","description":"Summe Forderungen","readOnly":true},"receivablesSumCurrencyCode":{"type":"string","description":"Währung Summe Forderungen IsoAlpha3","readOnly":true},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"loanCurrencyCode":{"type":"string","description":"Währung Kreditlimit IsoAlpha3","readOnly":true},"accountZoneId":{"type":"string","description":"Zeitzone (bzw. Zeitzonen-Offset) des Accounts","enum":["ACT","AET","AGT","ART","AST","BET","BST","CAT","CNT","CST","CTT","EAT","ECT","IET","IST","JST","MIT","NET","NST","PLT","PNT","PRT","PST","SST","VST","EST","MST","HST"]},"calculationMode":{"type":"string","description":"calculation mode of this document","enum":["HORIZONTAL","VERTICAL"]},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"hasActiveDuplicates":{"type":"boolean","default":false,"description":"Has this Account a possible duplicate"},"businessRelationType":{"type":"string","description":"Geschäftsbeziehungs-Typen für Geschäftspartner","enum":["B2B","B2C","B2G"]}},"required":["address","businessRelationType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-account-AccountAddress":{"description":"Alle Adressen außer der Standard-Adresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"name1":{"type":"string","description":"Name1","maxLength":255,"minLength":0},"name2":{"type":"string","description":"Name2","maxLength":255,"minLength":0},"name3":{"type":"string","description":"Name3","maxLength":255,"minLength":0},"defaultAddress":{"type":"boolean","default":false,"description":"is this the default address of the account","readOnly":true},"types":{"type":"array","description":"the kind of usages for this address","items":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"street":{"type":"string","description":"Street","maxLength":255,"minLength":0},"globalLocationNumber":{"type":"string","description":"GLN/ILN as location identifier for this address","maxLength":255,"minLength":0},"streetAddressNumber":{"type":"string","description":"Street address number","maxLength":255,"minLength":0},"additionalAddressLine1":{"type":"string","description":"Additional address line1","maxLength":255,"minLength":0},"additionalAddressLine2":{"type":"string","description":"Additional address line2","maxLength":255,"minLength":0},"city":{"type":"string","description":"City","maxLength":255,"minLength":0},"postcode":{"type":"string","description":"Postcode","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931 Profil","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"taxIdentificationNumber":{"type":"string","description":"tax identification number/ UST-ID-Nr.","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"homepageUrl":{"type":"string","description":"Homepage URL"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"countryCode":{"type":"string","description":"Country code"},"longitude":{"type":"number","format":"double","description":"Longitude"},"latitude":{"type":"number","format":"double","description":"latitude"},"remark":{"type":"string","description":"Sonderbemerkung","maxLength":1024,"minLength":0},"postOfficeBox":{"type":"string","description":"Post office box","maxLength":255,"minLength":0},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"eoriNumber":{"type":"string","description":"EORI-Nummer","maxLength":255,"minLength":0},"contacts":{"type":"array","description":"Contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"calculationMode":{"type":"string","description":"calculation mode of this address","enum":["HORIZONTAL","VERTICAL"]},"deviatingPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deviatingDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"languageCode":{"type":"string","description":"Sprache der Adresse"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultForType":{"type":"boolean","default":false,"description":"Standard für den Account-Typ"}},"required":["name1"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-account-Contact":{"description":"List of contacts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"value":{"type":"string","description":"A Value","maxLength":255,"minLength":0},"typeId":{"type":"string","description":"Type identifier"},"type":{"type":"string","description":"Contact type","enum":["PHONE","SOCIAL","EMAIL","FAX","SKYPE","MS_TEAMS","CUSTOM","MOBILE"]},"label":{"type":"string","description":"Contact label","maxLength":255,"minLength":0},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"default":{"type":"boolean","default":false,"description":"Is default contact?"}},"required":["value"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-account-AccountPerson":{"description":"Ansprechpartner","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"comment":{"type":"string","description":"Comment"},"salutationRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"titleRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"firstName":{"type":"string","description":"First name","maxLength":255,"minLength":0},"middleName":{"type":"string","description":"Middle name","maxLength":255,"minLength":0},"lastName":{"type":"string","description":"Lastname","maxLength":255,"minLength":0},"gender":{"type":"string","description":"Gender","enum":["MALE","FEMALE","ETC"]},"locale":{"type":"string","description":"Locale","maxLength":255,"minLength":0},"jobArea":{"type":"string","description":"Job area","maxLength":255,"minLength":0},"jobTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"dateOfBirth":{"type":"string","format":"date","description":"Date of birth"},"sortOrder":{"type":"integer","format":"int64","description":"sortierreihenfolge"},"remark":{"type":"string","description":"Sonderbemerkung","maxLength":1024,"minLength":0},"contacts":{"type":"array","description":"List of contacts","items":{"$ref":"#/components/schemas/erp-account-Contact"}},"defaultContacts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-account-Contact"},"description":"Default contacts","readOnly":true},"initialContactTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"initialContactAt":{"type":"string","format":"date","description":"Erstkontakt am"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"defaultPerson":{"type":"boolean","default":false,"description":"Standard-Ansprechpartner","readOnly":true}},"required":["lastName"]},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-account-Customer":{"description":"Customer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"number of customer","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"accountingNumber":{"type":"string","description":"finance account-number of customer","maxLength":255,"minLength":0},"taxable":{"type":"boolean","default":true,"description":"tax able or tax free"},"deliveryBlocked":{"type":"boolean","default":false,"description":"Hat der Kunde eine Liefersperre?"},"billingType":{"type":"string","description":"presetting of billing type","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productPriceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität für die Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"ourNumber":{"type":"string","description":"customers number for us"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"collectiveBillable":{"type":"boolean","default":false,"description":"collective billable"},"collectiveInvoiceManually":{"type":"boolean","default":true,"description":"Sammelabrechnung nur manuell auslösen?"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Sammelabrechnung"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit der nächsten Sammelabrechnung"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit nach der aktuellen"}}},"erp-account-Supplier":{"description":"Supplier of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountingNumber":{"type":"string","description":"finance account-number of supplier","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"dunning":{"type":"boolean","default":false,"description":"Mahnen?"},"number":{"type":"string","description":"number of supplier","maxLength":255,"minLength":0},"ourNumber":{"type":"string","description":"suppliers number for us","maxLength":255,"minLength":0},"billingType":{"type":"string","description":"Fakturisierungsart Netto oder Brutto","enum":["GROSS","NET"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderBlocked":{"type":"boolean","default":false,"description":"Bestellsperre"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultDeliveryTime":{"type":"integer","format":"int32","description":"Lieferzeit in (Werk-)Tagen"},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"taxable":{"type":"boolean","default":true,"description":"tax able or tax free"},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"permissibleForOrderProposal":{"type":"boolean","default":true,"description":"zulässig für Aufnahme in Bestellvorschläge"},"minimumOrderValue":{"type":"number","description":"Mindestbestellwert"},"freeShippingValue":{"type":"number","description":"Frachtkostenfrei ab"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"createCustomerDeliveryWhenDropShipping":{"type":"boolean","default":false,"description":"Erzeugung Ausgangs-Lieferschein bei Streckengeschäft-Bestellung"},"dropShippingAllowed":{"type":"boolean","default":false,"description":"Kennzeichen, ob Streckengeschäft erlaubt"}}},"erp-account-SalesAgent":{"description":"Sales Agent of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"number":{"type":"string","description":"number of sales agent","maxLength":255,"minLength":0},"commissionType":{"type":"string","description":"commission type of sales agent","enum":["INVOICE","ORDER","PAYMENT"]},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxable":{"type":"boolean","description":"is sales agent taxable"},"accountingNumber":{"type":"string","description":"accounting number"},"billingType":{"type":"string","description":"billing type","enum":["GROSS","NET"]},"performanceCountryCode":{"type":"string","description":"country code performance country IsoAlpha3"},"note":{"type":"string","description":"Bemerkung"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"currencyCode":{"type":"string","description":"currency code IsoAlpha3"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["billingType","commissionType","deliveryMethodRef","deliveryTermRef","paymentMethodRef","paymentTermRef","taxRateRef","taxable"]},"erp-account-AccountManufacturer":{"description":"Manufacturer of this account","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active true/false","readOnly":true},"labels":{"type":"array","description":"Beschreibungen","items":{"$ref":"#/components/schemas/erp-account-AccountManufacturerDescription"}},"forcedRecommendedRetailPrice":{"type":"boolean","default":false,"description":"Ist der UVP verpflichtend?"}},"required":["labels"]},"erp-account-AccountManufacturerDescription":{"description":"Beschreibungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"languageCode":{"type":"string","description":"Sprache der Beschreibung"},"manufacturerUrl":{"type":"string","description":"Hersteller-URL"}},"required":["label","languageCode"]},"erp-account-TaxIdForeignCountry":{"description":"Eine List von Steuernummern","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxId":{"type":"string","description":"Tax ID of the company in the associated country"},"countryCode":{"type":"string","description":"ISO 2 Code of the country this tax ID is used for"}}},"erp-account-AccountRelation":{"description":"Account-Beziehungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"relatedAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"comment":{"type":"string","description":"Comment"},"relationTypeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["relatedAccountRef","relationTypeRef"]},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"erp-document-RequestDocumentLineFabricationDetail":{"description":"Details zur verarbeiteten Produktionsbelegposition","properties":{"fabricationSerialNumbers":{"type":"array","description":"Nur füllen, wenn die Seriennummern vor der Start der Produktion manuell bestimmt werden sollen","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}}}},"erp-fabrication-FabricationSerialNumber":{"description":"Zu produzierende Seriennummer","properties":{"quantity":{"type":"number","description":"Abweichende Menge für Chargen"},"serialNumberId":{"type":"integer","format":"int64","description":"ID der zu produzierenden Seriennummer (nur zur gezielten Produktion von bereits definierten Seriennummern)"},"serialNumber1":{"type":"string","description":"Seriennummer 1"},"serialNumber2":{"type":"string","description":"Seriennummer 2"},"expiryDate":{"type":"string","format":"date","description":"MHD / Verfallsdatum"},"note":{"type":"string","description":"Bemerkung"}}},"erp-document-DocumentType":{"description":"target document type for document copy","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"labels":{"type":"array","description":"label/name of this type","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"}},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"showForManualDocumentCreation":{"type":"boolean","default":true,"description":"Darf dieser Typ zur Neuanlage von Belegen verwendet werden?"},"nextNumber":{"type":"string","description":"nächste Belegnummer","maxLength":255,"minLength":0,"readOnly":true},"followUpDocumentTypes":{"type":"array","description":"follow up document types","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeFollowUp"},"readOnly":true},"defaultTypeOfCategory":{"type":"boolean","default":false,"description":"ist diese Belegart die Standard-Belegart für ihre Kategorie?"},"active":{"type":"boolean","default":true,"description":"ist diese Belegart aktiv"},"shelfDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sequencerConfiguration":{"$ref":"#/components/schemas/common-sequencer-SequencerConfiguration"},"requiresBusinessRelationship":{"type":"boolean","default":true,"description":"Geschäftsbeziehung verpflichtend"},"publishingPolicy":{"type":"string","default":"AUTOMATIC","description":"Verhalten zugeordnetem DMS-Dokument","enum":["AUTOMATIC","MANUAL"]},"sortOrder":{"type":"integer","format":"int32","description":"Sortierung"}},"required":["category"]},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)"},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)"}},"required":["label","labelPrintout","languageCode"]},"erp-document-DocumentTypeFollowUp":{"description":"follow up document types","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"sourceDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"ist diese Folge-Belegart aktiv","readOnly":true}},"required":["sourceDocumentTypeRef","targetDocumentTypeRef"]},"common-sequencer-SequencerConfiguration":{"description":"Eigener Zählerkreis für Seriennummern","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Unique key to identify the sequencer configuration","readOnly":true},"configurationGroup":{"type":"string","description":"Group of the sequencer configuration (e.g. Document, Account, ...)","readOnly":true},"configurationDetail":{"$ref":"#/components/schemas/common-sequencer-SequencerConfigurationDetail"},"alternativeConfiguration":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Sequencer aktiv?"}},"required":["configurationDetail"]},"common-sequencer-SequencerConfigurationDetail":{"description":"Contains details about the sequencer configuration","properties":{"type":{"type":"string","description":"Typ der Sequenz","enum":["NON_POOLED_SEQUENCES","POOLED_SEQUENCES","PREFETCHED_SEQUENCES"]},"assignmentMode":{"type":"string","description":"Vergabeverfahren","enum":["MANUAL","AUTOMATIC","SEMI_AUTOMATIC","FREE"]},"length":{"type":"integer","format":"int32","description":"Länge"},"padChar":{"type":"string","description":"Auffüllzeichen","maxLength":1,"minLength":1,"pattern":"^[0-9]*$"},"expression":{"type":"string","description":"Präfix-Ausdruck"},"postExpression":{"type":"string","description":"Postfix-Ausdruck"},"initialValue":{"type":"integer","format":"int64","description":"Initialer Wert"},"numberUnique":{"type":"boolean","default":true,"description":"Eindeutigkeitsprüfung"}},"required":["assignmentMode","initialValue","length","padChar","type"]},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## POST /erp/documents/{id}/shipment > Creates a shipment within the vds from a given document id ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/shipment":{"post":{"tags":["Document"],"summary":"Creates a shipment within the vds from a given document id","operationId":"createShipment","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-spi-CreateShipmentResponse"}}}}}}}},"components":{"schemas":{"erp-spi-CreateShipmentResponse":{"properties":{"shipmentId":{"type":"integer","format":"int64","description":"description/delivery Text of this order (internal vds description)"}}}}}} ``` ## GET /erp/documents/{id}/protocol > Lists all protocol entries for this document ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/protocol":{"get":{"tags":["Document"],"summary":"Lists all protocol entries for this document","operationId":"getDocumentProtocolEntries","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentProtocol"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentProtocol":{"description":"Belegprotokoll","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentTypeId":{"type":"integer","format":"int64","description":"Typ des Dokuments zu diesem Protokolleintrag","readOnly":true},"documentTypeLabels":{"type":"array","description":"Label vom Typ des Dokuments zu diesem Protokolleintrag","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"},"readOnly":true},"documentNumber":{"type":"string","description":"Nummer des Dokuments zu diesem Protokolleintrag","readOnly":true},"type":{"type":"string","description":"Eintragsarten im DocumentProtocol","enum":["MANUAL","CREATED","SAVED","BEGIN_EDITING","CANCEL_EDITING","PUBLISHED","FROZEN","NEW_VERSION_STARTED","TRANSFERRED_TO_DELIVERY","TRANSFERRED_FROM_OTHER","TRANSFERRED_TO_OTHER","TRANSFER_CANCELLED","DELETED","IN_PICKING","RESET_FROM_PICKING","COPIED","ELECTRONIC_INVOICE_VALIDATED","FINANCE_BOOKING","CANCELLED","DISSOLVED","DOCUMENT_STATE_MANUALLY_CHANGED","DOCUMENT_MAINTAINED","COMPLETED_WITH_UNDER_DELIVERY","ORDER_REOPENED","REVERT_AFTER_WORKFLOW_FAILURE","ORDER_DELIVERY_APPROVED","ORDER_DELIVERY_UNAPPROVED","DOCUMENT_PRINTED","MANUAL_DUE_DATE_CHANGE","MANUAL_NEXT_DUE_DATE_CHANGE","DROP_SHIPPING_DELIVERY_APPROVED_FOR_INVOICE_DUE_TO_SUPPLIER_DELIVERY","DROP_SHIPPING_DELIVERY_UNAPPROVED_FOR_INVOICE_DUE_TO_DELETION_SUPPLIER_DELIVERY","FABRICATION_STARTED","FABRICATION_CANCELLED","FABRICATION_PAUSED","FABRICATION_RESUMED","FABRICATION_COMPLETED","FABRICATION_RESTARTED","FABRICATION_STARTED_QA","FABRICATION_CANCELLED_QA","FABRICATION_FINISHED_QA","FABRICATION_FINISHED"]},"customMessage":{"type":"string","description":"Text dieses Protokolleintrags"},"localizeableMessage":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"userName":{"type":"string","description":"Benutzer von dem der Eintrag angelegt wurde","readOnly":true},"timestamp":{"type":"string","format":"date-time","description":"Zeitstempel dieses Protokolleintrags"}},"required":["type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)"},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)"}},"required":["label","labelPrintout","languageCode"]},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}}}}} ``` ## POST /erp/documents/{id}/protocol > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/protocol":{"post":{"tags":["Document"],"operationId":"addManualDocumentProtocolEntry","parameters":[{"name":"id","in":"path","description":"ID des Belegs","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-CreateOrUpdateManualDocumentProtocolRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentProtocol"}}}}}}}},"components":{"schemas":{"erp-document-CreateOrUpdateManualDocumentProtocolRequest":{"description":"Request zur Anlage eines manuellen Eintrags ins Belegprotokoll","properties":{"customMessage":{"type":"string","description":"Text für das Belegprotokoll"}},"required":["customMessage"]},"erp-document-DocumentProtocol":{"description":"Belegprotokoll","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentTypeId":{"type":"integer","format":"int64","description":"Typ des Dokuments zu diesem Protokolleintrag","readOnly":true},"documentTypeLabels":{"type":"array","description":"Label vom Typ des Dokuments zu diesem Protokolleintrag","items":{"$ref":"#/components/schemas/erp-document-DocumentTypeLabel"},"readOnly":true},"documentNumber":{"type":"string","description":"Nummer des Dokuments zu diesem Protokolleintrag","readOnly":true},"type":{"type":"string","description":"Eintragsarten im DocumentProtocol","enum":["MANUAL","CREATED","SAVED","BEGIN_EDITING","CANCEL_EDITING","PUBLISHED","FROZEN","NEW_VERSION_STARTED","TRANSFERRED_TO_DELIVERY","TRANSFERRED_FROM_OTHER","TRANSFERRED_TO_OTHER","TRANSFER_CANCELLED","DELETED","IN_PICKING","RESET_FROM_PICKING","COPIED","ELECTRONIC_INVOICE_VALIDATED","FINANCE_BOOKING","CANCELLED","DISSOLVED","DOCUMENT_STATE_MANUALLY_CHANGED","DOCUMENT_MAINTAINED","COMPLETED_WITH_UNDER_DELIVERY","ORDER_REOPENED","REVERT_AFTER_WORKFLOW_FAILURE","ORDER_DELIVERY_APPROVED","ORDER_DELIVERY_UNAPPROVED","DOCUMENT_PRINTED","MANUAL_DUE_DATE_CHANGE","MANUAL_NEXT_DUE_DATE_CHANGE","DROP_SHIPPING_DELIVERY_APPROVED_FOR_INVOICE_DUE_TO_SUPPLIER_DELIVERY","DROP_SHIPPING_DELIVERY_UNAPPROVED_FOR_INVOICE_DUE_TO_DELETION_SUPPLIER_DELIVERY","FABRICATION_STARTED","FABRICATION_CANCELLED","FABRICATION_PAUSED","FABRICATION_RESUMED","FABRICATION_COMPLETED","FABRICATION_RESTARTED","FABRICATION_STARTED_QA","FABRICATION_CANCELLED_QA","FABRICATION_FINISHED_QA","FABRICATION_FINISHED"]},"customMessage":{"type":"string","description":"Text dieses Protokolleintrags"},"localizeableMessage":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"userName":{"type":"string","description":"Benutzer von dem der Eintrag angelegt wurde","readOnly":true},"timestamp":{"type":"string","format":"date-time","description":"Zeitstempel dieses Protokolleintrags"}},"required":["type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentTypeLabel":{"description":"label/name of this type","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCode":{"type":"string","description":"Language code"},"label":{"type":"string","description":"label/name of this type (for display)"},"labelPrintout":{"type":"string","description":"label/name of this type (for printout)"}},"required":["label","labelPrintout","languageCode"]},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}}}}} ``` ## GET /erp/documents/{id}/leasable-lock > Prüft, ob eine Resource gesperrt ist ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/leasable-lock":{"get":{"tags":["Document"],"summary":"Prüft, ob eine Resource gesperrt ist","operationId":"getLeasableLock","parameters":[{"name":"id","in":"path","description":"ID einer Resource","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-unknownmodule-LeasableLock"}}}}}}}},"components":{"schemas":{"core-unknownmodule-LeasableLock":{"properties":{"key":{"type":"string"},"token":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"},"lockedBySystem":{"type":"boolean"},"validUntil":{"type":"string","format":"date-time"},"id":{"type":"string","description":"Unique identifier of the Object","readOnly":true}},"required":["key","token"]}}}} ``` ## POST /erp/documents/{id}/leasable-lock > Erstellt eine neue Sperre, optional mit einer Gültigkeitsdauer ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/leasable-lock":{"post":{"tags":["Document"],"summary":"Erstellt eine neue Sperre, optional mit einer Gültigkeitsdauer","operationId":"createLeasableLock","parameters":[{"name":"id","in":"path","description":"ID der zu sperrenden Resource","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"leasePeriod","in":"query","description":"Optionale Lease-Dauer in Sekunden","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-unknownmodule-LeasableLock"}}}}}}}},"components":{"schemas":{"core-unknownmodule-LeasableLock":{"properties":{"key":{"type":"string"},"token":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"},"lockedBySystem":{"type":"boolean"},"validUntil":{"type":"string","format":"date-time"},"id":{"type":"string","description":"Unique identifier of the Object","readOnly":true}},"required":["key","token"]}}}} ``` ## POST /erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId} > Versucht einen Auftrag in Kommissionierung zu übernehmen und protokolliert das Ergebnis ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId}":{"post":{"tags":["Document"],"summary":"Versucht einen Auftrag in Kommissionierung zu übernehmen und protokolliert das Ergebnis","operationId":"tryTransferIntoPicking","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"picklistTemplateId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## POST /erp/documents/{documentId}/process-input > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{documentId}/process-input":{"post":{"tags":["Document"],"operationId":"processInput_3","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentInputProcessingRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentInputProcessingResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentInputProcessingRequest":{"description":"Request zur Eingabeverarbeitung zu Belegen","properties":{"inputData":{"type":"string","description":"Benutzereingabe/Scan"},"lastProcessedLineId":{"type":"integer","format":"int64","description":"Die letzte verarbeitete Position"},"lastProcessedBookingId":{"type":"integer","format":"int64","description":"Die letzte verarbeitete Buchung"},"inputList":{"type":"array","description":"Liste von Eingaben, die nacheinander ausgeführt werden","items":{"type":"string","description":"Liste von Eingaben, die nacheinander ausgeführt werden"}}}},"erp-document-DocumentInputProcessingResponse":{"description":"Response zur Eingabeverarbeitung zu Belegen","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"document":{"$ref":"#/components/schemas/erp-document-Document"},"lastProcessedLineId":{"type":"integer","format":"int64","description":"Die letzte verarbeitete Position"},"lastProcessedBookingId":{"type":"integer","format":"int64","description":"Die letzte verarbeitete Buchung"},"validationHints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"}}},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true}}}} ``` ## GET /erp/documents/{documentId}/parcels > Liefert die Pakete zu einem Beleg ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{documentId}/parcels":{"get":{"tags":["Document"],"summary":"Liefert die Pakete zu einem Beleg","operationId":"getParcels","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentParcel":{"description":"Pakete zu Belegen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentRef":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"position":{"type":"integer","format":"int32","description":"Position des Pakets"},"weight":{"type":"number","description":"Gewicht des Pakets"},"weightUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"length":{"type":"number","description":"Länge"},"width":{"type":"number","description":"Breite"},"height":{"type":"number","description":"Höhe"},"sizeUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"trackingNumber":{"type":"string","description":"Trackingnummer","readOnly":true},"lines":{"type":"array","description":"Inhalt des Pakets","items":{"$ref":"#/components/schemas/erp-document-DocumentParcelLine"}}},"required":["documentRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-document-DocumentParcelLine":{"description":"Inhalt der Pakete zu Belegen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineBookingId":{"type":"integer","format":"int64","description":"Referenz zur Belegpositionsbuchung"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Menge"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/documents/{documentId}/parcels > Erstellt ein Paket zu einem Beleg ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{documentId}/parcels":{"post":{"tags":["Document"],"summary":"Erstellt ein Paket zu einem Beleg","operationId":"createOrUpdateParcel_1","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentParcel"}}}}}}}},"components":{"schemas":{"erp-document-DocumentParcel":{"description":"Pakete zu Belegen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentRef":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"position":{"type":"integer","format":"int32","description":"Position des Pakets"},"weight":{"type":"number","description":"Gewicht des Pakets"},"weightUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"length":{"type":"number","description":"Länge"},"width":{"type":"number","description":"Breite"},"height":{"type":"number","description":"Höhe"},"sizeUnitTypeRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"trackingNumber":{"type":"string","description":"Trackingnummer","readOnly":true},"lines":{"type":"array","description":"Inhalt des Pakets","items":{"$ref":"#/components/schemas/erp-document-DocumentParcelLine"}}},"required":["documentRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-document-DocumentParcelLine":{"description":"Inhalt der Pakete zu Belegen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineBookingId":{"type":"integer","format":"int64","description":"Referenz zur Belegpositionsbuchung"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Menge"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/documents/perform-contract-evaluation > Create a Job according to the Request ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/perform-contract-evaluation":{"post":{"tags":["Document"],"summary":"Create a Job according to the Request","operationId":"createContractTermJobRequest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-ContractEvaluationJobRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"erp-document-ContractEvaluationJobRequest":{"description":"Request zur Erstellung des Jobs für Abrechnungen der Verträge","properties":{"blackList":{"type":"array","description":"Ignore ID-List","items":{"type":"integer","format":"int64","description":"Ignore ID-List"}},"whiteList":{"type":"array","description":"Use ID-List","items":{"type":"integer","format":"int64","description":"Use ID-List"}},"variableSubstitutionList":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"documentDate":{"type":"string","format":"date","description":"Abweichendes Belegdatum"},"deliveryDate":{"type":"string","format":"date","description":"Abweichendes Lieferdatum"},"addBillingPeriod":{"type":"boolean","default":true,"description":"Abrechnungszeitraum hinzufügen?"},"note":{"type":"string","description":"Notiz"},"print":{"type":"boolean","default":false,"description":"Drucken?"}}},"common-cunit-QueryPresetVariableSubstitutionList":{"description":"Werte von Variablen","properties":{"variableSubstitutions":{"type":"array","description":"Die Variablenbelegungen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitution"}}}},"common-cunit-QueryPresetVariableSubstitution":{"description":"Die Variablenbelegungen","properties":{"variable":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"},"values":{"type":"array","description":"Die einzusetzenden Werte","items":{"type":"string","description":"Die einzusetzenden Werte"}}}},"common-cunit-QueryPresetVariable":{"description":"Die zu ersetzende Variable","properties":{"path":{"type":"string","description":"Der pfad, der dieses Attribut eindeutig beschreibt"},"definition":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}],"readOnly":true},"mandatory":{"type":"boolean","description":"Ob die Variable ein Pflichtfeld ist oder nicht"},"variableName":{"type":"string","description":"Name der Variablen"},"visible":{"type":"boolean","default":true,"description":"Handelt es sich um eine sichtbare Variable?"},"alignX":{"type":"integer","format":"int32","description":"Anordnung im UI - X-Koordinate"},"alignY":{"type":"integer","format":"int32","description":"Anordnung im UI - Y-Koordinate"},"alignWidth":{"type":"integer","format":"int32","description":"Anordnung im UI - Breite"},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Eindeutiger Schlüssel zur Identifikation des Attributs"},"attribute":{"type":"string","description":"name des attributes der das ergebnis enthält"},"path":{"type":"string","description":"der pfad, der dieses attribut eindeutig beschreibt"},"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"parentDisplayName":{"type":"string","description":"der Name des Referenzierenden Feldes"},"resultable":{"type":"boolean","default":true,"description":"kann dieses Feld ein Ergebnisfeld sein"},"filterable":{"type":"boolean","default":true,"description":"kann nach diesem feld gefiltert werden"},"sortable":{"type":"boolean","default":true,"description":"ist dieses Feld sortierbar"},"visible":{"type":"boolean","default":true,"description":"soll dieses Feld angezeigt werden"},"functions":{"type":"array","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)","items":{"type":"string","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)"}},"sortDirection":{"type":"string","description":"Info, wie diese spalte sortiert worden ist"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"modelType":{"type":"string","description":"Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')","readOnly":true},"headers":{"type":"array","description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-MetaContent":{"description":"Definition dieser Variable","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]}}}},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"}}}]},"core-cunit-CuAttributeConstraint":{"description":"constraints für dieses Attribut","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"minimaler Wert","readOnly":true},"includeMinValue":{"type":"boolean","description":"ist der minimale Wert inklusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"maximaler Wert","readOnly":true},"includeMaxValue":{"type":"boolean","description":"ist der maximale Wert inklusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"ist der Wert 'null' verboten?","readOnly":true},"notBlank":{"type":"boolean","description":"Bei Strings: ist ein String nur aus Whitespace verboten?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximale Anzahl Nachkommastellen","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"data-type für dieses Attribut (falls dataTypeIdentifier leer ist)","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"welcher Typ ist es","readOnly":true},"objectRefIdentifier":{"type":"string","description":"bei Object_Ref: welcher Typ ist es genau","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"welche Funktionen sind erlaubt?","items":{"type":"string","description":"welche Funktionen sind erlaubt?"},"readOnly":true},"predicateOperations":{"type":"array","description":"welche Operations sind erlaubt?","items":{"type":"string","description":"welche Operations sind erlaubt?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit Attribut Filter Optionen","properties":{"filterValues":{"type":"array","description":"Mögliche Filterwerte","items":{"type":"string","description":"Mögliche Filterwerte"}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-cunit-CuAttribute.HeaderGroup":{"description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","properties":{"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Bedingungen zur Selektion von Lagerplätzen","properties":{"type":{"type":"string","description":"die Operation für diesen Filter","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"(bei junction) child-definitionen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"filter werte","items":{"type":"string","description":"filter werte"}},"visible":{"type":"boolean","default":true,"description":"Sichtbarkeit bei Variablen"},"functions":{"type":"array","description":"Eine SQL-Funktion, die im Predicate angewendet wird","items":{"type":"string","description":"Eine SQL-Funktion, die im Predicate angewendet wird"}}},"required":["operator","type"]},"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## POST /erp/documents/document/{documentId}/validate > validate a document by using the validation service ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/document/{documentId}/validate":{"post":{"tags":["Document"],"summary":"validate a document by using the validation service","operationId":"validateDocument","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationResponse"}}}}}}}},"components":{"schemas":{"einvoice-unknownmodule-ValidationResponse":{"properties":{"xmlDetails":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationXmlDetails"},"pdfDetails":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationPdfDetails"},"embeddingDetails":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationEmbeddingDetails"},"systemError":{"type":"string"},"shelfDocumentId":{"type":"integer","format":"int64"}}},"einvoice-unknownmodule-ValidationXmlDetails":{"properties":{"valid":{"type":"boolean"},"hasWarnings":{"type":"boolean"},"validSchema":{"type":"boolean"},"validNamespaces":{"type":"boolean"},"validEncoding":{"type":"boolean"},"validCodelists":{"type":"boolean"},"validFormat":{"type":"boolean"},"validVat":{"type":"boolean"},"validBusinessRules":{"type":"boolean"},"validProfile":{"type":"array","items":{"$ref":"#/components/schemas/einvoice-unknownmodule-ValidationXmlType"}},"warnings":{"type":"array","items":{"type":"string"}},"information":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"type":"string"}}}},"einvoice-unknownmodule-ValidationXmlType":{"properties":{"value":{"type":"boolean"},"profile":{"type":"integer","format":"int32"}}},"einvoice-unknownmodule-ValidationPdfDetails":{"properties":{"valid":{"type":"boolean"},"foundFlavour":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"information":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"type":"string"}}}},"einvoice-unknownmodule-ValidationEmbeddingDetails":{"properties":{"validFileEmbedding":{"type":"boolean"},"validFilename":{"type":"boolean"},"validXMP":{"type":"boolean"},"canExtractXML":{"type":"boolean"},"versionFromXML":{"type":"string"},"documentTypeFromXML":{"type":"string"},"guidelineFromXML":{"type":"string"},"variantFromXML":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}},"information":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"type":"string"}}}}}}} ``` ## POST /erp/documents/document/{documentId}/multiple\_lines > add new lines to an existing document ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/document/{documentId}/multiple_lines":{"post":{"tags":["Document"],"summary":"add new lines to an existing document","operationId":"addLinesToDocument","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentMultipleLinesRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentMultipleLinesRequest":{"properties":{"documentLines":{"type":"array","description":"Die neuen Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"additionalParameters":{"type":"array","description":"Zusätzliche Parameter und Benutzerentscheidungen","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}}},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## POST /erp/documents/document/{documentId}/line > add a new line to an existing document ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/document/{documentId}/line":{"post":{"tags":["Document"],"summary":"add a new line to an existing document","operationId":"addLineToDocument","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentPartialUpdateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentPartialUpdateRequest":{"properties":{"documentLine":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"additionalParameters":{"type":"array","description":"Zusätzliche Parameter und Benutzerentscheidungen","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}}},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## POST /erp/documents/contract/{contractId}/deactivate-line/{contractLineId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/contract/{contractId}/deactivate-line/{contractLineId}":{"post":{"tags":["Document"],"operationId":"deactivateContractLine","parameters":[{"name":"contractId","in":"path","description":"ID eines Vertrags","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"contractLineId","in":"path","description":"ID einer Vertragsposition","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## POST /erp/documents/contract/{contractId}/activate-line/{contractLineId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/contract/{contractId}/activate-line/{contractLineId}":{"post":{"tags":["Document"],"operationId":"activateContractLine","parameters":[{"name":"contractId","in":"path","description":"ID eines Vertrags","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"contractLineId","in":"path","description":"ID einer Vertragsposition","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` ## GET /erp/documents/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}":{"get":{"tags":["Document"],"summary":"Find an existing Resource by identifier","operationId":"getById_47","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PATCH /erp/documents/{id} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}":{"patch":{"tags":["Document"],"operationId":"patchDocument","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentPatchRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentResponse"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-document-DocumentPatchRequest":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"parameters":{"type":"array","description":"additional parameters for transition","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}},"required":["document"]},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}},"erp-document-DocumentResponse":{"properties":{"document":{"$ref":"#/components/schemas/erp-document-Document"},"hints":{"$ref":"#/components/schemas/erp-document-DocumentValidationHints"},"viewOptions":{"$ref":"#/components/schemas/erp-document-DocumentViewOptions"}}},"erp-document-DocumentValidationHints":{"description":"Hinweise","properties":{"details":{"type":"array","description":"Hinweise aus der Validierung im Error-Format","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"}}}},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentViewOptions":{"description":"Extra-Anzeigen","properties":{"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"loanValue":{"$ref":"#/components/schemas/erp-account-AccountLoanValue"},"considerForCreditLimit":{"type":"boolean","description":"Wird dieser Beleg für das Kreditlimit berücksichtigt","readOnly":true},"financeJournalAccountingInformation":{"$ref":"#/components/schemas/erp-finance-FinanceJournalAccountingInformation"},"possiblePredecessorTypes":{"type":"array","description":"mögliche Vorbeleg-Typen","items":{"type":"string","description":"mögliche Vorbeleg-Typen"}},"sumAmountOfProgressInvoices":{"type":"number","description":"Gesamtbetrag der Abschlagsrechnungen"},"sumAmountOfDepositInvoices":{"type":"number","description":"Gesamtbetrag der Anzahlungsrechnungen"},"sumAmountOfPartialInvoices":{"type":"number","description":"Gesamtbetrag der Teilrechnungen"},"sumAmountOfDeliveryInvoices":{"type":"number","description":"Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen"},"depositInvoiceRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sumOpenAmountForProgressInvoices":{"type":"number","description":"offener Gesamtbetrag für Abschlagsrechnungen"},"totalAmountDependingFromBillingType":{"type":"number","description":"Gesamtbetrag abh. von der Fakturierungsart"},"orderRefs":{"type":"array","description":"Referenzen zu den Aufträgen/Bestellungen in der Belegkette","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true},"picklistRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-account-AccountLoanValue":{"description":"Aktuell berechnete Werte zum Kreditlimit eines Accounts","properties":{"accountId":{"type":"integer","format":"int64","description":"Account"},"maximalLoan":{"type":"number","description":"Kreditlimit"},"currentLoan":{"type":"number","description":"Aktueller Kredit"},"nonInvoicedDocumentLoan":{"type":"number","description":"Betrag aus Aufträgen"},"receivableLoan":{"type":"number","description":"Betrag aus Forderungen"},"payablesSum":{"type":"number","description":"Betrag aus Verbindlichkeiten(negativ)"},"currentDocumentLoan":{"type":"number","description":"Betrag des momentanen Dokuments"},"remainingLoan":{"type":"number","description":"Übriger Betrag bis zum Erreichen des Kreditlimits"},"exceededLoan":{"type":"number","description":"Überschrittener Kreditbetrag"},"unconsideredAmount":{"type":"number","description":"Nicht berücksichtigter Betrag"}},"required":["accountId"]},"erp-finance-FinanceJournalAccountingInformation":{"description":"Fibu-Informationen","properties":{"accountingStatus":{"type":"string","description":"Fibu-Status Dokumenten-Journaleintrag","enum":["PROCESSING","OPEN","IGNORED","COMMITTED","COMMITTED_REVERTABLE"],"readOnly":true},"financeBookingRunRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountingStatusUpdatedDate":{"type":"string","format":"date-time","description":"Fibu-Übergabedatum","readOnly":true},"runState":{"type":"string","description":"Verarbeitungsstatus","enum":["PROCESSING","OPEN","COMMITTABLE","COMMITTED","REVERTED","FAILED"],"readOnly":true}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## GET /erp/documents/{refId}/workflow-state > Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{refId}/workflow-state":{"get":{"tags":["Document"],"summary":"Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz","operationId":"getWorkflowState_1","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"*/*":{"schema":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}},"404":{"description":"Es existiert noch keine Workflow-Instanz","content":{"*/*":{"schema":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}}}}}}} ``` ## GET /erp/documents/{refId}/workflow-instances-preset > Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{refId}/workflow-instances-preset":{"get":{"tags":["Document"],"summary":"Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz","operationId":"getWorkflowInstancesPreset_1","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-cunit-QueryPreset"}}}}}}}},"components":{"schemas":{"common-cunit-QueryPreset":{"description":"Adhoc Preset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"templateId":{"type":"string","description":"template dem dieser filter zugeordnet worden ist."},"templateGroupKey":{"type":"string","description":"templateGroupKey dem dieser filter zugeordnet worden ist."},"label":{"type":"string","description":"label für diesen filter"},"uiPayload":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variables":{"type":"array","description":"Variablen für dieses Preset","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"}},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"results":{"type":"array","description":"ergebnisse","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"sortAndOrders":{"type":"array","description":"sortierung","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetPageable"},"option":{"$ref":"#/components/schemas/common-cunit-QueryPresetOption"},"transformations":{"type":"array","description":"zusätzliche konfigurationen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetTransformation"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"definition":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]},"readOnly":true},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"},"forWorkflow":{"type":"boolean","default":false,"description":"für Workflows vorgesehen"},"outputReportGroupIdentifier":{"type":"string","description":"Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird"},"userOptions":{"$ref":"#/components/schemas/common-cunit-QueryPresetUserOptions"}},"required":["forWorkflow","label","mode","permissionAggregation","templateGroupKey","templateId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"common-cunit-QueryPresetVariable":{"description":"Die zu ersetzende Variable","properties":{"path":{"type":"string","description":"Der pfad, der dieses Attribut eindeutig beschreibt"},"definition":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}],"readOnly":true},"mandatory":{"type":"boolean","description":"Ob die Variable ein Pflichtfeld ist oder nicht"},"variableName":{"type":"string","description":"Name der Variablen"},"visible":{"type":"boolean","default":true,"description":"Handelt es sich um eine sichtbare Variable?"},"alignX":{"type":"integer","format":"int32","description":"Anordnung im UI - X-Koordinate"},"alignY":{"type":"integer","format":"int32","description":"Anordnung im UI - Y-Koordinate"},"alignWidth":{"type":"integer","format":"int32","description":"Anordnung im UI - Breite"},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Eindeutiger Schlüssel zur Identifikation des Attributs"},"attribute":{"type":"string","description":"name des attributes der das ergebnis enthält"},"path":{"type":"string","description":"der pfad, der dieses attribut eindeutig beschreibt"},"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"parentDisplayName":{"type":"string","description":"der Name des Referenzierenden Feldes"},"resultable":{"type":"boolean","default":true,"description":"kann dieses Feld ein Ergebnisfeld sein"},"filterable":{"type":"boolean","default":true,"description":"kann nach diesem feld gefiltert werden"},"sortable":{"type":"boolean","default":true,"description":"ist dieses Feld sortierbar"},"visible":{"type":"boolean","default":true,"description":"soll dieses Feld angezeigt werden"},"functions":{"type":"array","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)","items":{"type":"string","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)"}},"sortDirection":{"type":"string","description":"Info, wie diese spalte sortiert worden ist"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"modelType":{"type":"string","description":"Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')","readOnly":true},"headers":{"type":"array","description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-MetaContent":{"description":"Definition dieser Variable","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]}}}},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"}}}]},"core-cunit-CuAttributeConstraint":{"description":"constraints für dieses Attribut","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"minimaler Wert","readOnly":true},"includeMinValue":{"type":"boolean","description":"ist der minimale Wert inklusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"maximaler Wert","readOnly":true},"includeMaxValue":{"type":"boolean","description":"ist der maximale Wert inklusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"ist der Wert 'null' verboten?","readOnly":true},"notBlank":{"type":"boolean","description":"Bei Strings: ist ein String nur aus Whitespace verboten?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximale Anzahl Nachkommastellen","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"data-type für dieses Attribut (falls dataTypeIdentifier leer ist)","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"welcher Typ ist es","readOnly":true},"objectRefIdentifier":{"type":"string","description":"bei Object_Ref: welcher Typ ist es genau","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"welche Funktionen sind erlaubt?","items":{"type":"string","description":"welche Funktionen sind erlaubt?"},"readOnly":true},"predicateOperations":{"type":"array","description":"welche Operations sind erlaubt?","items":{"type":"string","description":"welche Operations sind erlaubt?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit Attribut Filter Optionen","properties":{"filterValues":{"type":"array","description":"Mögliche Filterwerte","items":{"type":"string","description":"Mögliche Filterwerte"}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute.HeaderGroup":{"description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","properties":{"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Bedingungen zur Selektion von Lagerplätzen","properties":{"type":{"type":"string","description":"die Operation für diesen Filter","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"(bei junction) child-definitionen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"filter werte","items":{"type":"string","description":"filter werte"}},"visible":{"type":"boolean","default":true,"description":"Sichtbarkeit bei Variablen"},"functions":{"type":"array","description":"Eine SQL-Funktion, die im Predicate angewendet wird","items":{"type":"string","description":"Eine SQL-Funktion, die im Predicate angewendet wird"}}},"required":["operator","type"]},"common-cunit-QueryPresetResult":{"description":"Ergebnisse","properties":{"property":{"type":"string","description":"property"},"displayName":{"type":"string","description":"title dieser spalte"},"functions":{"type":"array","description":"funktionen","items":{"type":"string","description":"funktionen"}},"visible":{"type":"boolean","default":true,"description":"sichtbare Ergebnisspalte"}},"required":["property"]},"common-cunit-QueryPresetSortOrder":{"description":"sort and order anweisungen","properties":{"property":{"type":"string","description":"property"},"functions":{"type":"array","description":"Functions","items":{"type":"string","description":"Functions"}},"direction":{"type":"string","description":"sort order","enum":["ASC","DESC"]}},"required":["direction","property"]},"common-cunit-QueryPresetPageable":{"description":"pageable","properties":{"limit":{"type":"integer","format":"int64","description":"das Limit (MaxRecordCount) für diesen Query"}}},"common-cunit-QueryPresetOption":{"description":"options","properties":{"distinctResult":{"type":"boolean","description":"soll der Query mit einem Distinct durchgeführt werden"}}},"common-cunit-QueryPresetTransformation":{"description":"zusätzliche konfigurationen","properties":{"crossTable":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation"}}},"common-cunit-QueryPresetCrossTableTransformation":{"description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","properties":{"rowSpecs":{"type":"array","description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"columnSpecs":{"type":"array","description":"enthält die felder, die in der cross-table als dynamische spalten erstellt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"results":{"type":"array","description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell"}}},"required":["columnSpecs","results","rowSpecs"]},"common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell":{"description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","properties":{"result":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"cellView":{"type":"string","description":"darstellung der werte","enum":["AS_IS","PERCENT_COL"]},"sumColumn":{"type":"boolean","default":false,"description":"soll eine spaltensumme erzeugt werden"},"rowMode":{"type":"string","description":"soll eine zeilensumme erzeugt werden","enum":["DATA","DATA_AND_TOTAL","TOTAL"]},"aggregateFunction":{"type":"string","description":"die funktion mit der die werte der Zelle aggregiert werden"}}},"common-cunit-ArithmeticQueryTerm":{"description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","properties":{"termName":{"type":"string","description":"Der Name des Terms für die Verarbeitung und Darstellung"},"terms":{"type":"array","description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermInner"}},"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-cunit-ArithmeticQueryTermInner":{"description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","properties":{"fragment":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermFragment"},"attribute":{"type":"string","description":"Ein echtes Attribut aus dem Template"},"fixedValue":{"type":"number","description":"Ein Fixwert"}}},"common-cunit-ArithmeticQueryTermFragment":{"description":"Das Termfragment - eine weitere Verschachtelung mit eigenen Operationen","properties":{"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-cunit-QueryPresetUserOptions":{"description":"nutzerbezogene Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"pinned":{"type":"boolean","default":false,"description":"angepinnt?"}},"required":["pinned"]}}}} ``` ## GET /erp/documents/{refId}/latest-workflow-instance > Liefert die neuste Workflow-Instanz zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{refId}/latest-workflow-instance":{"get":{"tags":["Document"],"summary":"Liefert die neuste Workflow-Instanz zu der gegebenen Referenz","operationId":"getLatestWorkflowInstance_1","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}},"404":{"description":"Es existiert noch keine Workflow-Instanz","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}}}}}},"components":{"schemas":{"common-workflow-WorkflowInstance":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]},"workflowRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workItems":{"type":"array","description":"Schritte des Workflows","items":{"$ref":"#/components/schemas/common-workflow-WorkItem"}},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-workflow-WorkItem":{"description":"Schritte des Workflows","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Bearbeitungszustand eines Work-Items","enum":["OPEN","IN_PROCESS","COMPLETED","ERRONEOUS","ABORTED"]},"workflowElementRef":{"type":"integer","format":"int64","description":"Workflow-Element, das abgebildet wird"},"parentWorkItemRef":{"type":"integer","format":"int64","description":"Work-Item im übergeordneten Workflow, wenn es sich um einen Unter-Workflow handelt"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}},"splitResult":{"type":"string","description":"Für Split-Gateways: mit welchem Ergebnis wurde dieses Work-Item ausgeführt"}}},"common-workflow-WorkflowInstanceLogLine":{"description":"Logging-Einträge chronologisch sortiert","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"workflowInstanceId":{"type":"integer","format":"int64","description":"ID der Workflow-Instanz"},"workItemId":{"type":"integer","format":"int64","description":"ID des Work-Items"},"logTime":{"type":"string","format":"date-time","description":"Zeitstempel"},"origin":{"type":"string","description":"Wodurch wurde dieser Eintrag ausgelöst","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"message":{"type":"string","description":"Nachricht"},"messageKey":{"type":"string","description":"I18n-Key"},"propertyPath":{"type":"string","description":"Pfad"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"Parameter für die I18n-Nachricht"},"description":"Parameter für die I18n-Nachricht"}}}}}} ``` ## GET /erp/documents/{id}/ui-hints > Lists all ui-hints for this document ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/ui-hints":{"get":{"tags":["Document"],"summary":"Lists all ui-hints for this document","operationId":"getUiHints","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DocumentUiHintCollection"}}}}}}}},"components":{"schemas":{"erp-document-DocumentUiHintCollection":{"properties":{"documentHints":{"type":"array","description":"UI-Hints, die sich auf den Dokumenttypen und den Account beziehen","items":{"type":"string","description":"UI-Hints, die sich auf den Dokumenttypen und den Account beziehen"}},"positionHints":{"type":"array","description":"UI-Hints, die sich auf den Dokumenttypen und einen Artikel beziehen","items":{"$ref":"#/components/schemas/erp-document-PositionUiHintCollection"}}}},"erp-document-PositionUiHintCollection":{"description":"UI-Hints, die sich auf den Dokumenttypen und einen Artikel beziehen","properties":{"articleId":{"type":"integer","format":"int64","description":"Artikel, auf den sich die UI-Hints beziehen"},"uiHints":{"type":"array","description":"UI-Hints für den Artikel und Dokumenttypen","items":{"type":"string","description":"UI-Hints für den Artikel und Dokumenttypen"}}}}}}} ``` ## GET /erp/documents/{id}/ui-hints/article/{articleId} > Lists all ui-hints for this document ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/ui-hints/article/{articleId}":{"get":{"tags":["Document"],"summary":"Lists all ui-hints for this document","operationId":"getUiHintsForArticle","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"articleId","in":"path","description":"article identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}} ``` ## GET /erp/documents/{id}/ui-hints/account/{accountId} > Lists all ui-hints for this document ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/ui-hints/account/{accountId}":{"get":{"tags":["Document"],"summary":"Lists all ui-hints for this document","operationId":"getUiHintsForAccount","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"accountId","in":"path","description":"account identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}}} ``` ## GET /erp/documents/{id}/types/history > return a tree of predecessors and successors of this document ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/types/history":{"get":{"tags":["Document"],"summary":"return a tree of predecessors and successors of this document","operationId":"nodeHistory","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentHistoryNode"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentHistoryNode":{"properties":{"documentId":{"type":"string","description":"the id of the document"},"number":{"type":"string","description":"the number of the document"},"documentDate":{"type":"string","format":"date","description":"documentDate"},"totalGrossPrice":{"type":"number","description":"gross total price (GROSS)"},"totalNetPrice":{"type":"number","description":"net total price (NET)"},"documentType":{"type":"string","description":"type of this document"},"documentTypeId":{"type":"string","description":"typeId of this document"},"documentState":{"type":"string","description":"state of this document"},"documentTypeCategory":{"type":"string","description":"category of this document"},"childNodes":{"type":"array","description":"list of documents, this document was transferred into","items":{"$ref":"#/components/schemas/erp-document-DocumentHistoryNode"}},"requested":{"type":"boolean","default":false,"description":"indicates that this document was requested"},"chainIdentifier":{"type":"string","description":"Belegketten-Id"}}}}}} ``` ## GET /erp/documents/{id}/text-templates > Gibt die manuellen Textbausteine für Kopf-/Fußtexte zurück, die für das Dokument Sinn ergeben ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/text-templates":{"get":{"tags":["Document"],"summary":"Gibt die manuellen Textbausteine für Kopf-/Fußtexte zurück, die für das Dokument Sinn ergeben","operationId":"getManualTemplates","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"textPosition","in":"query","required":true,"schema":{"type":"string","enum":["HEADER_TEXT","FOOTER_TEXT"]}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-texttemplates-TextTemplate"}}}}}}}}},"components":{"schemas":{"erp-texttemplates-TextTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung des Bausteins"},"templateType":{"type":"string","default":"AUTOMATIC","description":"Verwendungszweck des Templates","enum":["UI_HINT","AUTOMATIC","MANUAL"]},"uiHintTypes":{"type":"array","description":"Wann wird ein UI-Hint angezeigt","items":{"type":"string","description":"Wann wird ein UI-Hint angezeigt","enum":["UI_HINT_MASTER_DATA","UI_HINT_DOCUMENT"]}},"accountId":{"type":"integer","format":"int64","description":"account für den diese Templates gelten"},"articleId":{"type":"integer","format":"int64","description":"article für den diese Templates gelten"},"targetDocumentTypes":{"type":"array","description":"Zieldokumenttypen. Geben zusammen mit Vorbelegstypen die Transitionen an für die dieses Template gilt","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"sourceDocumentTypes":{"type":"array","description":"Vorbelegtypen. Geben zusammen mit Zieldokumenttypen die Transitionen an für die dieses Template gilt","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":false,"description":"Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?"},"separateLine":{"type":"boolean","default":false,"description":"Wird eine eigene DocumentLine für den Baustein angelegt?"},"position":{"type":"string","description":"Position für den erzeugten DocumentText","enum":["HEADER_TEXT","FOOTER_TEXT"]},"active":{"type":"boolean","default":true,"description":"ist dieser Baustein aktiv?","readOnly":true},"languageSpecificContents":{"type":"array","description":"Texte in den angebotenen Sprachen","items":{"$ref":"#/components/schemas/erp-texttemplates-LocalizedTextTemplateContent"}},"resolveContentInFollowUpDocument":{"type":"boolean","default":false,"description":"Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-texttemplates-LocalizedTextTemplateContent":{"description":"Texte in den angebotenen Sprachen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCodeIsoAlpha2":{"type":"string","description":"Sprache des Textes"},"content":{"type":"string","description":"Text"}},"required":["content","languageCodeIsoAlpha2"]}}}} ``` ## GET /erp/documents/{id}/successor-document-assignable-lines > Lists successor document lines for predecessor assignment ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/successor-document-assignable-lines":{"get":{"tags":["Document"],"summary":"Lists successor document lines for predecessor assignment","operationId":"getSuccessorDocumentAssignableLines","parameters":[{"name":"id","in":"path","description":"ID of successor document","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-SuccessorDocumentAssignableLinesDocumentLine"}}}}}}}},"components":{"schemas":{"erp-document-SuccessorDocumentAssignableLinesDocumentLine":{"description":"Belegpositionen für die Vorbelegszuordnung","properties":{"unassignedLines":{"type":"array","description":"Positionen ohne Vorbelegsposition","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"readOnly":true},"uncompletedLines":{"type":"array","description":"Nicht (vollständig) übernommene Positionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"readOnly":true},"completedLines":{"type":"array","description":"Vollständig übernommene Positionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"},"readOnly":true}}},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}}}}} ``` ## GET /erp/documents/{id}/predecessor-document-assignable-lines > Lists predecessor document lines for predecessor assignment ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/predecessor-document-assignable-lines":{"get":{"tags":["Document"],"summary":"Lists predecessor document lines for predecessor assignment","operationId":"getPredecessorDocumentAssignableLines","parameters":[{"name":"id","in":"path","description":"ID of predecessor document","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}}}}} ``` ## GET /erp/documents/{id}/lines/{lineId}/storages > return all possible storages for this documentLine ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/lines/{lineId}/storages":{"get":{"tags":["Document"],"summary":"return all possible storages for this documentLine","operationId":"getDocumentLineStorages","parameters":[{"name":"id","in":"path","description":"document id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"document line id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentLineStorageResponse"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentLineStorageResponse":{"description":"storage option for a document-line","properties":{"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"reservedQuantity":{"type":"number","description":"reserved quantity (from customer-orders)"},"orderedQuantity":{"type":"number","description":"already ordered quantity (from supplier-orders)"},"stockAmount":{"type":"number","description":"the current stock amount"},"stockAvailable":{"type":"number","description":"the current available stock amount"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/documents/{id}/lines/{lineId}/show-price-origin > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/lines/{lineId}/show-price-origin":{"get":{"tags":["Document"],"operationId":"getPriceOriginToLine","parameters":[{"name":"id","in":"path","description":"document id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID of the document line","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"}}}}}}}},"components":{"schemas":{"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}}}}} ``` ## GET /erp/documents/{id}/lines/{lineId}/purchase-price-statistic > liefert dem dEK und letzten EK für ein Artikel einer DocumentLine ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/lines/{lineId}/purchase-price-statistic":{"get":{"tags":["Document"],"summary":"liefert dem dEK und letzten EK für ein Artikel einer DocumentLine","operationId":"getPurchasePriceStatistic_1","parameters":[{"name":"id","in":"path","description":"document id","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID of the document line","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-PurchasePriceStatistic"}}}}}}}},"components":{"schemas":{"erp-product-PurchasePriceStatistic":{"description":"Preisstatistiken (DEK und letzter EK)","properties":{"averagePrice":{"type":"number","description":"Durchschnitts-Einkaufspreis","readOnly":true},"averagePriceBookedAt":{"type":"string","format":"date","description":"Wertstellungsdatum Durchschnitts-Einkaufspreis","readOnly":true},"priceUnitAveragePrice":{"type":"number","description":"Preiseinheit Durchschnitts-Einkaufspreis","readOnly":true},"lastPrice":{"type":"number","description":"letzter Einkaufspreis","readOnly":true},"lastPriceUpdatedAt":{"type":"string","format":"date-time","description":"Erfassungszeitpunkt letzter Einkaufspreis","readOnly":true},"lastPriceBookedAt":{"type":"string","format":"date","description":"Wertstellungsdatum letzter Einkaufspreis","readOnly":true},"mainSupplierAccount":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainSupplierProductPrice":{"$ref":"#/components/schemas/erp-product-ProductPrice"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}}}}} ``` ## GET /erp/documents/{id}/lines/text-templates > Gibt die manuellen Textbausteine für Textpositionen zurück, die für das Dokument Sinn ergeben ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/lines/text-templates":{"get":{"tags":["Document"],"summary":"Gibt die manuellen Textbausteine für Textpositionen zurück, die für das Dokument Sinn ergeben","operationId":"getManualTemplateLines","parameters":[{"name":"id","in":"path","description":"document id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-texttemplates-TextTemplate"}}}}}}}}},"components":{"schemas":{"erp-texttemplates-TextTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung des Bausteins"},"templateType":{"type":"string","default":"AUTOMATIC","description":"Verwendungszweck des Templates","enum":["UI_HINT","AUTOMATIC","MANUAL"]},"uiHintTypes":{"type":"array","description":"Wann wird ein UI-Hint angezeigt","items":{"type":"string","description":"Wann wird ein UI-Hint angezeigt","enum":["UI_HINT_MASTER_DATA","UI_HINT_DOCUMENT"]}},"accountId":{"type":"integer","format":"int64","description":"account für den diese Templates gelten"},"articleId":{"type":"integer","format":"int64","description":"article für den diese Templates gelten"},"targetDocumentTypes":{"type":"array","description":"Zieldokumenttypen. Geben zusammen mit Vorbelegstypen die Transitionen an für die dieses Template gilt","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"sourceDocumentTypes":{"type":"array","description":"Vorbelegtypen. Geben zusammen mit Zieldokumenttypen die Transitionen an für die dieses Template gilt","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":false,"description":"Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?"},"separateLine":{"type":"boolean","default":false,"description":"Wird eine eigene DocumentLine für den Baustein angelegt?"},"position":{"type":"string","description":"Position für den erzeugten DocumentText","enum":["HEADER_TEXT","FOOTER_TEXT"]},"active":{"type":"boolean","default":true,"description":"ist dieser Baustein aktiv?","readOnly":true},"languageSpecificContents":{"type":"array","description":"Texte in den angebotenen Sprachen","items":{"$ref":"#/components/schemas/erp-texttemplates-LocalizedTextTemplateContent"}},"resolveContentInFollowUpDocument":{"type":"boolean","default":false,"description":"Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-texttemplates-LocalizedTextTemplateContent":{"description":"Texte in den angebotenen Sprachen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageCodeIsoAlpha2":{"type":"string","description":"Sprache des Textes"},"content":{"type":"string","description":"Text"}},"required":["content","languageCodeIsoAlpha2"]}}}} ``` ## GET /erp/documents/{id}/lines-to-transfer-to-supplier-order > Lists all orderable document lines ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/lines-to-transfer-to-supplier-order":{"get":{"tags":["Document"],"summary":"Lists all orderable document lines","operationId":"getOrderableLinesToTransfer","parameters":[{"name":"id","in":"path","description":"document identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-OrderableLine"}}}}}}}}},"components":{"schemas":{"erp-document-OrderableLine":{"description":"Bestellbare Positionen für Übernahme in Bestellung","properties":{"documentLineId":{"type":"string","description":"Id der DocumentLine","readOnly":true},"position":{"type":"integer","format":"int32","description":"Positionsnummer","readOnly":true},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"articleName":{"type":"string","description":"Artikelbezeichnung","readOnly":true},"articleId":{"type":"integer","format":"int64","description":"Artikelnummer","readOnly":true},"quantity":{"type":"number","description":"Menge"},"order":{"type":"boolean","default":true,"description":"Bestellen?"},"supplierRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availableQuantity":{"type":"number","description":"Verfügbare Menge","readOnly":true},"orderedQuantity":{"type":"number","description":"Bestellte Menge","readOnly":true},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"],"readOnly":true}},"required":["order","quantity"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/documents/{id}/lines-to-transfer-to-supplier-delivery > List all lines allowed to transfer in supplier delivery ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/lines-to-transfer-to-supplier-delivery":{"get":{"tags":["Document"],"summary":"List all lines allowed to transfer in supplier delivery","operationId":"getToSupplierDeliveryTransferableLines","parameters":[{"name":"id","in":"path","description":"ID of supplier order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DeliveryTransferData"}}}}}}}},"components":{"schemas":{"erp-document-DeliveryTransferData":{"description":"In Lieferschein übernehmbare Positionen mit Belegnummern","properties":{"deliveryTransferableLines":{"type":"array","description":"In Lieferschein übernehmbare Positionen","items":{"$ref":"#/components/schemas/erp-document-DeliveryTransferableLine"}},"externalDocumentNumber":{"type":"string","description":"externe Belegnummer"},"documentNumber":{"type":"string","description":"Belegnummer"},"deliveryDate":{"type":"string","format":"date","description":"Wunsch-Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Wunsch-Lieferdatum bis"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum bis"}}},"erp-document-DeliveryTransferableLine":{"description":"In Lieferschein übernehmbare Position","properties":{"documentLineId":{"type":"integer","format":"int64","description":"ID der Document-Line"},"position":{"type":"integer","format":"int32","description":"Positionsnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"articleName":{"type":"string","description":"Artikelbezeichnung"},"quantity":{"type":"number","description":"Menge"},"orderedQuantity":{"type":"number","description":"Bestellte Menge"},"targetQuantity":{"type":"number","description":"Ziel-Menge"},"storageId":{"type":"integer","format":"int64","description":"Die Lager-ID der Position"},"presetStorageBinRef":{"$ref":"#/components/schemas/erp-stock-StorageBinRef"},"hasStorageBins":{"type":"boolean","default":false,"description":"Hat das Ziel-Lager der Position Lagerplätze?"},"hasPrintLabel":{"type":"boolean","default":false,"description":"Vorgabe Etikettendruck"},"deliveryDate":{"type":"string","format":"date","description":"Wunsch-Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Wunsch-Lieferdatum bis"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum bis"}}},"erp-stock-StorageBinRef":{"description":"Lagerplatz","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"displayName":{"type":"string","description":"Anzeigename"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"color":{"type":"string","description":"Anzeigefarbe"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/documents/{id}/lines-to-transfer-to-picklist > List all lines allowed to transfer in customer delivery ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/lines-to-transfer-to-picklist":{"get":{"tags":["Document"],"summary":"List all lines allowed to transfer in customer delivery","operationId":"getToPicklistTransferableLines","parameters":[{"name":"id","in":"path","description":"ID of customer order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DeliveryTransferData"}}}}}}}},"components":{"schemas":{"erp-document-DeliveryTransferData":{"description":"In Lieferschein übernehmbare Positionen mit Belegnummern","properties":{"deliveryTransferableLines":{"type":"array","description":"In Lieferschein übernehmbare Positionen","items":{"$ref":"#/components/schemas/erp-document-DeliveryTransferableLine"}},"externalDocumentNumber":{"type":"string","description":"externe Belegnummer"},"documentNumber":{"type":"string","description":"Belegnummer"},"deliveryDate":{"type":"string","format":"date","description":"Wunsch-Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Wunsch-Lieferdatum bis"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum bis"}}},"erp-document-DeliveryTransferableLine":{"description":"In Lieferschein übernehmbare Position","properties":{"documentLineId":{"type":"integer","format":"int64","description":"ID der Document-Line"},"position":{"type":"integer","format":"int32","description":"Positionsnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"articleName":{"type":"string","description":"Artikelbezeichnung"},"quantity":{"type":"number","description":"Menge"},"orderedQuantity":{"type":"number","description":"Bestellte Menge"},"targetQuantity":{"type":"number","description":"Ziel-Menge"},"storageId":{"type":"integer","format":"int64","description":"Die Lager-ID der Position"},"presetStorageBinRef":{"$ref":"#/components/schemas/erp-stock-StorageBinRef"},"hasStorageBins":{"type":"boolean","default":false,"description":"Hat das Ziel-Lager der Position Lagerplätze?"},"hasPrintLabel":{"type":"boolean","default":false,"description":"Vorgabe Etikettendruck"},"deliveryDate":{"type":"string","format":"date","description":"Wunsch-Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Wunsch-Lieferdatum bis"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum bis"}}},"erp-stock-StorageBinRef":{"description":"Lagerplatz","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"displayName":{"type":"string","description":"Anzeigename"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"color":{"type":"string","description":"Anzeigefarbe"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/documents/{id}/lines-to-transfer-to-customer-delivery > List all lines allowed to transfer in customer delivery ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/lines-to-transfer-to-customer-delivery":{"get":{"tags":["Document"],"summary":"List all lines allowed to transfer in customer delivery","operationId":"getToCustomerDeliveryTransferableLines","parameters":[{"name":"id","in":"path","description":"ID of customer order","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-DeliveryTransferData"}}}}}}}},"components":{"schemas":{"erp-document-DeliveryTransferData":{"description":"In Lieferschein übernehmbare Positionen mit Belegnummern","properties":{"deliveryTransferableLines":{"type":"array","description":"In Lieferschein übernehmbare Positionen","items":{"$ref":"#/components/schemas/erp-document-DeliveryTransferableLine"}},"externalDocumentNumber":{"type":"string","description":"externe Belegnummer"},"documentNumber":{"type":"string","description":"Belegnummer"},"deliveryDate":{"type":"string","format":"date","description":"Wunsch-Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Wunsch-Lieferdatum bis"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum bis"}}},"erp-document-DeliveryTransferableLine":{"description":"In Lieferschein übernehmbare Position","properties":{"documentLineId":{"type":"integer","format":"int64","description":"ID der Document-Line"},"position":{"type":"integer","format":"int32","description":"Positionsnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"articleName":{"type":"string","description":"Artikelbezeichnung"},"quantity":{"type":"number","description":"Menge"},"orderedQuantity":{"type":"number","description":"Bestellte Menge"},"targetQuantity":{"type":"number","description":"Ziel-Menge"},"storageId":{"type":"integer","format":"int64","description":"Die Lager-ID der Position"},"presetStorageBinRef":{"$ref":"#/components/schemas/erp-stock-StorageBinRef"},"hasStorageBins":{"type":"boolean","default":false,"description":"Hat das Ziel-Lager der Position Lagerplätze?"},"hasPrintLabel":{"type":"boolean","default":false,"description":"Vorgabe Etikettendruck"},"deliveryDate":{"type":"string","format":"date","description":"Wunsch-Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Wunsch-Lieferdatum bis"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum bis"}}},"erp-stock-StorageBinRef":{"description":"Lagerplatz","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"displayName":{"type":"string","description":"Anzeigename"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"color":{"type":"string","description":"Anzeigefarbe"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/documents/{id}/flat > returns the flat document without ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{id}/flat":{"get":{"tags":["Document"],"summary":"returns the flat document without","operationId":"getFlatDocument","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-Document"}}}}}}}},"components":{"schemas":{"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}}}}} ``` ## GET /erp/documents/{documentId}/parcels/unassigned-bookings > Liefert alle nicht zu Paketen zugewiesenen Belegpositionsbuchungen zu einem Beleg ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{documentId}/parcels/unassigned-bookings":{"get":{"tags":["Document"],"summary":"Liefert alle nicht zu Paketen zugewiesenen Belegpositionsbuchungen zu einem Beleg","operationId":"getUnassignedDocumentLineBookings","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/documents/{documentId}/availability > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/{documentId}/availability":{"get":{"tags":["Document"],"operationId":"getOrderLineAvailabilityInfo","parameters":[{"name":"documentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-CompleteDocumentAvailabilityInfoApi"}}}}}}}},"components":{"schemas":{"erp-document-CompleteDocumentAvailabilityInfoApi":{"description":"Verfügbarkeitsinformationen zu einem Beleg und seinen Positionen","properties":{"documentAvailabilityInfo":{"$ref":"#/components/schemas/erp-document-DocumentAvailabilityInfoApi"},"lineAvailabilityInfos":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-document-DocumentLineAvailabilityInfoApi"},"description":"Verfügbarkeitsinformationen zu den einzelnen Positionen"}}},"erp-document-DocumentAvailabilityInfoApi":{"description":"Verfügbarkeitsinformationen zu einem Beleg","properties":{"orderAvailability":{"type":"string","description":"Verfügbarkeit eines Auftrags","enum":["FULL_DELIVERABLE","NOTHING_DELIVERABLE","AT_LEAST_ONE_LINE_IS_FULL_DELIVERABLE","AT_LEAST_ONE_LINE_IS_PARTIALLY_DELIVERABLE"]},"orderStackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"maxPossibleDeliveries":{"type":"integer","format":"int32","description":"Maximale Anzahl an Lieferungen"}}},"erp-document-DocumentLineAvailabilityInfoApi":{"description":"Verfügbarkeitsinformationen zu einer Position","properties":{"orderLineAvailability":{"type":"string","description":"Verfügbarkeit einer Auftragsposition","enum":["FULL_DELIVERABLE","NOTHING_DELIVERABLE","PARTIALLY_DELIVERABLE","LINE_ALREADY_DELIVERED"]},"availableQuantity":{"type":"number","description":"(Benötigte) verfügbare Menge"},"maxAvailableQuantity":{"type":"number","description":"Maximal verfügbare Menge"},"orderedQuantity":{"type":"number","description":"Bestellte Menge"}}}}}} ``` ## GET /erp/documents/types > return all available document-state-machine starting states ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Document","description":"the Document API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/documents/types":{"get":{"tags":["Document"],"summary":"return all available document-state-machine starting states ","operationId":"getDocumentTypesForCreate","parameters":[{"name":"qualifiers","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"]},"uniqueItems":true}},{"name":"languageCode","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-document-DocumentTransitionRef"}}}}}}}}},"components":{"schemas":{"erp-document-DocumentTransitionRef":{"properties":{"id":{"type":"string","description":"das gleiche wie transition id für das UI"},"transitionId":{"type":"string","description":"transition id"},"transitionLabel":{"type":"string","description":"label of this transition","readOnly":true},"uiHint":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stateDefinition":{"type":"string","description":"state definition of the target state","readOnly":true},"typeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"typeId":{"type":"string","description":"document-type-id des ziels","readOnly":true},"typeKey":{"type":"string","description":"document-type-key des ziels","readOnly":true},"typeLabel":{"type":"string","description":"type-label","readOnly":true},"isDefaultTypeForCategory":{"type":"boolean","description":"document-type ist Default für die Kategorie","readOnly":true},"targetState":{"type":"string","description":"Der Ziel-Status der Transition","readOnly":true},"sortOrder":{"type":"integer","format":"int32","description":"Sortier-Reihenfolge","readOnly":true}},"required":["id","transitionId"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Payment Plan Offene Posten - Zahlungspläne ## PUT /erp/finance/openitems/paymentplan/{openItemId}/change\_paymentplan > Ändert einen Zahlungsplan ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentPlan","description":"Offene Posten - Zahlungspläne"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/paymentplan/{openItemId}/change_paymentplan":{"put":{"tags":["PaymentPlan"],"description":"Ändert einen Zahlungsplan","operationId":"update_37","parameters":[{"name":"openItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-PaymentPlanChangeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"}}}}}}}},"components":{"schemas":{"erp-finance-PaymentPlanChangeRequest":{"properties":{"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"clearDueDateCalculation":{"type":"boolean","description":"Fälligkeitsregel löschen"},"amount":{"type":"number","description":"Betrag"},"clearAmount":{"type":"boolean","description":"Betrag löschen"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"clearStartDate":{"type":"boolean","description":"Startdatum löschen"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"clearEndDate":{"type":"boolean","description":"Enddatum löschen"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"clearDueDate":{"type":"boolean","description":"Fälligkeitsdatum löschen"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## POST /erp/finance/openitems/paymentplan/{openItemId}/transform\_to\_paymentplan > Wandelt einen Rechnungs-OP in einen Zahlungsplan um ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentPlan","description":"Offene Posten - Zahlungspläne"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/paymentplan/{openItemId}/transform_to_paymentplan":{"post":{"tags":["PaymentPlan"],"description":"Wandelt einen Rechnungs-OP in einen Zahlungsplan um","operationId":"transformInvoiceOpenItemToPaymentPlan","parameters":[{"name":"openItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## POST /erp/finance/openitems/paymentplan/{openItemId}/evaluate\_paymentplan > Triggert die Berechnung eines Zahlungsplans ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentPlan","description":"Offene Posten - Zahlungspläne"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/paymentplan/{openItemId}/evaluate_paymentplan":{"post":{"tags":["PaymentPlan"],"description":"Triggert die Berechnung eines Zahlungsplans","operationId":"evaluateOpenItemPaymentPlan","parameters":[{"name":"openItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## POST /erp/finance/openitems/paymentplan/start\_paymentplan\_run > Erstellt einen Zahlungsplanlauf ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentPlan","description":"Offene Posten - Zahlungspläne"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/paymentplan/start_paymentplan_run":{"post":{"tags":["PaymentPlan"],"description":"Erstellt einen Zahlungsplanlauf","operationId":"evaluateOpenItemPaymentPlanRun","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemPlanRunRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemPlanRunRequest":{"properties":{"dueDate":{"type":"string","format":"date","description":"Fälligkeit der nächsten Buchung"},"accountIds":{"type":"array","description":"Einschränkung auf spezielle Adressen?","items":{"type":"integer","format":"int64","description":"Einschränkung auf spezielle Adressen?"}},"startDate":{"type":"string","format":"date","description":"Starttag des Zahlungsplanes - bis"},"endDate":{"type":"string","format":"date","description":"Endtag des Zahlungsplanes - bis"}},"required":["dueDate"]},"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` # Fiscalization Backend Fiskalisierungs-Schnittstellen ## GET /erp/pos/fiscalization/backend/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"FiscalizationBackend","description":"Fiskalisierungs-Schnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/fiscalization/backend/{id}":{"get":{"tags":["FiscalizationBackend"],"summary":"Find an existing Resource by identifier","operationId":"getById_29","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-FiscalizationBackend"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-FiscalizationBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"backendType":{"type":"string","description":"Backend-Typ","enum":["FISKALY"]},"test":{"type":"boolean","default":false,"description":"Test-Umgebung?"}},"required":["backendType","label","test"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/pos/fiscalization/backend/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"FiscalizationBackend","description":"Fiskalisierungs-Schnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/fiscalization/backend/{id}":{"put":{"tags":["FiscalizationBackend"],"summary":"Update existing Resource ","operationId":"update_29","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-FiscalizationBackend"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-FiscalizationBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-FiscalizationBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"backendType":{"type":"string","description":"Backend-Typ","enum":["FISKALY"]},"test":{"type":"boolean","default":false,"description":"Test-Umgebung?"}},"required":["backendType","label","test"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/pos/fiscalization/backend/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"FiscalizationBackend","description":"Fiskalisierungs-Schnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/fiscalization/backend/{id}":{"delete":{"tags":["FiscalizationBackend"],"summary":"Delete an existing Resource","operationId":"delete_28","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/pos/fiscalization/backend/{id}/register > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"FiscalizationBackend","description":"Fiskalisierungs-Schnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/fiscalization/backend/{id}/register":{"put":{"tags":["FiscalizationBackend"],"operationId":"register_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## PUT /erp/pos/fiscalization/backend/{id}/deregister > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"FiscalizationBackend","description":"Fiskalisierungs-Schnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/fiscalization/backend/{id}/deregister":{"put":{"tags":["FiscalizationBackend"],"operationId":"deregister_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## PUT /erp/pos/fiscalization/backend/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"FiscalizationBackend","description":"Fiskalisierungs-Schnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/fiscalization/backend/{id}/deactivate":{"put":{"tags":["FiscalizationBackend"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_13","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-FiscalizationBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-FiscalizationBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"backendType":{"type":"string","description":"Backend-Typ","enum":["FISKALY"]},"test":{"type":"boolean","default":false,"description":"Test-Umgebung?"}},"required":["backendType","label","test"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/pos/fiscalization/backend/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"FiscalizationBackend","description":"Fiskalisierungs-Schnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/fiscalization/backend/{id}/activate":{"put":{"tags":["FiscalizationBackend"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_13","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-FiscalizationBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-FiscalizationBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"backendType":{"type":"string","description":"Backend-Typ","enum":["FISKALY"]},"test":{"type":"boolean","default":false,"description":"Test-Umgebung?"}},"required":["backendType","label","test"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/pos/fiscalization/backend > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"FiscalizationBackend","description":"Fiskalisierungs-Schnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/fiscalization/backend":{"post":{"tags":["FiscalizationBackend"],"summary":"Create new Resource","operationId":"create_27","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-FiscalizationBackend"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-FiscalizationBackend"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-FiscalizationBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"backendType":{"type":"string","description":"Backend-Typ","enum":["FISKALY"]},"test":{"type":"boolean","default":false,"description":"Test-Umgebung?"}},"required":["backendType","label","test"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Price Modifier Types Price modifier templates ## GET /erp/price-modifier-types/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PriceModifierTypes","description":"Price modifier templates"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/price-modifier-types/{id}":{"get":{"tags":["PriceModifierTypes"],"summary":"Find an existing Resource by identifier","operationId":"getById_27","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-PriceModifierTemplate"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-document-PriceModifierTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Name des Templates"},"modifierType":{"type":"string","description":"Rabatt oder Aufschlag","enum":["DISCOUNT","SURCHARGE"]}},"required":["label","modifierType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/price-modifier-types/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PriceModifierTypes","description":"Price modifier templates"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/price-modifier-types/{id}":{"put":{"tags":["PriceModifierTypes"],"summary":"Update existing Resource ","operationId":"update_27","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-PriceModifierTemplate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-PriceModifierTemplate"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-document-PriceModifierTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Name des Templates"},"modifierType":{"type":"string","description":"Rabatt oder Aufschlag","enum":["DISCOUNT","SURCHARGE"]}},"required":["label","modifierType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/price-modifier-types/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PriceModifierTypes","description":"Price modifier templates"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/price-modifier-types/{id}":{"delete":{"tags":["PriceModifierTypes"],"summary":"Delete an existing Resource","operationId":"delete_26","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/price-modifier-types > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PriceModifierTypes","description":"Price modifier templates"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/price-modifier-types":{"post":{"tags":["PriceModifierTypes"],"summary":"Create new Resource","operationId":"create_25","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-document-PriceModifierTemplate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-PriceModifierTemplate"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-document-PriceModifierTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Name des Templates"},"modifierType":{"type":"string","description":"Rabatt oder Aufschlag","enum":["DISCOUNT","SURCHARGE"]}},"required":["label","modifierType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Ui Einstellungen Verwaltung von UI-Einstellungen ## GET /cmn/ui-settings/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Ui-Einstellungen","description":"Verwaltung von UI-Einstellungen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/ui-settings/{id}":{"get":{"tags":["Ui-Einstellungen"],"summary":"Find an existing Resource by identifier","operationId":"getById_133","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-ui-UiSetting"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-ui-UiSetting":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"category":{"type":"string","description":"Kategorie"},"key":{"type":"string","description":"Schlüssel"},"token":{"type":"string","description":"Eindeutiger Import-Schlüssel","readOnly":true},"active":{"type":"boolean","default":true,"description":"Sind die Einstellungen aktiv?"},"mandatoryForUsers":{"type":"array","description":"Die Einstellung ist für diese User Pflicht","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"mandatoryForGroups":{"type":"array","description":"Die Einstellung ist für diese Gruppen Pflicht","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"value":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["category","key","mandatoryForGroups","mandatoryForUsers","permissionAggregation"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /cmn/ui-settings/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Ui-Einstellungen","description":"Verwaltung von UI-Einstellungen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/ui-settings/{id}":{"put":{"tags":["Ui-Einstellungen"],"summary":"Update existing Resource ","operationId":"update_122","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-ui-UiSetting"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-ui-UiSetting"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-ui-UiSetting":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"category":{"type":"string","description":"Kategorie"},"key":{"type":"string","description":"Schlüssel"},"token":{"type":"string","description":"Eindeutiger Import-Schlüssel","readOnly":true},"active":{"type":"boolean","default":true,"description":"Sind die Einstellungen aktiv?"},"mandatoryForUsers":{"type":"array","description":"Die Einstellung ist für diese User Pflicht","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"mandatoryForGroups":{"type":"array","description":"Die Einstellung ist für diese Gruppen Pflicht","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"value":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["category","key","mandatoryForGroups","mandatoryForUsers","permissionAggregation"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /cmn/ui-settings/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Ui-Einstellungen","description":"Verwaltung von UI-Einstellungen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/ui-settings/{id}":{"delete":{"tags":["Ui-Einstellungen"],"summary":"Delete an existing Resource","operationId":"delete_112","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/ui-settings > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Ui-Einstellungen","description":"Verwaltung von UI-Einstellungen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/ui-settings":{"post":{"tags":["Ui-Einstellungen"],"summary":"Create new Resource","operationId":"create_114","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-ui-UiSetting"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-ui-UiSetting"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-ui-UiSetting":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"category":{"type":"string","description":"Kategorie"},"key":{"type":"string","description":"Schlüssel"},"token":{"type":"string","description":"Eindeutiger Import-Schlüssel","readOnly":true},"active":{"type":"boolean","default":true,"description":"Sind die Einstellungen aktiv?"},"mandatoryForUsers":{"type":"array","description":"Die Einstellung ist für diese User Pflicht","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"mandatoryForGroups":{"type":"array","description":"Die Einstellung ist für diese Gruppen Pflicht","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"value":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["category","key","mandatoryForGroups","mandatoryForUsers","permissionAggregation"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## GET /cmn/ui-settings/{category}/{key} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Ui-Einstellungen","description":"Verwaltung von UI-Einstellungen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/ui-settings/{category}/{key}":{"get":{"tags":["Ui-Einstellungen"],"operationId":"getSettingsByMainGroupAndGroup","parameters":[{"name":"category","in":"path","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-ui-UiSettingResponse"}}}}}}}}},"components":{"schemas":{"common-ui-UiSettingResponse":{"properties":{"id":{"type":"string","description":"Unique identifier of the Object"},"value":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}}}}} ``` # Bank Transactions Transaktionen ## GET /erp/bank/transactions/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{id}":{"get":{"tags":["BankTransactions"],"summary":"Find an existing Resource by identifier","operationId":"getById_76","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankTransaction"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-BankTransaction":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountId":{"type":"integer","format":"int64","description":"id of the account"},"parentId":{"type":"integer","format":"int64","description":"id of the parent transaction"},"valueDate":{"type":"string","format":"date-time","description":"value date"},"bookingDate":{"type":"string","format":"date-time","description":"booking date"},"amount":{"type":"number","description":"amount"},"updatedAccountBalance":{"type":"number","description":"updated account balance"},"currency":{"type":"string","description":"amount currency"},"purpose":{"type":"string","description":"purpose text"},"name":{"type":"string","description":"counterpart name"},"iban":{"type":"string","description":"counterpart iban"},"bic":{"type":"string","description":"counterpart bic"},"accountNumber":{"type":"string","description":"counterpart account number"},"blz":{"type":"string","description":"counterpart bank number"},"bankName":{"type":"string","description":"counterpart bank name"},"mandateReference":{"type":"string","description":"mandate reference"},"customerReference":{"type":"string","description":"customer reference"},"creditorId":{"type":"string","description":"creditor id"},"debitorId":{"type":"string","description":"debitor id"},"transactionType":{"type":"string","description":"transaction type (text)"},"transactionCodeZKA":{"type":"string","description":"transaction type (ZKA-code)"},"transactionCodeSWIFT":{"type":"string","description":"transaction type (SWIFT-code)"},"purposeCode":{"type":"string","description":"purpose code"},"primanota":{"type":"string","description":"primanota"},"endToEndId":{"type":"string","description":"End-To-End-Id"},"compensationAmount":{"type":"number","description":"compensation amount (i.e. return debit fees)"},"originalAmount":{"type":"number","description":"original amount"},"originalCurrency":{"type":"string","description":"currency of original amount"},"userComment":{"type":"string","description":"manual comments added by the user"},"isPotentialDuplicate":{"type":"boolean","description":"potentielles Duplikat","readOnly":true},"matchingState":{"type":"string","description":"whether the transaction has been completely or partially matched with open items or not matched at all","enum":["MATCHED","PARTIALLY_MATCHED","NOT_MATCHED","NOT_RELEVANT"],"readOnly":true},"direction":{"type":"string","description":"whether this transaction was incoming or outgoing","enum":["INCOMING","OUTGOING"]},"openItemRecordRefs":{"type":"array","description":"openItem record reference","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/bank/transactions/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{id}":{"put":{"tags":["BankTransactions"],"summary":"Update existing Resource ","operationId":"update_70","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankTransaction"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankTransaction"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-BankTransaction":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountId":{"type":"integer","format":"int64","description":"id of the account"},"parentId":{"type":"integer","format":"int64","description":"id of the parent transaction"},"valueDate":{"type":"string","format":"date-time","description":"value date"},"bookingDate":{"type":"string","format":"date-time","description":"booking date"},"amount":{"type":"number","description":"amount"},"updatedAccountBalance":{"type":"number","description":"updated account balance"},"currency":{"type":"string","description":"amount currency"},"purpose":{"type":"string","description":"purpose text"},"name":{"type":"string","description":"counterpart name"},"iban":{"type":"string","description":"counterpart iban"},"bic":{"type":"string","description":"counterpart bic"},"accountNumber":{"type":"string","description":"counterpart account number"},"blz":{"type":"string","description":"counterpart bank number"},"bankName":{"type":"string","description":"counterpart bank name"},"mandateReference":{"type":"string","description":"mandate reference"},"customerReference":{"type":"string","description":"customer reference"},"creditorId":{"type":"string","description":"creditor id"},"debitorId":{"type":"string","description":"debitor id"},"transactionType":{"type":"string","description":"transaction type (text)"},"transactionCodeZKA":{"type":"string","description":"transaction type (ZKA-code)"},"transactionCodeSWIFT":{"type":"string","description":"transaction type (SWIFT-code)"},"purposeCode":{"type":"string","description":"purpose code"},"primanota":{"type":"string","description":"primanota"},"endToEndId":{"type":"string","description":"End-To-End-Id"},"compensationAmount":{"type":"number","description":"compensation amount (i.e. return debit fees)"},"originalAmount":{"type":"number","description":"original amount"},"originalCurrency":{"type":"string","description":"currency of original amount"},"userComment":{"type":"string","description":"manual comments added by the user"},"isPotentialDuplicate":{"type":"boolean","description":"potentielles Duplikat","readOnly":true},"matchingState":{"type":"string","description":"whether the transaction has been completely or partially matched with open items or not matched at all","enum":["MATCHED","PARTIALLY_MATCHED","NOT_MATCHED","NOT_RELEVANT"],"readOnly":true},"direction":{"type":"string","description":"whether this transaction was incoming or outgoing","enum":["INCOMING","OUTGOING"]},"openItemRecordRefs":{"type":"array","description":"openItem record reference","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/bank/transactions/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{id}":{"delete":{"tags":["BankTransactions"],"summary":"Delete an existing Resource","operationId":"delete_68","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/bank/transactions > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions":{"post":{"tags":["BankTransactions"],"summary":"Create new Resource","operationId":"create_66","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankTransaction"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankTransaction"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-BankTransaction":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountId":{"type":"integer","format":"int64","description":"id of the account"},"parentId":{"type":"integer","format":"int64","description":"id of the parent transaction"},"valueDate":{"type":"string","format":"date-time","description":"value date"},"bookingDate":{"type":"string","format":"date-time","description":"booking date"},"amount":{"type":"number","description":"amount"},"updatedAccountBalance":{"type":"number","description":"updated account balance"},"currency":{"type":"string","description":"amount currency"},"purpose":{"type":"string","description":"purpose text"},"name":{"type":"string","description":"counterpart name"},"iban":{"type":"string","description":"counterpart iban"},"bic":{"type":"string","description":"counterpart bic"},"accountNumber":{"type":"string","description":"counterpart account number"},"blz":{"type":"string","description":"counterpart bank number"},"bankName":{"type":"string","description":"counterpart bank name"},"mandateReference":{"type":"string","description":"mandate reference"},"customerReference":{"type":"string","description":"customer reference"},"creditorId":{"type":"string","description":"creditor id"},"debitorId":{"type":"string","description":"debitor id"},"transactionType":{"type":"string","description":"transaction type (text)"},"transactionCodeZKA":{"type":"string","description":"transaction type (ZKA-code)"},"transactionCodeSWIFT":{"type":"string","description":"transaction type (SWIFT-code)"},"purposeCode":{"type":"string","description":"purpose code"},"primanota":{"type":"string","description":"primanota"},"endToEndId":{"type":"string","description":"End-To-End-Id"},"compensationAmount":{"type":"number","description":"compensation amount (i.e. return debit fees)"},"originalAmount":{"type":"number","description":"original amount"},"originalCurrency":{"type":"string","description":"currency of original amount"},"userComment":{"type":"string","description":"manual comments added by the user"},"isPotentialDuplicate":{"type":"boolean","description":"potentielles Duplikat","readOnly":true},"matchingState":{"type":"string","description":"whether the transaction has been completely or partially matched with open items or not matched at all","enum":["MATCHED","PARTIALLY_MATCHED","NOT_MATCHED","NOT_RELEVANT"],"readOnly":true},"direction":{"type":"string","description":"whether this transaction was incoming or outgoing","enum":["INCOMING","OUTGOING"]},"openItemRecordRefs":{"type":"array","description":"openItem record reference","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/bank/transactions/{transactionId}/{openItemRecordId}/reassignTransaction > weist eine Transaction einem anderen OP zu ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{transactionId}/{openItemRecordId}/reassignTransaction":{"post":{"tags":["BankTransactions"],"description":"weist eine Transaction einem anderen OP zu","operationId":"reassignTransaction_1","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"openItemRecordId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemTransactionReassignRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemTransactionReassignRequest":{"properties":{"targetOpenItemId":{"type":"integer","format":"int64","description":"neuer OP dem die Transaction zugewiesen werden soll"}}},"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## POST /erp/bank/transactions/{transactionId}/recalculate > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{transactionId}/recalculate":{"post":{"tags":["BankTransactions"],"operationId":"recalculateTransaction","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## POST /erp/bank/transactions/{transactionId}/match\_with\_payment/{paymentId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{transactionId}/match_with_payment/{paymentId}":{"post":{"tags":["BankTransactions"],"operationId":"matchWithPayment","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"paymentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-PaymentAssignment"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-OpenItemDistributionResult"}}}}}}}},"components":{"schemas":{"erp-bank-PaymentAssignment":{"properties":{"paymentId":{"type":"integer","format":"int64","description":"Id der Sammellastschrift"},"comment":{"type":"string","description":"Kommentar zur Buchung"},"forceComplete":{"type":"boolean","description":"Soll die Transaktion abgeschlossen und ein Restbetrag als irrelevant verbuicht werden?"}}},"erp-bank-OpenItemDistributionResult":{"properties":{"type":{"type":"string","description":"The result type of the attempt to match open item with transaction","enum":["DONE","TRANSACTION_COMPLETED","TRANSACTION_FORCEFULLY_COMPLETED","TRANSACTION_MARKED_RELEVANT","WITH_OVERPAID_OPEN_ITEMS"]},"amount":{"type":"number","description":"If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant"},"overpaidOpenItems":{"type":"array","description":"If applicable a list of overpaid open items","items":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}},"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## POST /erp/bank/transactions/{transactionId}/match\_with\_open\_item > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{transactionId}/match_with_open_item":{"post":{"tags":["BankTransactions"],"operationId":"matchWithTransaction","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-bank-OpenItemDistribution"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-OpenItemDistributionResult"}}}}}}}},"components":{"schemas":{"erp-bank-OpenItemDistribution":{"properties":{"openItemId":{"type":"integer","format":"int64","description":"The ID of the open item to be matched with the transaction"},"forceComplete":{"type":"boolean","description":"The total amount to be booked against this combination of open item and transaction"},"distributionLines":{"type":"array","description":"Betragszeilen","items":{"$ref":"#/components/schemas/erp-bank-OpenItemDistributionLine"}}},"required":["distributionLines","openItemId"]},"erp-bank-OpenItemDistributionLine":{"description":"Betragszeilen","properties":{"lineType":{"type":"string","description":"Zeilentyp","enum":["PAYMENT","DUNNING","FEE"]},"businessTransactionId":{"type":"integer","format":"int64","description":"Id des Geschäftsvorfalls"},"amount":{"type":"number","description":"der zu buchende (Mahn-)Betrag/die zu buchende Gebühr"},"discountOrFeeAmount":{"type":"number","description":"enthaltener Skonto oder Mahngebühren"},"comment":{"type":"string","description":"Kommentar"},"dunningRecordId":{"type":"integer","format":"int64","description":"Id of the dunning record to pay towards"}},"required":["amount","lineType"]},"erp-bank-OpenItemDistributionResult":{"properties":{"type":{"type":"string","description":"The result type of the attempt to match open item with transaction","enum":["DONE","TRANSACTION_COMPLETED","TRANSACTION_FORCEFULLY_COMPLETED","TRANSACTION_MARKED_RELEVANT","WITH_OVERPAID_OPEN_ITEMS"]},"amount":{"type":"number","description":"If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant"},"overpaidOpenItems":{"type":"array","description":"If applicable a list of overpaid open items","items":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}},"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## POST /erp/bank/transactions/{transactionId}/mark\_as\_relevant > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{transactionId}/mark_as_relevant":{"post":{"tags":["BankTransactions"],"operationId":"markAsRelevant","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-ManualBookingResult"}}}}}}}},"components":{"schemas":{"erp-bank-ManualBookingResult":{"properties":{"type":{"type":"string","description":"The result type of the attempt to manually book transaction","enum":["DONE","TRANSACTION_COMPLETED","TRANSACTION_FORCEFULLY_COMPLETED","TRANSACTION_MARKED_RELEVANT","WITH_OVERPAID_OPEN_ITEMS"]},"amount":{"type":"number","description":"If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant"},"bookingIds":{"type":"array","description":"The ids of the manual bookings if successful","items":{"type":"integer","format":"int64","description":"The ids of the manual bookings if successful"}},"irrelevantBookingId":{"type":"integer","format":"int64","description":"The id of the irrelevancy marker booking if applicable"}}}}}} ``` ## POST /erp/bank/transactions/{transactionId}/manual\_booking > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{transactionId}/manual_booking":{"post":{"tags":["BankTransactions"],"operationId":"bookManually","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-ManualFinanceBookingRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-ManualBookingResult"}}}}}}}},"components":{"schemas":{"erp-finance-ManualFinanceBookingRequest":{"properties":{"ledgerBookingAccountDistributions":{"type":"array","description":"list booking account distributions","items":{"$ref":"#/components/schemas/erp-finance-ManualFinanceBookingAccountDistribution"}},"comment":{"type":"string","description":"commentary"},"forceComplete":{"type":"boolean","description":"Unbooked value should be marked as irrelevant"},"notRelevant":{"type":"boolean","description":"transaction is not relevant for business"},"templateId":{"type":"integer","format":"int64","description":"Template Vorlage"}},"required":["comment"]},"erp-finance-ManualFinanceBookingAccountDistribution":{"description":"list booking account distributions","properties":{"ledgerNumber":{"type":"string","description":"FiBu-Konto"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"documentField1":{"type":"string","description":"Belegfeld 1"},"distributionAmount":{"type":"number","description":"Aufteilungsbetrag"}}},"erp-bank-ManualBookingResult":{"properties":{"type":{"type":"string","description":"The result type of the attempt to manually book transaction","enum":["DONE","TRANSACTION_COMPLETED","TRANSACTION_FORCEFULLY_COMPLETED","TRANSACTION_MARKED_RELEVANT","WITH_OVERPAID_OPEN_ITEMS"]},"amount":{"type":"number","description":"If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant"},"bookingIds":{"type":"array","description":"The ids of the manual bookings if successful","items":{"type":"integer","format":"int64","description":"The ids of the manual bookings if successful"}},"irrelevantBookingId":{"type":"integer","format":"int64","description":"The id of the irrelevancy marker booking if applicable"}}}}}} ``` ## POST /erp/bank/transactions/{transactionId}/add\_comment > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/{transactionId}/add_comment":{"post":{"tags":["BankTransactions"],"operationId":"addCommentToTransaction","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankTransactionComment"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"erp-bank-BankTransactionComment":{"properties":{"comment":{"type":"string","description":"the comment to be added to the transaction"},"replace":{"type":"boolean","description":"whether the comment of the transaction should be replaced or added onto"}}},"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## POST /erp/bank/transactions/reset\_state > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/reset_state":{"post":{"tags":["BankTransactions"],"operationId":"resetToCleanState","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}}}}}}}}} ``` ## POST /erp/bank/transactions/mark\_as\_not\_relevant > markiert alle Transaktionen für einen Account bis zum angegebenen Datum als nicht relevant ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankTransactions","description":"Transaktionen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/transactions/mark_as_not_relevant":{"post":{"tags":["BankTransactions"],"description":"markiert alle Transaktionen für einen Account bis zum angegebenen Datum als nicht relevant","operationId":"markAsNotRelevant","parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"toDate","in":"query","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` # Article Supplier the Article Supplier API ## GET /erp/article-suppliers/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleSupplier","description":"the Article Supplier API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-suppliers/{id}":{"get":{"tags":["ArticleSupplier"],"summary":"Find an existing Resource by identifier","operationId":"getById_84","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleSupplier"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleSupplier":{"description":"Article-Supplier-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"string","description":"Referenced Supplier-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"supplierArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"supplierArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"supplierArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"supplierArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useSupplierArticleNumber":{"type":"boolean","default":false,"description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useSupplierArticleName":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useSupplierArticleDescription":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useSupplierArticleIdentifier":{"type":"boolean","default":false,"description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"purchaseUnit":{"type":"number","description":"Einkaufseinheit"},"packagingUnit":{"type":"number","description":"Verpackungseinheit"},"productUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deliveryTime":{"type":"integer","format":"int32","description":"Lieferzeit in (Werk-)Tagen"},"minimumOrderQuantity":{"type":"number","description":"Mindestbestellmenge"},"supplierReportingStock":{"type":"number","description":"Lieferanten-Meldebestand"},"mainSupplier":{"type":"boolean","default":false,"description":"Hauptlieferant"},"discountGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Lieferanten-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"orderOnComponentBase":{"type":"boolean","default":true,"description":"Sollen Baugruppen auf Komponenten-Basis bestellt werden?)"},"dropShippingAllowed":{"type":"boolean","description":"Kennzeichen, ob Streckengeschäft erlaubt"},"supplierPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"}},"required":["accountId","active","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/article-suppliers/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleSupplier","description":"the Article Supplier API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-suppliers/{id}":{"put":{"tags":["ArticleSupplier"],"summary":"Update existing Resource ","operationId":"update_78","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleSupplier"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleSupplier"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleSupplier":{"description":"Article-Supplier-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"string","description":"Referenced Supplier-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"supplierArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"supplierArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"supplierArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"supplierArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useSupplierArticleNumber":{"type":"boolean","default":false,"description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useSupplierArticleName":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useSupplierArticleDescription":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useSupplierArticleIdentifier":{"type":"boolean","default":false,"description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"purchaseUnit":{"type":"number","description":"Einkaufseinheit"},"packagingUnit":{"type":"number","description":"Verpackungseinheit"},"productUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deliveryTime":{"type":"integer","format":"int32","description":"Lieferzeit in (Werk-)Tagen"},"minimumOrderQuantity":{"type":"number","description":"Mindestbestellmenge"},"supplierReportingStock":{"type":"number","description":"Lieferanten-Meldebestand"},"mainSupplier":{"type":"boolean","default":false,"description":"Hauptlieferant"},"discountGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Lieferanten-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"orderOnComponentBase":{"type":"boolean","default":true,"description":"Sollen Baugruppen auf Komponenten-Basis bestellt werden?)"},"dropShippingAllowed":{"type":"boolean","description":"Kennzeichen, ob Streckengeschäft erlaubt"},"supplierPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"}},"required":["accountId","active","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/article-suppliers/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleSupplier","description":"the Article Supplier API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-suppliers/{id}":{"delete":{"tags":["ArticleSupplier"],"summary":"Delete an existing Resource","operationId":"delete_75","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/article-suppliers/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleSupplier","description":"the Article Supplier API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-suppliers/{id}/deactivate":{"put":{"tags":["ArticleSupplier"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_38","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleSupplier"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleSupplier":{"description":"Article-Supplier-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"string","description":"Referenced Supplier-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"supplierArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"supplierArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"supplierArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"supplierArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useSupplierArticleNumber":{"type":"boolean","default":false,"description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useSupplierArticleName":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useSupplierArticleDescription":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useSupplierArticleIdentifier":{"type":"boolean","default":false,"description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"purchaseUnit":{"type":"number","description":"Einkaufseinheit"},"packagingUnit":{"type":"number","description":"Verpackungseinheit"},"productUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deliveryTime":{"type":"integer","format":"int32","description":"Lieferzeit in (Werk-)Tagen"},"minimumOrderQuantity":{"type":"number","description":"Mindestbestellmenge"},"supplierReportingStock":{"type":"number","description":"Lieferanten-Meldebestand"},"mainSupplier":{"type":"boolean","default":false,"description":"Hauptlieferant"},"discountGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Lieferanten-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"orderOnComponentBase":{"type":"boolean","default":true,"description":"Sollen Baugruppen auf Komponenten-Basis bestellt werden?)"},"dropShippingAllowed":{"type":"boolean","description":"Kennzeichen, ob Streckengeschäft erlaubt"},"supplierPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"}},"required":["accountId","active","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/article-suppliers/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleSupplier","description":"the Article Supplier API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-suppliers/{id}/activate":{"put":{"tags":["ArticleSupplier"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_38","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleSupplier"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleSupplier":{"description":"Article-Supplier-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"string","description":"Referenced Supplier-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"supplierArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"supplierArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"supplierArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"supplierArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useSupplierArticleNumber":{"type":"boolean","default":false,"description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useSupplierArticleName":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useSupplierArticleDescription":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useSupplierArticleIdentifier":{"type":"boolean","default":false,"description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"purchaseUnit":{"type":"number","description":"Einkaufseinheit"},"packagingUnit":{"type":"number","description":"Verpackungseinheit"},"productUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deliveryTime":{"type":"integer","format":"int32","description":"Lieferzeit in (Werk-)Tagen"},"minimumOrderQuantity":{"type":"number","description":"Mindestbestellmenge"},"supplierReportingStock":{"type":"number","description":"Lieferanten-Meldebestand"},"mainSupplier":{"type":"boolean","default":false,"description":"Hauptlieferant"},"discountGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Lieferanten-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"orderOnComponentBase":{"type":"boolean","default":true,"description":"Sollen Baugruppen auf Komponenten-Basis bestellt werden?)"},"dropShippingAllowed":{"type":"boolean","description":"Kennzeichen, ob Streckengeschäft erlaubt"},"supplierPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"}},"required":["accountId","active","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/article-suppliers > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleSupplier","description":"the Article Supplier API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-suppliers":{"post":{"tags":["ArticleSupplier"],"summary":"Create new Resource","operationId":"create_74","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleSupplier"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleSupplier"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleSupplier":{"description":"Article-Supplier-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"string","description":"Referenced Supplier-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"supplierArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"supplierArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"supplierArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"supplierArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useSupplierArticleNumber":{"type":"boolean","default":false,"description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useSupplierArticleName":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useSupplierArticleDescription":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useSupplierArticleIdentifier":{"type":"boolean","default":false,"description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"purchaseUnit":{"type":"number","description":"Einkaufseinheit"},"packagingUnit":{"type":"number","description":"Verpackungseinheit"},"productUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deliveryTime":{"type":"integer","format":"int32","description":"Lieferzeit in (Werk-)Tagen"},"minimumOrderQuantity":{"type":"number","description":"Mindestbestellmenge"},"supplierReportingStock":{"type":"number","description":"Lieferanten-Meldebestand"},"mainSupplier":{"type":"boolean","default":false,"description":"Hauptlieferant"},"discountGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Lieferanten-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"orderOnComponentBase":{"type":"boolean","default":true,"description":"Sollen Baugruppen auf Komponenten-Basis bestellt werden?)"},"dropShippingAllowed":{"type":"boolean","description":"Kennzeichen, ob Streckengeschäft erlaubt"},"supplierPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"}},"required":["accountId","active","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Storage Area Lagerbereiche ## GET /erp/storage-areas/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"StorageArea","description":"Lagerbereiche"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storage-areas/{id}":{"get":{"tags":["StorageArea"],"summary":"Find an existing Resource by identifier","operationId":"getById_17","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageArea"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-StorageArea":{"description":"Lagerbereich","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"integer","format":"int64","description":"Storage-ID"},"label":{"type":"string","description":"Kurzbezeichnung"},"description":{"type":"string","description":"Beschreibung"}},"required":["label","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/storage-areas/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"StorageArea","description":"Lagerbereiche"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storage-areas/{id}":{"put":{"tags":["StorageArea"],"summary":"Update existing Resource ","operationId":"update_16","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageArea"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageArea"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-StorageArea":{"description":"Lagerbereich","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"integer","format":"int64","description":"Storage-ID"},"label":{"type":"string","description":"Kurzbezeichnung"},"description":{"type":"string","description":"Beschreibung"}},"required":["label","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/storage-areas/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"StorageArea","description":"Lagerbereiche"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storage-areas/{id}":{"delete":{"tags":["StorageArea"],"summary":"Delete an existing Resource","operationId":"delete_15","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/storage-areas > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"StorageArea","description":"Lagerbereiche"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storage-areas":{"post":{"tags":["StorageArea"],"summary":"Create new Resource","operationId":"create_15","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageArea"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageArea"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-StorageArea":{"description":"Lagerbereich","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"integer","format":"int64","description":"Storage-ID"},"label":{"type":"string","description":"Kurzbezeichnung"},"description":{"type":"string","description":"Beschreibung"}},"required":["label","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/storage-areas/{id}/bins > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"StorageArea","description":"Lagerbereiche"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storage-areas/{id}/bins":{"get":{"tags":["StorageArea"],"operationId":"getBinsInStorageArea","parameters":[{"name":"id","in":"path","description":"ID vom Lagerbereich","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"pageable","in":"query","required":true,"schema":{"$ref":"#/components/schemas/core-api-QueryPageableApi"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-stock-StorageBin"}}}}}}}}},"components":{"schemas":{"core-api-QueryPageableApi":{"description":"Paging","properties":{"sort":{"type":"string","description":"Liste an Feldern zur Sortierung (komma-getrennt)"},"_start":{"type":"integer","format":"int32","description":"Start-Offset"},"_limit":{"type":"integer","format":"int32","description":"Ergebnis-Limit"},"_order":{"type":"string","description":"Sortierart der Felder (asc/desc, Liste, komma-getrennt)"}}},"erp-stock-StorageBin":{"description":"Lagerplatz","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"string","description":"Lager, in dem sich der Lagerplatz befindet"},"level1":{"type":"string","description":"Ebene1","maxLength":40,"minLength":0},"level2":{"type":"string","description":"Ebene2","maxLength":40,"minLength":0},"level3":{"type":"string","description":"Ebene3","maxLength":40,"minLength":0},"level4":{"type":"string","description":"Ebene4","maxLength":40,"minLength":0},"level5":{"type":"string","description":"Ebene5","maxLength":40,"minLength":0},"level6":{"type":"string","description":"Ebene6","maxLength":40,"minLength":0},"identifier":{"type":"string","description":"Barcode"},"displayName":{"type":"string","description":"Anzeigename"},"description":{"type":"string","description":"Beschreibung"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","default":"ACTIVE","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"type":"number","description":"Maximal zulässiges Gewicht"},"heightInCM":{"type":"number","description":"Höhe in CM"},"widthInCM":{"type":"number","description":"Breite in CM"},"depthInCM":{"type":"number","description":"Tiefe in CM"},"color":{"type":"string","description":"Farbe zur Anzeige","pattern":"^#[0-9A-Fa-f]{6}$"},"comment":{"type":"string","description":"Kommentar"},"storageAreaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["displayName","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## POST /erp/storage-areas/{id}/bins > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"StorageArea","description":"Lagerbereiche"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storage-areas/{id}/bins":{"post":{"tags":["StorageArea"],"operationId":"addBinsToStorageArea","parameters":[{"name":"id","in":"path","description":"ID vom Lagerbereich","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageArea"}}}}}}}},"components":{"schemas":{"erp-stock-StorageBinSelectionApi":{"description":"Selektionskriterien zur Ermittlung von Lagerplätzen","properties":{"pageable":{"$ref":"#/components/schemas/core-api-QueryPageableApi"},"storageId":{"type":"integer","format":"int64","description":"Lager zu dem ein Lagerplatz gehört"},"storageAreaId":{"type":"integer","format":"int64","description":"Lagerbereich zu dem ein Lagerplatz gehört"},"onlyWithoutStorageArea":{"type":"boolean","default":false,"description":"Nur Lagerplätze ohne Lagerbereich"},"defaultBin":{"type":"boolean","default":false,"description":"Standard-Lagerplatz eines Lagers (nur relevant für Lager ohne Lagerplätze"},"level1":{"type":"string","description":"Ebene1"},"level2":{"type":"string","description":"Ebene2"},"level3":{"type":"string","description":"Ebene3"},"level4":{"type":"string","description":"Ebene4"},"level5":{"type":"string","description":"Ebene5"},"level6":{"type":"string","description":"Ebene6"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"},"heightInCM":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"},"widthInCM":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"},"depthInCM":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"}}},"core-api-QueryPageableApi":{"description":"Paging","properties":{"sort":{"type":"string","description":"Liste an Feldern zur Sortierung (komma-getrennt)"},"_start":{"type":"integer","format":"int32","description":"Start-Offset"},"_limit":{"type":"integer","format":"int32","description":"Ergebnis-Limit"},"_order":{"type":"string","description":"Sortierart der Felder (asc/desc, Liste, komma-getrennt)"}}},"erp-stock-StorageBinSelectionApi.Range":{"description":"Selektionsbereich von/bis","properties":{"from":{"type":"number"},"to":{"type":"number"}}},"erp-stock-StorageArea":{"description":"Lagerbereich","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"integer","format":"int64","description":"Storage-ID"},"label":{"type":"string","description":"Kurzbezeichnung"},"description":{"type":"string","description":"Beschreibung"}},"required":["label","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## DELETE /erp/storage-areas/{id}/bins > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"StorageArea","description":"Lagerbereiche"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/storage-areas/{id}/bins":{"delete":{"tags":["StorageArea"],"operationId":"removeBinsFromStorageArea","parameters":[{"name":"id","in":"path","description":"ID vom Lagerbereich","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-StorageArea"}}}}}}}},"components":{"schemas":{"erp-stock-StorageBinSelectionApi":{"description":"Selektionskriterien zur Ermittlung von Lagerplätzen","properties":{"pageable":{"$ref":"#/components/schemas/core-api-QueryPageableApi"},"storageId":{"type":"integer","format":"int64","description":"Lager zu dem ein Lagerplatz gehört"},"storageAreaId":{"type":"integer","format":"int64","description":"Lagerbereich zu dem ein Lagerplatz gehört"},"onlyWithoutStorageArea":{"type":"boolean","default":false,"description":"Nur Lagerplätze ohne Lagerbereich"},"defaultBin":{"type":"boolean","default":false,"description":"Standard-Lagerplatz eines Lagers (nur relevant für Lager ohne Lagerplätze"},"level1":{"type":"string","description":"Ebene1"},"level2":{"type":"string","description":"Ebene2"},"level3":{"type":"string","description":"Ebene3"},"level4":{"type":"string","description":"Ebene4"},"level5":{"type":"string","description":"Ebene5"},"level6":{"type":"string","description":"Ebene6"},"shelfSpace":{"type":"boolean","default":false,"description":"Normaler Regalplatz?"},"forIncomingGoods":{"type":"boolean","default":false,"description":"Für Wareneingang?"},"palletSpace":{"type":"boolean","default":false,"description":"Für Paletten/Nachschubmengen?"},"clarifySpace":{"type":"boolean","default":false,"description":"Zur Klärung?"},"forReturnedGoods":{"type":"boolean","default":false,"description":"Für Retouren?"},"useInAvailabilityDetermination":{"type":"boolean","default":false,"description":"Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?"},"state":{"type":"string","description":"Status eines Lagerplatzes","enum":["ACTIVE","INACTIVE","SUSPENDED","BLOCKED_FOR_INVENTORY"]},"maxAllowedWeight":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"},"heightInCM":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"},"widthInCM":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"},"depthInCM":{"$ref":"#/components/schemas/erp-stock-StorageBinSelectionApi.Range"}}},"core-api-QueryPageableApi":{"description":"Paging","properties":{"sort":{"type":"string","description":"Liste an Feldern zur Sortierung (komma-getrennt)"},"_start":{"type":"integer","format":"int32","description":"Start-Offset"},"_limit":{"type":"integer","format":"int32","description":"Ergebnis-Limit"},"_order":{"type":"string","description":"Sortierart der Felder (asc/desc, Liste, komma-getrennt)"}}},"erp-stock-StorageBinSelectionApi.Range":{"description":"Selektionsbereich von/bis","properties":{"from":{"type":"number"},"to":{"type":"number"}}},"erp-stock-StorageArea":{"description":"Lagerbereich","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageId":{"type":"integer","format":"int64","description":"Storage-ID"},"label":{"type":"string","description":"Kurzbezeichnung"},"description":{"type":"string","description":"Beschreibung"}},"required":["label","storageId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` # Tenant App Tenant applications ## POST /cmn/apps/{identifier}/token > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"TenantApp","description":"Tenant applications"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/apps/{identifier}/token":{"post":{"tags":["TenantApp"],"operationId":"issueInstalledAppToken","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/node-api-AppTokenDto"}}}}}}}},"components":{"schemas":{"node-api-AppTokenDto":{"properties":{"appIdentifier":{"type":"string","format":"uuid","description":"App-Identifikationsnummer"},"bearerToken":{"type":"string","description":"Bearer-Token fuer Companion-App Api"},"expiresIn":{"type":"integer","format":"int32","description":"Token wird ablaufen in Sekunden"},"issuedAt":{"type":"string","format":"date-time","description":"Token erstellt am"}}}}}} ``` ## POST /cmn/apps/{identifier}/refresh-token > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"TenantApp","description":"Tenant applications"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/apps/{identifier}/refresh-token":{"post":{"tags":["TenantApp"],"operationId":"issueInstalledAppToken_1","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/node-api-AppTokenDto"}}}}}}}},"components":{"schemas":{"node-api-AppTokenDto":{"properties":{"appIdentifier":{"type":"string","format":"uuid","description":"App-Identifikationsnummer"},"bearerToken":{"type":"string","description":"Bearer-Token fuer Companion-App Api"},"expiresIn":{"type":"integer","format":"int32","description":"Token wird ablaufen in Sekunden"},"issuedAt":{"type":"string","format":"date-time","description":"Token erstellt am"}}}}}} ``` ## POST /cmn/apps/{identifier}/permitted-token > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"TenantApp","description":"Tenant applications"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/apps/{identifier}/permitted-token":{"post":{"tags":["TenantApp"],"operationId":"issueTokenByPermission","parameters":[{"name":"identifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/node-api-PermittedTokenRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/node-api-AppTokenDto"}}}}}}}},"components":{"schemas":{"node-api-PermittedTokenRequest":{"properties":{"expiresAt":{"type":"string","format":"date-time","description":"gueltig bis UTC Timestamp"},"permissions":{"type":"array","description":"Permissions","items":{"type":"string","description":"Permissions"}}}},"node-api-AppTokenDto":{"properties":{"appIdentifier":{"type":"string","format":"uuid","description":"App-Identifikationsnummer"},"bearerToken":{"type":"string","description":"Bearer-Token fuer Companion-App Api"},"expiresIn":{"type":"integer","format":"int32","description":"Token wird ablaufen in Sekunden"},"issuedAt":{"type":"string","format":"date-time","description":"Token erstellt am"}}}}}} ``` ## GET /cmn/apps/installed > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"TenantApp","description":"Tenant applications"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/apps/installed":{"get":{"tags":["TenantApp"],"operationId":"getInstalledApps","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/node-api-InstalledAppDto"}}}}}}}}},"components":{"schemas":{"node-api-InstalledAppDto":{"properties":{"installedFrom":{"type":"integer","format":"int64","description":"User Id"},"installedAt":{"type":"string","format":"date-time","description":"Installation-zeit"},"appManifest":{"$ref":"#/components/schemas/node-api-AppManifestBaseDto"},"active":{"type":"boolean","default":true,"description":"Aktiv"},"status":{"type":"string","description":"Status","enum":["ONLINE","OFFLINE_TOKEN_EXPIRED"]},"settings":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"appDomain":{"type":"string","description":"App-Domain (FQDN) für iFrame-Loading"}}},"node-api-AppManifestBaseDto":{"description":"Manifest","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"identifier":{"type":"string","format":"uuid","description":"Unique Identifier of this CompanionApp"},"label":{"type":"string","description":"label / short description"},"appVersion":{"type":"string","description":"the latest version of this app"},"privateApp":{"type":"boolean","default":true,"description":"is this a private app or published via the public app-store"},"description":{"type":"string","description":"long description"},"pcInstallationDeletionUrl":{"type":"string","description":"Webhook called if the customer uninstall the app from their installation"},"uiIntegrations":{"$ref":"#/components/schemas/node-unknownmodule-UiIntegrationsDto"},"requirements":{"$ref":"#/components/schemas/node-unknownmodule-RequirementsDto"},"authorizationVerbs":{"type":"array","description":"access rights this app needs","items":{"$ref":"#/components/schemas/node-unknownmodule-AuthorizationVerbDto"}},"active":{"type":"boolean","default":true,"description":"ob die App global aktiv ist"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"node-unknownmodule-UiIntegrationsDto":{"description":"configuration of ui integrations","properties":{"integrations":{"type":"array","description":"List of UI integrations","items":{"$ref":"#/components/schemas/node-unknownmodule-UiIntegrationDto"}}}},"node-unknownmodule-UiIntegrationDto":{"description":"List of UI integrations","properties":{"id":{"type":"string","description":"Integration ID"},"permissionKey":{"type":"string","description":"Permission key"},"pointOfIntegration":{"type":"string","description":"Integration point"},"msgKey":{"type":"string","description":"Message key"},"url":{"type":"string","description":"Integration URL"},"iconClass":{"type":"string","description":"Icon CSS class"},"contextAttribute":{"type":"object","additionalProperties":{"type":"object","description":"Context attributes"},"description":"Context attributes"}}},"node-unknownmodule-RequirementsDto":{"description":"requirements this app needs","properties":{"licenseKey":{"type":"string","description":"Single license key"},"licenseKeys":{"type":"array","description":"Multiple license keys","items":{"type":"string","description":"Multiple license keys"}},"permissions":{"type":"array","description":"Permissions list","items":{"$ref":"#/components/schemas/node-unknownmodule-RequirementsPermissionDto"}}}},"node-unknownmodule-RequirementsPermissionDto":{"description":"Permissions list","properties":{"resource":{"type":"string","description":"Resource name"},"verb":{"type":"string","description":"Permission verb"}}},"node-unknownmodule-AuthorizationVerbDto":{"description":"access rights this app needs","properties":{"verb":{"type":"string","description":"Authorization verb"},"description":{"type":"string","description":"Description"},"autoAppendable":{"type":"boolean","description":"Whether auto-appendable"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Secret Storage Verwaltung von Secrets (Passwörter, API-Keys, Tokens) ## GET /cmn/secrets/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Secret Storage","description":"Verwaltung von Secrets (Passwörter, API-Keys, Tokens)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/secrets/{id}":{"get":{"tags":["Secret Storage"],"summary":"Find an existing Resource by identifier","operationId":"getById_117","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-system-SecretStorage"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-system-SecretStorage":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Eindeutiger Name des Secrets"},"data":{"type":"array","items":{"$ref":"#/components/schemas/common-system-SecretData"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-system-SecretData":{"description":"Daten dieses Secrets","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Schlüssel einer Secret-Data"},"value":{"type":"string","description":"Wert einer Secret-Data"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/secrets/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Secret Storage","description":"Verwaltung von Secrets (Passwörter, API-Keys, Tokens)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/secrets/{id}":{"put":{"tags":["Secret Storage"],"summary":"Update existing Resource ","operationId":"update_109","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-system-SecretStorage"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-system-SecretStorage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-system-SecretStorage":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Eindeutiger Name des Secrets"},"data":{"type":"array","items":{"$ref":"#/components/schemas/common-system-SecretData"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-system-SecretData":{"description":"Daten dieses Secrets","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Schlüssel einer Secret-Data"},"value":{"type":"string","description":"Wert einer Secret-Data"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/secrets/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Secret Storage","description":"Verwaltung von Secrets (Passwörter, API-Keys, Tokens)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/secrets/{id}":{"delete":{"tags":["Secret Storage"],"summary":"Delete an existing Resource","operationId":"delete_100","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/secrets > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Secret Storage","description":"Verwaltung von Secrets (Passwörter, API-Keys, Tokens)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/secrets":{"post":{"tags":["Secret Storage"],"summary":"Create new Resource","operationId":"create_101","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-system-SecretStorage"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-system-SecretStorage"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-system-SecretStorage":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Eindeutiger Name des Secrets"},"data":{"type":"array","items":{"$ref":"#/components/schemas/common-system-SecretData"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-system-SecretData":{"description":"Daten dieses Secrets","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Schlüssel einer Secret-Data"},"value":{"type":"string","description":"Wert einer Secret-Data"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /cmn/secrets/by-name/{name} > Secret anhand des Namens laden ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Secret Storage","description":"Verwaltung von Secrets (Passwörter, API-Keys, Tokens)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/secrets/by-name/{name}":{"get":{"tags":["Secret Storage"],"summary":"Secret anhand des Namens laden","operationId":"getByName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-system-SecretStorage"}}}}}}}},"components":{"schemas":{"common-system-SecretStorage":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Eindeutiger Name des Secrets"},"data":{"type":"array","items":{"$ref":"#/components/schemas/common-system-SecretData"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-system-SecretData":{"description":"Daten dieses Secrets","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Schlüssel einer Secret-Data"},"value":{"type":"string","description":"Wert einer Secret-Data"}}}}}} ``` ## DELETE /cmn/secrets/by-name/{name} > Secret anhand des Namens löschen ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Secret Storage","description":"Verwaltung von Secrets (Passwörter, API-Keys, Tokens)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/secrets/by-name/{name}":{"delete":{"tags":["Secret Storage"],"summary":"Secret anhand des Namens löschen","operationId":"deleteByName","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}}}} ``` # Open Item Dunning Offene Posten - Mahngebühren/Mahnzinsen erfassen ## POST /erp/finance/openitems/dunning/{openItemId}/charge > Erfasst Mahngebühr/Mahnzins auf einem kreditorischen Offenen Posten und erhöht diesen ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItemDunning","description":"Offene Posten - Mahngebühren/Mahnzinsen erfassen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/dunning/{openItemId}/charge":{"post":{"tags":["OpenItemDunning"],"description":"Erfasst Mahngebühr/Mahnzins auf einem kreditorischen Offenen Posten und erhöht diesen","operationId":"charge","parameters":[{"name":"openItemId","in":"path","description":"openItem Identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemDunningChargeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemDunningChargeRequest":{"properties":{"dunningFee":{"type":"number","description":"Mahngebühr"},"dunningInterest":{"type":"number","description":"Mahnzins"},"comment":{"type":"string","description":"freie Bemerkung zur Mahngebühr"}}},"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## POST /erp/finance/openitems/dunning/{openItemId}/charge/{recordId}/revert > Storniert eine erfasste Mahngebühr/Mahnzins auf einem kreditorischen Offenen Posten ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItemDunning","description":"Offene Posten - Mahngebühren/Mahnzinsen erfassen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/dunning/{openItemId}/charge/{recordId}/revert":{"post":{"tags":["OpenItemDunning"],"description":"Storniert eine erfasste Mahngebühr/Mahnzins auf einem kreditorischen Offenen Posten","operationId":"revert_1","parameters":[{"name":"openItemId","in":"path","description":"openItem Identifier","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"recordId","in":"path","description":"openItemRecord Identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` # Country Region the Region inside a Country e.g. Bundesländer ## GET /cmn/country-region/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CountryRegion","description":"the Region inside a Country e.g. Bundesländer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/country-region/{id}":{"get":{"tags":["CountryRegion"],"summary":"Find an existing Resource by identifier","operationId":"getById_155","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CountryRegion"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CountryRegion":{"description":"Bundesland bzw. Regions-Verwaltung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label"},"abbreviation":{"type":"string","description":"Abkürzung"},"regionalCode":{"type":"string","description":"Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)"},"iso3166_2Code":{"type":"string","description":"ISO 3166-2 Code für die Region","maxLength":6,"minLength":4},"countryCode":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true}},"required":["countryCode","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/country-region/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CountryRegion","description":"the Region inside a Country e.g. Bundesländer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/country-region/{id}":{"put":{"tags":["CountryRegion"],"summary":"Update existing Resource ","operationId":"update_144","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CountryRegion"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CountryRegion"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CountryRegion":{"description":"Bundesland bzw. Regions-Verwaltung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label"},"abbreviation":{"type":"string","description":"Abkürzung"},"regionalCode":{"type":"string","description":"Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)"},"iso3166_2Code":{"type":"string","description":"ISO 3166-2 Code für die Region","maxLength":6,"minLength":4},"countryCode":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true}},"required":["countryCode","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/country-region/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CountryRegion","description":"the Region inside a Country e.g. Bundesländer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/country-region/{id}":{"delete":{"tags":["CountryRegion"],"summary":"Delete an existing Resource","operationId":"delete_131","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/country-region/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CountryRegion","description":"the Region inside a Country e.g. Bundesländer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/country-region/{id}/deactivate":{"put":{"tags":["CountryRegion"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_66","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CountryRegion"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CountryRegion":{"description":"Bundesland bzw. Regions-Verwaltung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label"},"abbreviation":{"type":"string","description":"Abkürzung"},"regionalCode":{"type":"string","description":"Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)"},"iso3166_2Code":{"type":"string","description":"ISO 3166-2 Code für die Region","maxLength":6,"minLength":4},"countryCode":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true}},"required":["countryCode","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/country-region/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CountryRegion","description":"the Region inside a Country e.g. Bundesländer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/country-region/{id}/activate":{"put":{"tags":["CountryRegion"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_66","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CountryRegion"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CountryRegion":{"description":"Bundesland bzw. Regions-Verwaltung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label"},"abbreviation":{"type":"string","description":"Abkürzung"},"regionalCode":{"type":"string","description":"Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)"},"iso3166_2Code":{"type":"string","description":"ISO 3166-2 Code für die Region","maxLength":6,"minLength":4},"countryCode":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true}},"required":["countryCode","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/country-region > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CountryRegion","description":"the Region inside a Country e.g. Bundesländer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/country-region":{"post":{"tags":["CountryRegion"],"summary":"Create new Resource","operationId":"create_132","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CountryRegion"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CountryRegion"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CountryRegion":{"description":"Bundesland bzw. Regions-Verwaltung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label"},"abbreviation":{"type":"string","description":"Abkürzung"},"regionalCode":{"type":"string","description":"Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)"},"iso3166_2Code":{"type":"string","description":"ISO 3166-2 Code für die Region","maxLength":6,"minLength":4},"countryCode":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true}},"required":["countryCode","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Variant Value Listing Listings für Variantenattributwerte ## GET /erp/variant/value-listing/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantValueListing","description":"Listings für Variantenattributwerte"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/value-listing/{id}":{"get":{"tags":["VariantValueListing"],"summary":"Find an existing Resource by identifier","operationId":"getById_8","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantValueListing"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-VariantValueListing":{"description":"Variantenattributwert-Listing","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"variantValueRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["salesChannelRef","variantValueRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/variant/value-listing/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantValueListing","description":"Listings für Variantenattributwerte"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/value-listing/{id}":{"put":{"tags":["VariantValueListing"],"summary":"Update existing Resource ","operationId":"update_7","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantValueListing"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantValueListing"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-VariantValueListing":{"description":"Variantenattributwert-Listing","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"variantValueRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["salesChannelRef","variantValueRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /erp/variant/value-listing/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantValueListing","description":"Listings für Variantenattributwerte"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/value-listing/{id}":{"delete":{"tags":["VariantValueListing"],"summary":"Delete an existing Resource","operationId":"delete_6","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/variant/value-listing > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantValueListing","description":"Listings für Variantenattributwerte"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/value-listing":{"post":{"tags":["VariantValueListing"],"summary":"Create new Resource","operationId":"create_6","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantValueListing"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantValueListing"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-VariantValueListing":{"description":"Variantenattributwert-Listing","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"variantValueRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["salesChannelRef","variantValueRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PATCH /erp/variant/value-listing/{listingId} > Partial update existing listing ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantValueListing","description":"Listings für Variantenattributwerte"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/value-listing/{listingId}":{"patch":{"tags":["VariantValueListing"],"summary":"Partial update existing listing","operationId":"partialUpdateListing","parameters":[{"name":"listingId","in":"path","description":"Listing-ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantValueListing"}}}}}}}},"components":{"schemas":{"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-sales_channel-VariantValueListing":{"description":"Variantenattributwert-Listing","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"variantValueRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["salesChannelRef","variantValueRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` # Banking Backend Bankschnittstellen ## GET /erp/bank/backend/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankingBackend","description":"Bankschnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/backend/{id}":{"get":{"tags":["BankingBackend"],"summary":"Find an existing Resource by identifier","operationId":"getById_79","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankingBackend"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-BankingBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true},"appId":{"type":"string","format":"uuid","description":"externe App-ID"},"appTransactionUrl":{"type":"string","description":"App-URL zum Transaktionsabruf"},"appPaymentUrl":{"type":"string","description":"App-URL zum Senden einer Zahlung/Lastschrift"},"appStatusUrl":{"type":"string","description":"App-URL zum Abruf des Status einer Zahlung/Lastschrift"},"backendType":{"type":"string","description":"Backend-Typ","enum":["OFFLINE","FINAPI","FINAPI_SANDBOX","MOCKBANK","APP"]}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/bank/backend/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankingBackend","description":"Bankschnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/backend/{id}":{"put":{"tags":["BankingBackend"],"summary":"Update existing Resource ","operationId":"update_72","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankingBackend"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankingBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-BankingBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true},"appId":{"type":"string","format":"uuid","description":"externe App-ID"},"appTransactionUrl":{"type":"string","description":"App-URL zum Transaktionsabruf"},"appPaymentUrl":{"type":"string","description":"App-URL zum Senden einer Zahlung/Lastschrift"},"appStatusUrl":{"type":"string","description":"App-URL zum Abruf des Status einer Zahlung/Lastschrift"},"backendType":{"type":"string","description":"Backend-Typ","enum":["OFFLINE","FINAPI","FINAPI_SANDBOX","MOCKBANK","APP"]}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/bank/backend/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankingBackend","description":"Bankschnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/backend/{id}":{"delete":{"tags":["BankingBackend"],"summary":"Delete an existing Resource","operationId":"delete_70","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/bank/backend/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankingBackend","description":"Bankschnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/backend/{id}/deactivate":{"put":{"tags":["BankingBackend"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_33","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankingBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-BankingBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true},"appId":{"type":"string","format":"uuid","description":"externe App-ID"},"appTransactionUrl":{"type":"string","description":"App-URL zum Transaktionsabruf"},"appPaymentUrl":{"type":"string","description":"App-URL zum Senden einer Zahlung/Lastschrift"},"appStatusUrl":{"type":"string","description":"App-URL zum Abruf des Status einer Zahlung/Lastschrift"},"backendType":{"type":"string","description":"Backend-Typ","enum":["OFFLINE","FINAPI","FINAPI_SANDBOX","MOCKBANK","APP"]}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/bank/backend/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankingBackend","description":"Bankschnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/backend/{id}/activate":{"put":{"tags":["BankingBackend"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_33","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankingBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-BankingBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true},"appId":{"type":"string","format":"uuid","description":"externe App-ID"},"appTransactionUrl":{"type":"string","description":"App-URL zum Transaktionsabruf"},"appPaymentUrl":{"type":"string","description":"App-URL zum Senden einer Zahlung/Lastschrift"},"appStatusUrl":{"type":"string","description":"App-URL zum Abruf des Status einer Zahlung/Lastschrift"},"backendType":{"type":"string","description":"Backend-Typ","enum":["OFFLINE","FINAPI","FINAPI_SANDBOX","MOCKBANK","APP"]}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/bank/backend > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankingBackend","description":"Bankschnittstellen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/bank/backend":{"post":{"tags":["BankingBackend"],"summary":"Create new Resource","operationId":"create_68","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankingBackend"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-bank-BankingBackend"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-bank-BankingBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true},"appId":{"type":"string","format":"uuid","description":"externe App-ID"},"appTransactionUrl":{"type":"string","description":"App-URL zum Transaktionsabruf"},"appPaymentUrl":{"type":"string","description":"App-URL zum Senden einer Zahlung/Lastschrift"},"appStatusUrl":{"type":"string","description":"App-URL zum Abruf des Status einer Zahlung/Lastschrift"},"backendType":{"type":"string","description":"Backend-Typ","enum":["OFFLINE","FINAPI","FINAPI_SANDBOX","MOCKBANK","APP"]}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Typen Von Projekten CRM Projekte: Verwaltung von Typen ## PUT /erp/crm-projects/types/{projectSubTypeId}/move/{position} > moves a line to a new position ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Projekten","description":"CRM Projekte: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-projects/types/{projectSubTypeId}/move/{position}":{"put":{"tags":["Typen von Projekten"],"summary":"moves a line to a new position","operationId":"moveLine_4","parameters":[{"name":"projectSubTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"position","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## GET /erp/crm-projects/types/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Projekten","description":"CRM Projekte: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-projects/types/{id}":{"get":{"tags":["Typen von Projekten"],"summary":"Find an existing Resource by identifier","operationId":"getById_55","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-projects/types/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Projekten","description":"CRM Projekte: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-projects/types/{id}":{"put":{"tags":["Typen von Projekten"],"summary":"Update existing Resource ","operationId":"update_51","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/crm-projects/types/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Projekten","description":"CRM Projekte: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-projects/types/{id}":{"delete":{"tags":["Typen von Projekten"],"summary":"Delete an existing Resource","operationId":"delete_49","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-projects/types/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Projekten","description":"CRM Projekte: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-projects/types/{id}/deactivate":{"put":{"tags":["Typen von Projekten"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_22","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-projects/types/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Projekten","description":"CRM Projekte: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-projects/types/{id}/activate":{"put":{"tags":["Typen von Projekten"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_22","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/crm-projects/types > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Projekten","description":"CRM Projekte: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-projects/types":{"get":{"tags":["Typen von Projekten"],"operationId":"getAll_3","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## POST /erp/crm-projects/types > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Projekten","description":"CRM Projekte: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-projects/types":{"post":{"tags":["Typen von Projekten"],"summary":"Create new Resource","operationId":"create_47","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # CRM Abrechnungslauf CRM Abrechnungslauf ## GET /erp/crm-billing-run/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CRM Abrechnungslauf","description":"CRM Abrechnungslauf"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-billing-run/{id}":{"get":{"tags":["CRM Abrechnungslauf"],"summary":"Find an existing Resource by identifier","operationId":"getById_66","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmBillingRun"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmBillingRun":{"description":"CRM Abrechnungslauf","properties":{"number":{"type":"integer","format":"int64","description":"Nummer","readOnly":true},"successful":{"type":"boolean","description":"Erfolgreich?","readOnly":true},"logLines":{"type":"array","description":"Logeinträge","items":{"$ref":"#/components/schemas/common-task-TaskLogLine"},"readOnly":true},"billingDocuments":{"type":"array","description":"Abrechnungseinträge","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true}}},"common-task-TaskLogLine":{"description":"Abschluss-Protokoll","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"logTime":{"type":"string","format":"date-time","description":"logTime","readOnly":true},"origin":{"type":"string","description":"log level","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"],"readOnly":true},"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Pos Payment Backend Kassenzahlungs-Backends bearbeiten ## PUT /erp/pos/payment/backend/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentBackend","description":"Kassenzahlungs-Backends bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/backend/{id}/deactivate":{"put":{"tags":["PosPaymentBackend"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_48","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"placePayment":{"type":"boolean","default":false,"description":"Zahlung platzieren"},"canCancel":{"type":"boolean","default":false,"description":"Stornierbar"},"canRefund":{"type":"boolean","default":false,"description":"Erstattungsfähig"}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/pos/payment/backend/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentBackend","description":"Kassenzahlungs-Backends bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/backend/{id}/activate":{"put":{"tags":["PosPaymentBackend"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_48","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"placePayment":{"type":"boolean","default":false,"description":"Zahlung platzieren"},"canCancel":{"type":"boolean","default":false,"description":"Stornierbar"},"canRefund":{"type":"boolean","default":false,"description":"Erstattungsfähig"}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/pos/payment/backend/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentBackend","description":"Kassenzahlungs-Backends bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/backend/{id}":{"get":{"tags":["PosPaymentBackend"],"summary":"Find an existing Resource by identifier","operationId":"getById_105","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentBackend"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"placePayment":{"type":"boolean","default":false,"description":"Zahlung platzieren"},"canCancel":{"type":"boolean","default":false,"description":"Stornierbar"},"canRefund":{"type":"boolean","default":false,"description":"Erstattungsfähig"}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/pos/payment/backend/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentBackend","description":"Kassenzahlungs-Backends bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/backend/{id}":{"put":{"tags":["PosPaymentBackend"],"summary":"Update existing Resource ","operationId":"update_98","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentBackend"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"placePayment":{"type":"boolean","default":false,"description":"Zahlung platzieren"},"canCancel":{"type":"boolean","default":false,"description":"Stornierbar"},"canRefund":{"type":"boolean","default":false,"description":"Erstattungsfähig"}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/pos/payment/backend/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentBackend","description":"Kassenzahlungs-Backends bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/backend/{id}":{"delete":{"tags":["PosPaymentBackend"],"summary":"Delete an existing Resource","operationId":"delete_91","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/pos/payment/backend > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentBackend","description":"Kassenzahlungs-Backends bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/backend":{"post":{"tags":["PosPaymentBackend"],"summary":"Create new Resource","operationId":"create_94","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentBackend"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentBackend"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"placePayment":{"type":"boolean","default":false,"description":"Zahlung platzieren"},"canCancel":{"type":"boolean","default":false,"description":"Stornierbar"},"canRefund":{"type":"boolean","default":false,"description":"Erstattungsfähig"}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Product Artikel kopieren ## PUT /erp/products/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Product","description":"Artikel kopieren"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/products/{id}":{"put":{"tags":["Product"],"summary":"Update existing Resource ","operationId":"update_21","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-Product"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-Product"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-Product":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bundle":{"type":"boolean","default":false,"description":"Handelt es sich um ein Gebinde?"},"bundleSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"type":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"articleRefs":{"type":"array","description":"alle artikel, die zu diesem Produkt gehören","items":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"readOnly":true},"availabilityDetermination":{"$ref":"#/components/schemas/erp-product-ArticleAvailabilityDetermination"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"expiryDateType":{"type":"string","description":"Art des Haltbarkeitsdatums bei Serienartikeln","enum":["NONE","BEST_BEFORE_DATE","EXPIRATION_DATE"]},"minimumRemainingDaysBeforeExpiryDateOnGoodsReceipt":{"type":"integer","format":"int32","description":"Mindestrestlaufzeit Eingang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel bei der Einbuchung in ein Verkaufslager noch aufweisen muss"},"minimumRemainingDaysBeforeExpiryDateForGoodsIssued":{"type":"integer","format":"int32","description":"Mindestrestlaufzeit Ausgang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel beim Verkauf noch aufweisen muss"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"lotOnlyRequiredWhenBookedToSalesStorage":{"type":"boolean","default":false,"description":"Charge muss bei Einbuchung in ein Verkaufslager vergeben werden (für Serientyp LOT und BEST_BEFORE)"},"serialNumberLabelingType":{"type":"string","description":"Seriennummer Auszeichnungsart","enum":["MANUAL","AUTOMATIC_ON_SUPPLIER_ORDER","AUTOMATIC_ON_SUPPLIER_DELIVERY"]},"fabricationSerialNumberLabelingType":{"type":"string","description":"Produktions-S/N-Auszeichnungsart","enum":["QUERY_ON_START","QUERY_ON_FINISH","INHERITANCE","AUTOMATICALLY_ON_START","AUTOMATICALLY_ON_FINISH"]},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"countryOfOrigin":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"regionOfOrigin":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"useSerialSequencerConfiguration":{"type":"boolean","description":"Soll ein eigener Zählerkreis für Seriennummern verwendet werden?"},"serialSequencerConfiguration":{"$ref":"#/components/schemas/common-sequencer-SequencerConfiguration"},"variantValues":{"type":"array","description":"Variantenwerte","items":{"$ref":"#/components/schemas/common-variant-VariantValueReference"}},"variantSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainVariantProductRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-ArticleAvailabilityDetermination":{"description":"Verfügbarkeitsermittlung für die Artikelstammdaten/Bestandsansicht","properties":{"inStock":{"type":"string","description":"wie wird der Bestand behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"reserved":{"type":"string","description":"wie werden Reserviert-Mengen behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"ordered":{"type":"string","description":"wie werden Bestellt-Mengen behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"inPicking":{"type":"string","description":"wie werden Mengen in Kommissionierung behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"reporting":{"type":"string","description":"wie werden Meldebestände behandelt","enum":["IGNORE","ADD","SUBTRACT"]}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"common-sequencer-SequencerConfiguration":{"description":"Eigener Zählerkreis für Seriennummern","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Unique key to identify the sequencer configuration","readOnly":true},"configurationGroup":{"type":"string","description":"Group of the sequencer configuration (e.g. Document, Account, ...)","readOnly":true},"configurationDetail":{"$ref":"#/components/schemas/common-sequencer-SequencerConfigurationDetail"},"alternativeConfiguration":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Sequencer aktiv?"}},"required":["configurationDetail"]},"common-sequencer-SequencerConfigurationDetail":{"description":"Contains details about the sequencer configuration","properties":{"type":{"type":"string","description":"Typ der Sequenz","enum":["NON_POOLED_SEQUENCES","POOLED_SEQUENCES","PREFETCHED_SEQUENCES"]},"assignmentMode":{"type":"string","description":"Vergabeverfahren","enum":["MANUAL","AUTOMATIC","SEMI_AUTOMATIC","FREE"]},"length":{"type":"integer","format":"int32","description":"Länge"},"padChar":{"type":"string","description":"Auffüllzeichen","maxLength":1,"minLength":1,"pattern":"^[0-9]*$"},"expression":{"type":"string","description":"Präfix-Ausdruck"},"postExpression":{"type":"string","description":"Postfix-Ausdruck"},"initialValue":{"type":"integer","format":"int64","description":"Initialer Wert"},"numberUnique":{"type":"boolean","default":true,"description":"Eindeutigkeitsprüfung"}},"required":["assignmentMode","initialValue","length","padChar","type"]},"common-variant-VariantValueReference":{"description":"Variantenwerte","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"Bezeichnung","readOnly":true},"description":{"type":"string","description":"Beschreibung","readOnly":true},"variantAttributeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/products/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Product","description":"Artikel kopieren"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/products/{id}":{"delete":{"tags":["Product"],"summary":"Delete an existing Resource","operationId":"delete_20","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/products/{id}/copy > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Product","description":"Artikel kopieren"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/products/{id}/copy":{"post":{"tags":["Product"],"operationId":"copy","parameters":[{"name":"id","in":"path","description":"a product id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ProductCopyCommand"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-Product"}}}}}}}},"components":{"schemas":{"erp-product-ProductCopyCommand":{"properties":{"modules":{"type":"array","description":"Relations to be copied","items":{"type":"string","description":"Relations to be copied","enum":["CUSTOM","CUSTOMERS","MEDIA","SUPPLIERS","TEXTS","PRICES","SERIAL_NUMBER"]},"uniqueItems":true},"copyEntries":{"type":"array","description":"Mapping of Articles to be copied","items":{"$ref":"#/components/schemas/erp-product-ArticleCopyEntry"},"uniqueItems":true},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]}},"required":["copyEntries"]},"erp-product-ArticleCopyEntry":{"description":"Mapping of Articles to be copied","properties":{"originalArticleId":{"type":"string","description":"ID of original article"},"newNumber":{"type":"string","description":"new number for the copy"}},"required":["newNumber"]},"erp-product-Product":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bundle":{"type":"boolean","default":false,"description":"Handelt es sich um ein Gebinde?"},"bundleSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"type":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"articleRefs":{"type":"array","description":"alle artikel, die zu diesem Produkt gehören","items":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"readOnly":true},"availabilityDetermination":{"$ref":"#/components/schemas/erp-product-ArticleAvailabilityDetermination"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"expiryDateType":{"type":"string","description":"Art des Haltbarkeitsdatums bei Serienartikeln","enum":["NONE","BEST_BEFORE_DATE","EXPIRATION_DATE"]},"minimumRemainingDaysBeforeExpiryDateOnGoodsReceipt":{"type":"integer","format":"int32","description":"Mindestrestlaufzeit Eingang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel bei der Einbuchung in ein Verkaufslager noch aufweisen muss"},"minimumRemainingDaysBeforeExpiryDateForGoodsIssued":{"type":"integer","format":"int32","description":"Mindestrestlaufzeit Ausgang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel beim Verkauf noch aufweisen muss"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"lotOnlyRequiredWhenBookedToSalesStorage":{"type":"boolean","default":false,"description":"Charge muss bei Einbuchung in ein Verkaufslager vergeben werden (für Serientyp LOT und BEST_BEFORE)"},"serialNumberLabelingType":{"type":"string","description":"Seriennummer Auszeichnungsart","enum":["MANUAL","AUTOMATIC_ON_SUPPLIER_ORDER","AUTOMATIC_ON_SUPPLIER_DELIVERY"]},"fabricationSerialNumberLabelingType":{"type":"string","description":"Produktions-S/N-Auszeichnungsart","enum":["QUERY_ON_START","QUERY_ON_FINISH","INHERITANCE","AUTOMATICALLY_ON_START","AUTOMATICALLY_ON_FINISH"]},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"countryOfOrigin":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"regionOfOrigin":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"useSerialSequencerConfiguration":{"type":"boolean","description":"Soll ein eigener Zählerkreis für Seriennummern verwendet werden?"},"serialSequencerConfiguration":{"$ref":"#/components/schemas/common-sequencer-SequencerConfiguration"},"variantValues":{"type":"array","description":"Variantenwerte","items":{"$ref":"#/components/schemas/common-variant-VariantValueReference"}},"variantSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainVariantProductRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-ArticleAvailabilityDetermination":{"description":"Verfügbarkeitsermittlung für die Artikelstammdaten/Bestandsansicht","properties":{"inStock":{"type":"string","description":"wie wird der Bestand behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"reserved":{"type":"string","description":"wie werden Reserviert-Mengen behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"ordered":{"type":"string","description":"wie werden Bestellt-Mengen behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"inPicking":{"type":"string","description":"wie werden Mengen in Kommissionierung behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"reporting":{"type":"string","description":"wie werden Meldebestände behandelt","enum":["IGNORE","ADD","SUBTRACT"]}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"common-sequencer-SequencerConfiguration":{"description":"Eigener Zählerkreis für Seriennummern","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"key":{"type":"string","description":"Unique key to identify the sequencer configuration","readOnly":true},"configurationGroup":{"type":"string","description":"Group of the sequencer configuration (e.g. Document, Account, ...)","readOnly":true},"configurationDetail":{"$ref":"#/components/schemas/common-sequencer-SequencerConfigurationDetail"},"alternativeConfiguration":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Sequencer aktiv?"}},"required":["configurationDetail"]},"common-sequencer-SequencerConfigurationDetail":{"description":"Contains details about the sequencer configuration","properties":{"type":{"type":"string","description":"Typ der Sequenz","enum":["NON_POOLED_SEQUENCES","POOLED_SEQUENCES","PREFETCHED_SEQUENCES"]},"assignmentMode":{"type":"string","description":"Vergabeverfahren","enum":["MANUAL","AUTOMATIC","SEMI_AUTOMATIC","FREE"]},"length":{"type":"integer","format":"int32","description":"Länge"},"padChar":{"type":"string","description":"Auffüllzeichen","maxLength":1,"minLength":1,"pattern":"^[0-9]*$"},"expression":{"type":"string","description":"Präfix-Ausdruck"},"postExpression":{"type":"string","description":"Postfix-Ausdruck"},"initialValue":{"type":"integer","format":"int64","description":"Initialer Wert"},"numberUnique":{"type":"boolean","default":true,"description":"Eindeutigkeitsprüfung"}},"required":["assignmentMode","initialValue","length","padChar","type"]},"common-variant-VariantValueReference":{"description":"Variantenwerte","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"Bezeichnung","readOnly":true},"description":{"type":"string","description":"Beschreibung","readOnly":true},"variantAttributeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["id"]}}}} ``` ## GET /erp/products/{id}/suppliers > Für Gebinde: Alle Lieferanten zu Artikeln des Gebindes ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Product","description":"Artikel kopieren"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/products/{id}/suppliers":{"get":{"tags":["Product"],"summary":"Für Gebinde: Alle Lieferanten zu Artikeln des Gebindes","operationId":"getSuppliersByProduct","parameters":[{"name":"id","in":"path","description":"a product id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-product-ArticleSupplier"}}}}}}}}},"components":{"schemas":{"erp-product-ArticleSupplier":{"description":"Article-Supplier-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"string","description":"Referenced Supplier-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"supplierArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"supplierArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"supplierArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"supplierArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useSupplierArticleNumber":{"type":"boolean","default":false,"description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useSupplierArticleName":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useSupplierArticleDescription":{"type":"boolean","default":false,"description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useSupplierArticleIdentifier":{"type":"boolean","default":false,"description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"purchaseUnit":{"type":"number","description":"Einkaufseinheit"},"packagingUnit":{"type":"number","description":"Verpackungseinheit"},"productUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deliveryTime":{"type":"integer","format":"int32","description":"Lieferzeit in (Werk-)Tagen"},"minimumOrderQuantity":{"type":"number","description":"Mindestbestellmenge"},"supplierReportingStock":{"type":"number","description":"Lieferanten-Meldebestand"},"mainSupplier":{"type":"boolean","default":false,"description":"Hauptlieferant"},"discountGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Lieferanten-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"orderOnComponentBase":{"type":"boolean","default":true,"description":"Sollen Baugruppen auf Komponenten-Basis bestellt werden?)"},"dropShippingAllowed":{"type":"boolean","description":"Kennzeichen, ob Streckengeschäft erlaubt"},"supplierPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"}},"required":["accountId","active","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}}}}} ``` ## GET /erp/products/{id}/customers > Für Gebinde: Alle Kunden zu Artikeln des Gebindes ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Product","description":"Artikel kopieren"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/products/{id}/customers":{"get":{"tags":["Product"],"summary":"Für Gebinde: Alle Kunden zu Artikeln des Gebindes","operationId":"getCustomersByProduct","parameters":[{"name":"id","in":"path","description":"a product id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-product-ArticleCustomer"}}}}}}}}},"components":{"schemas":{"erp-product-ArticleCustomer":{"description":"Article-Customer-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"integer","format":"int64","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"integer","format":"int64","description":"Referenced Customer-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","description":"Aktiv?"},"deviatingArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"deviatingArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"deviatingArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"deviatingArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useDeviatingArticleNumber":{"type":"boolean","description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useDeviatingArticleName":{"type":"boolean","description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleDescription":{"type":"boolean","description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleIdentifier":{"type":"boolean","description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"lockedForCustomer":{"type":"boolean","description":"Ist das Produkt für den Kunden gesperrt?"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Kunden-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"customerPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"},"priceDetermination":{"type":"string","default":"DEFAULT","description":"Art der Preisermittlung","enum":["DEFAULT","SPECIAL","ONLY_DEFAULT_PRICE"]}},"required":["accountId","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}}}}} ``` ## GET /erp/products/{id}/convertPriceForGivenUnitTypeForAnotherUnitType > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Product","description":"Artikel kopieren"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/products/{id}/convertPriceForGivenUnitTypeForAnotherUnitType":{"get":{"tags":["Product"],"operationId":"convertGivenPriceForGivenBundleForAnotherBundle","parameters":[{"name":"id","in":"path","description":"ID des Produkts","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"priceUnitTypeId","in":"query","required":true,"style":"form","schema":{"description":"Id der Mengeneinheit für den der Preis gilt"}},{"name":"convertToUnitTypeId","in":"query","required":true,"style":"form","schema":{"description":"Id der Mengeneinheit für den der Preis umgerechnet werden soll"}},{"name":"price","in":"query","required":true,"style":"form","schema":{"description":"Preis"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"number"}}}}}}}}} ``` # Currency Code the CurrencyCode according to ISO-4217 ## GET /cmn/currency-codes/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyCode","description":"the CurrencyCode according to ISO-4217"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes/{id}":{"get":{"tags":["CurrencyCode"],"summary":"Find an existing Resource by identifier","operationId":"getById_151","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyCode"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CurrencyCode":{"description":"currency codes - ISO 4217","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"label of this currency","maxLength":255,"minLength":1},"isoAlpha3":{"type":"string","description":"ISO A(3) value of this currency","maxLength":3,"minLength":3},"isoNumeric":{"type":"string","description":"ISO N(3) value of this currency","maxLength":3,"minLength":3},"symbol":{"type":"string","description":"symbol of this currency","maxLength":5,"minLength":1},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true},"showInDropDowns":{"type":"boolean","default":true,"description":"DropDown Visibility"}},"required":["isoAlpha3","isoNumeric","label","showInDropDowns","symbol"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/currency-codes/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyCode","description":"the CurrencyCode according to ISO-4217"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes/{id}":{"put":{"tags":["CurrencyCode"],"summary":"Update existing Resource ","operationId":"update_140","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyCode"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyCode"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CurrencyCode":{"description":"currency codes - ISO 4217","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"label of this currency","maxLength":255,"minLength":1},"isoAlpha3":{"type":"string","description":"ISO A(3) value of this currency","maxLength":3,"minLength":3},"isoNumeric":{"type":"string","description":"ISO N(3) value of this currency","maxLength":3,"minLength":3},"symbol":{"type":"string","description":"symbol of this currency","maxLength":5,"minLength":1},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true},"showInDropDowns":{"type":"boolean","default":true,"description":"DropDown Visibility"}},"required":["isoAlpha3","isoNumeric","label","showInDropDowns","symbol"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/currency-codes/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyCode","description":"the CurrencyCode according to ISO-4217"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes/{id}":{"delete":{"tags":["CurrencyCode"],"summary":"Delete an existing Resource","operationId":"delete_127","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/currency-codes/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyCode","description":"the CurrencyCode according to ISO-4217"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes/{id}/deactivate":{"put":{"tags":["CurrencyCode"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_65","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyCode"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CurrencyCode":{"description":"currency codes - ISO 4217","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"label of this currency","maxLength":255,"minLength":1},"isoAlpha3":{"type":"string","description":"ISO A(3) value of this currency","maxLength":3,"minLength":3},"isoNumeric":{"type":"string","description":"ISO N(3) value of this currency","maxLength":3,"minLength":3},"symbol":{"type":"string","description":"symbol of this currency","maxLength":5,"minLength":1},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true},"showInDropDowns":{"type":"boolean","default":true,"description":"DropDown Visibility"}},"required":["isoAlpha3","isoNumeric","label","showInDropDowns","symbol"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/currency-codes/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyCode","description":"the CurrencyCode according to ISO-4217"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes/{id}/activate":{"put":{"tags":["CurrencyCode"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_65","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyCode"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CurrencyCode":{"description":"currency codes - ISO 4217","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"label of this currency","maxLength":255,"minLength":1},"isoAlpha3":{"type":"string","description":"ISO A(3) value of this currency","maxLength":3,"minLength":3},"isoNumeric":{"type":"string","description":"ISO N(3) value of this currency","maxLength":3,"minLength":3},"symbol":{"type":"string","description":"symbol of this currency","maxLength":5,"minLength":1},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true},"showInDropDowns":{"type":"boolean","default":true,"description":"DropDown Visibility"}},"required":["isoAlpha3","isoNumeric","label","showInDropDowns","symbol"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/currency-codes > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyCode","description":"the CurrencyCode according to ISO-4217"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes":{"post":{"tags":["CurrencyCode"],"summary":"Create new Resource","operationId":"create_128","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyCode"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyCode"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CurrencyCode":{"description":"currency codes - ISO 4217","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"label of this currency","maxLength":255,"minLength":1},"isoAlpha3":{"type":"string","description":"ISO A(3) value of this currency","maxLength":3,"minLength":3},"isoNumeric":{"type":"string","description":"ISO N(3) value of this currency","maxLength":3,"minLength":3},"symbol":{"type":"string","description":"symbol of this currency","maxLength":5,"minLength":1},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true},"showInDropDowns":{"type":"boolean","default":true,"description":"DropDown Visibility"}},"required":["isoAlpha3","isoNumeric","label","showInDropDowns","symbol"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Aktivitätstypen Pro Benutzer CRM Aktivitätstypen pro Benutzer ## GET /erp/crm-activities/types-per-user/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Aktivitätstypen pro Benutzer","description":"CRM Aktivitätstypen pro Benutzer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-activities/types-per-user/{id}":{"get":{"tags":["Aktivitätstypen pro Benutzer"],"summary":"Find an existing Resource by identifier","operationId":"getById_69","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmActivityTypePerUser"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmActivityTypePerUser":{"description":"CRM Aktivitätstypen pro Benutzer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"activityTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultOfUser":{"type":"boolean","default":false,"description":"Standard für Benutzer"},"defaultBillingType":{"type":"string","description":"Abrechungsart von Aktivitäten","enum":["LIKE_TASK","UNCLEAR","CUSTOMER","INTERNAL","PLANNED"]}},"required":["activityTypeRef","defaultBillingType","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-activities/types-per-user/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Aktivitätstypen pro Benutzer","description":"CRM Aktivitätstypen pro Benutzer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-activities/types-per-user/{id}":{"put":{"tags":["Aktivitätstypen pro Benutzer"],"summary":"Update existing Resource ","operationId":"update_64","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmActivityTypePerUser"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmActivityTypePerUser"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmActivityTypePerUser":{"description":"CRM Aktivitätstypen pro Benutzer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"activityTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultOfUser":{"type":"boolean","default":false,"description":"Standard für Benutzer"},"defaultBillingType":{"type":"string","description":"Abrechungsart von Aktivitäten","enum":["LIKE_TASK","UNCLEAR","CUSTOMER","INTERNAL","PLANNED"]}},"required":["activityTypeRef","defaultBillingType","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/crm-activities/types-per-user/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Aktivitätstypen pro Benutzer","description":"CRM Aktivitätstypen pro Benutzer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-activities/types-per-user/{id}":{"delete":{"tags":["Aktivitätstypen pro Benutzer"],"summary":"Delete an existing Resource","operationId":"delete_62","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/crm-activities/types-per-user > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Aktivitätstypen pro Benutzer","description":"CRM Aktivitätstypen pro Benutzer"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-activities/types-per-user":{"post":{"tags":["Aktivitätstypen pro Benutzer"],"summary":"Create new Resource","operationId":"create_60","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmActivityTypePerUser"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmActivityTypePerUser"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmActivityTypePerUser":{"description":"CRM Aktivitätstypen pro Benutzer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"activityTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultOfUser":{"type":"boolean","default":false,"description":"Standard für Benutzer"},"defaultBillingType":{"type":"string","description":"Abrechungsart von Aktivitäten","enum":["LIKE_TASK","UNCLEAR","CUSTOMER","INTERNAL","PLANNED"]}},"required":["activityTypeRef","defaultBillingType","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # App Scripting Proxy Scripting proxy configuration ## GET /cmn/system/app-scripting-proxy/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"AppScriptingProxy","description":"Scripting proxy configuration"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/system/app-scripting-proxy/{id}":{"get":{"tags":["AppScriptingProxy"],"summary":"Find an existing Resource by identifier","operationId":"getById_115","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-AppScriptingProxy"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-AppScriptingProxy":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"triggerId":{"type":"string","description":"Trigger zur Ausführung des Skripts","maxLength":255,"minLength":0},"script":{"type":"string","description":"Das auszuführende Skript (wenn scriptModuleRef nicht gesetzt ist)","maxLength":2147483647,"minLength":0},"scriptModuleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["appIdentifier","triggerId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/system/app-scripting-proxy/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"AppScriptingProxy","description":"Scripting proxy configuration"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/system/app-scripting-proxy/{id}":{"put":{"tags":["AppScriptingProxy"],"summary":"Update existing Resource ","operationId":"update_107","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-AppScriptingProxy"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-AppScriptingProxy"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-AppScriptingProxy":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"triggerId":{"type":"string","description":"Trigger zur Ausführung des Skripts","maxLength":255,"minLength":0},"script":{"type":"string","description":"Das auszuführende Skript (wenn scriptModuleRef nicht gesetzt ist)","maxLength":2147483647,"minLength":0},"scriptModuleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["appIdentifier","triggerId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/system/app-scripting-proxy/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"AppScriptingProxy","description":"Scripting proxy configuration"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/system/app-scripting-proxy/{id}":{"delete":{"tags":["AppScriptingProxy"],"summary":"Delete an existing Resource","operationId":"delete_99","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/system/app-scripting-proxy/{appIdentifier}/{triggerId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"AppScriptingProxy","description":"Scripting proxy configuration"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/system/app-scripting-proxy/{appIdentifier}/{triggerId}":{"post":{"tags":["AppScriptingProxy"],"operationId":"executeScript","parameters":[{"name":"appIdentifier","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"triggerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"sessionId","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}}}}}}},"components":{"schemas":{"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/system/app-scripting-proxy > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"AppScriptingProxy","description":"Scripting proxy configuration"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/system/app-scripting-proxy":{"post":{"tags":["AppScriptingProxy"],"summary":"Create new Resource","operationId":"create_99","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-AppScriptingProxy"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-AppScriptingProxy"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-AppScriptingProxy":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"triggerId":{"type":"string","description":"Trigger zur Ausführung des Skripts","maxLength":255,"minLength":0},"script":{"type":"string","description":"Das auszuführende Skript (wenn scriptModuleRef nicht gesetzt ist)","maxLength":2147483647,"minLength":0},"scriptModuleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["appIdentifier","triggerId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Return Causes the ReturnCause API ## GET /erp/rma/return-causes/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnCauses","description":"the ReturnCause API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-causes/{id}":{"get":{"tags":["ReturnCauses"],"summary":"Find an existing Resource by identifier","operationId":"getById_20","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnCause"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnCause":{"description":"Retourengrund","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/rma/return-causes/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnCauses","description":"the ReturnCause API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-causes/{id}":{"put":{"tags":["ReturnCauses"],"summary":"Update existing Resource ","operationId":"update_19","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnCause"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnCause"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnCause":{"description":"Retourengrund","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/rma/return-causes/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnCauses","description":"the ReturnCause API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-causes/{id}":{"delete":{"tags":["ReturnCauses"],"summary":"Delete an existing Resource","operationId":"delete_18","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/rma/return-causes/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnCauses","description":"the ReturnCause API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-causes/{id}/deactivate":{"put":{"tags":["ReturnCauses"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_8","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnCause"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnCause":{"description":"Retourengrund","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/rma/return-causes/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnCauses","description":"the ReturnCause API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-causes/{id}/activate":{"put":{"tags":["ReturnCauses"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_8","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnCause"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnCause":{"description":"Retourengrund","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/rma/return-causes > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnCauses","description":"the ReturnCause API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-causes":{"post":{"tags":["ReturnCauses"],"summary":"Create new Resource","operationId":"create_18","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnCause"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnCause"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnCause":{"description":"Retourengrund","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # HTTP Whitelist Verwaltung der URL-Whitelist für den SecureHttpClient ## GET /cmn/connector/http/whitelist/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"HTTP Whitelist","description":"Verwaltung der URL-Whitelist für den SecureHttpClient"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/connector/http/whitelist/{id}":{"get":{"tags":["HTTP Whitelist"],"summary":"Find an existing Resource by identifier","operationId":"getById_157","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-connector-HttpWhitelist"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-connector-HttpWhitelist":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Typ der Whitelist-Prüfung (DOMAIN, URL, URL_PATTERN)","enum":["DOMAIN","URL","URL_PATTERN"]},"value":{"type":"string","description":"Wert der Whitelist-Prüfung (z.B. '.vario.cloud', 'https://api.example.com', 'https://*.example.com/*')"},"active":{"type":"boolean","description":"Ist der Eintrag aktiv?","readOnly":true}},"required":["type","value"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/connector/http/whitelist/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"HTTP Whitelist","description":"Verwaltung der URL-Whitelist für den SecureHttpClient"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/connector/http/whitelist/{id}":{"put":{"tags":["HTTP Whitelist"],"summary":"Update existing Resource ","operationId":"update_146","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-connector-HttpWhitelist"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-connector-HttpWhitelist"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-connector-HttpWhitelist":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Typ der Whitelist-Prüfung (DOMAIN, URL, URL_PATTERN)","enum":["DOMAIN","URL","URL_PATTERN"]},"value":{"type":"string","description":"Wert der Whitelist-Prüfung (z.B. '.vario.cloud', 'https://api.example.com', 'https://*.example.com/*')"},"active":{"type":"boolean","description":"Ist der Eintrag aktiv?","readOnly":true}},"required":["type","value"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/connector/http/whitelist/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"HTTP Whitelist","description":"Verwaltung der URL-Whitelist für den SecureHttpClient"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/connector/http/whitelist/{id}":{"delete":{"tags":["HTTP Whitelist"],"summary":"Delete an existing Resource","operationId":"delete_132","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/connector/http/whitelist/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"HTTP Whitelist","description":"Verwaltung der URL-Whitelist für den SecureHttpClient"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/connector/http/whitelist/{id}/deactivate":{"put":{"tags":["HTTP Whitelist"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_68","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-connector-HttpWhitelist"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-connector-HttpWhitelist":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Typ der Whitelist-Prüfung (DOMAIN, URL, URL_PATTERN)","enum":["DOMAIN","URL","URL_PATTERN"]},"value":{"type":"string","description":"Wert der Whitelist-Prüfung (z.B. '.vario.cloud', 'https://api.example.com', 'https://*.example.com/*')"},"active":{"type":"boolean","description":"Ist der Eintrag aktiv?","readOnly":true}},"required":["type","value"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/connector/http/whitelist/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"HTTP Whitelist","description":"Verwaltung der URL-Whitelist für den SecureHttpClient"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/connector/http/whitelist/{id}/activate":{"put":{"tags":["HTTP Whitelist"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_68","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-connector-HttpWhitelist"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-connector-HttpWhitelist":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Typ der Whitelist-Prüfung (DOMAIN, URL, URL_PATTERN)","enum":["DOMAIN","URL","URL_PATTERN"]},"value":{"type":"string","description":"Wert der Whitelist-Prüfung (z.B. '.vario.cloud', 'https://api.example.com', 'https://*.example.com/*')"},"active":{"type":"boolean","description":"Ist der Eintrag aktiv?","readOnly":true}},"required":["type","value"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/connector/http/whitelist > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"HTTP Whitelist","description":"Verwaltung der URL-Whitelist für den SecureHttpClient"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/connector/http/whitelist":{"post":{"tags":["HTTP Whitelist"],"summary":"Create new Resource","operationId":"create_134","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-connector-HttpWhitelist"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-connector-HttpWhitelist"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-connector-HttpWhitelist":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Typ der Whitelist-Prüfung (DOMAIN, URL, URL_PATTERN)","enum":["DOMAIN","URL","URL_PATTERN"]},"value":{"type":"string","description":"Wert der Whitelist-Prüfung (z.B. '.vario.cloud', 'https://api.example.com', 'https://*.example.com/*')"},"active":{"type":"boolean","description":"Ist der Eintrag aktiv?","readOnly":true}},"required":["type","value"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Variant Attribute Assignment Config ERP-Konfiguration für Varianten-Attributzuordnungen (Gebinde) ## GET /erp/variant-attribute-assignment-config/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"variant attribute assignment config","description":"ERP-Konfiguration für Varianten-Attributzuordnungen (Gebinde)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant-attribute-assignment-config/{id}":{"get":{"tags":["variant attribute assignment config"],"summary":"Find an existing Resource by identifier","operationId":"getById_10","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-VariantAttributeAssignmentConfig"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-VariantAttributeAssignmentConfig":{"description":"ERP-spezifische Konfiguration einer Varianten-Attributzuordnung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"attributeAssignmentRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bundleAttribute":{"type":"boolean","default":false,"description":"Ist dieses Attribut ein Gebinde-Attribut?"}},"required":["attributeAssignmentRef","bundleAttribute"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/variant-attribute-assignment-config/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"variant attribute assignment config","description":"ERP-Konfiguration für Varianten-Attributzuordnungen (Gebinde)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant-attribute-assignment-config/{id}":{"put":{"tags":["variant attribute assignment config"],"summary":"Update existing Resource ","operationId":"update_9","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-VariantAttributeAssignmentConfig"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-VariantAttributeAssignmentConfig"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-VariantAttributeAssignmentConfig":{"description":"ERP-spezifische Konfiguration einer Varianten-Attributzuordnung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"attributeAssignmentRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bundleAttribute":{"type":"boolean","default":false,"description":"Ist dieses Attribut ein Gebinde-Attribut?"}},"required":["attributeAssignmentRef","bundleAttribute"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/variant-attribute-assignment-config/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"variant attribute assignment config","description":"ERP-Konfiguration für Varianten-Attributzuordnungen (Gebinde)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant-attribute-assignment-config/{id}":{"delete":{"tags":["variant attribute assignment config"],"summary":"Delete an existing Resource","operationId":"delete_8","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/variant-attribute-assignment-config/ > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"variant attribute assignment config","description":"ERP-Konfiguration für Varianten-Attributzuordnungen (Gebinde)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant-attribute-assignment-config/":{"post":{"tags":["variant attribute assignment config"],"summary":"Create new Resource","operationId":"create_8","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-VariantAttributeAssignmentConfig"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-VariantAttributeAssignmentConfig"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-VariantAttributeAssignmentConfig":{"description":"ERP-spezifische Konfiguration einer Varianten-Attributzuordnung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"attributeAssignmentRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bundleAttribute":{"type":"boolean","default":false,"description":"Ist dieses Attribut ein Gebinde-Attribut?"}},"required":["attributeAssignmentRef","bundleAttribute"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Umlagerung Umlagerung ## POST /wms/stock-transfer/process-input > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Umlagerung","description":"Umlagerung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/wms/stock-transfer/process-input":{"post":{"tags":["Umlagerung"],"operationId":"processInput","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-StockTransferProcessingRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-StockTransferProcessingResponse"}}}}}}}},"components":{"schemas":{"erp-wms-StockTransferProcessingRequest":{"properties":{"inputData":{"type":"string","description":"Benutzereingabe/Scan"},"stockTransferType":{"type":"string","description":"Umlagerungsarten","enum":["FROM_TRANSIT","TO_TRANSIT"]},"pickTrolleyId":{"type":"integer","format":"int64","description":"Der aktuelle Wagen"},"quantity":{"type":"number","description":"Mengenänderung"},"processingAction":{"type":"string","description":"Spezielle Aktion bei der Verarbeitung von Picklisten","enum":["NONE","END"]},"articleId":{"type":"integer","format":"int64","description":"ID vom aktuellen Artikel"},"storageBinId":{"type":"integer","format":"int64","description":"ID vom Ziel Lagerplatz"},"articleSerialNumberId":{"type":"integer","format":"int64","description":"ID einer Seriennummer"}},"required":["stockTransferType"]},"erp-wms-StockTransferProcessingResponse":{"properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"stockTransferType":{"type":"string","description":"Umlagerungsarten","enum":["FROM_TRANSIT","TO_TRANSIT"]},"storageBinRef":{"$ref":"#/components/schemas/erp-stock-StorageBinRef"},"pickTrolleyRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"article":{"$ref":"#/components/schemas/erp-product-Article"},"stockInPickTrolley":{"$ref":"#/components/schemas/erp-stock-Stock"},"stockInStorageBin":{"$ref":"#/components/schemas/erp-stock-Stock"},"lastBookedSerialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"stockInPickTrolleyList":{"type":"array","description":"Liste aller Artikel im Wagen","items":{"$ref":"#/components/schemas/erp-wms-ArticleTrolleyStockInfo"}},"showStorageBin":{"type":"boolean","default":false,"description":"Sollen Lagerplätze angezeigt werden?"},"workbenchStorageBinRefs":{"type":"array","description":"Werkbank-Lagerplätze zu Produktionsaufträgen","items":{"$ref":"#/components/schemas/erp-wms-StockTransferProcessingResponse.WorkbenchStorageBinRef"}}}},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-stock-StorageBinRef":{"description":"Lagerplatz","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"displayName":{"type":"string","description":"Anzeigename"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"color":{"type":"string","description":"Anzeigefarbe"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-product-Article":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"baseArticle":{"type":"boolean","default":true,"description":"Ist das der Basis-Artikel des Produkts?","readOnly":true},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"],"readOnly":true},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"expiryDateType":{"type":"string","description":"Art des Haltbarkeitsdatums bei Serienartikeln","enum":["NONE","BEST_BEFORE_DATE","EXPIRATION_DATE"],"readOnly":true},"minimumRemainingDaysBeforeExpiryDateOnGoodsReceipt":{"type":"integer","format":"int32","description":"Mindestrestlaufzeit Eingang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel bei der Einbuchung in ein Verkaufslager noch aufweisen muss","readOnly":true},"minimumRemainingDaysBeforeExpiryDateForGoodsIssued":{"type":"integer","format":"int32","description":"Mindestrestlaufzeit Ausgang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel beim Verkauf noch aufweisen muss","readOnly":true},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten","readOnly":true},"lotOnlyRequiredWhenBookedToSalesStorage":{"type":"boolean","default":false,"description":"Charge muss bei Einbuchung in ein Verkaufslager vergeben werden (für Serientyp LOT und BEST_BEFORE)","readOnly":true},"serialNumberLabelingType":{"type":"string","description":"Seriennummer Auszeichnungsart","enum":["MANUAL","AUTOMATIC_ON_SUPPLIER_ORDER","AUTOMATIC_ON_SUPPLIER_DELIVERY"],"readOnly":true},"number":{"type":"string","description":"unique product number","maxLength":255,"minLength":0},"sellable":{"type":"boolean","default":true,"description":"is this product sellable"},"purchasable":{"type":"boolean","default":true,"description":"is this product purchasable"},"solvable":{"type":"boolean","default":false,"description":"is this product solvable to another package-variant"},"mergeable":{"type":"boolean","default":false,"description":"is this product mergeable to another package-variant"},"salesUnit":{"type":"number","description":"Verkaufseinheit"},"grossMetric":{"$ref":"#/components/schemas/erp-product-Article.Metric"},"netMetric":{"$ref":"#/components/schemas/erp-product-Article.Metric"},"grossVolumeInCubicMeters":{"type":"number","description":"gross Volume in cubic meters"},"productUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"capacity"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"base capacity"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"productRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"netSalesPrice":{"type":"number","description":"net sales prices"},"grossSalesPrice":{"type":"number","description":"gross sales prices"},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"basePriceUnit":{"type":"number","description":"Basispreiseinheit"},"discountGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliverable":{"type":"boolean","default":true,"description":"Ist der Artikel noch lieferbar?"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0,"readOnly":true},"countryOfOriginRef":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"tags":{"type":"array","description":"Tags zum Produkt","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"listingId":{"type":"string","description":"die id des Listings"},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Umkehrung der Steuerschuld nach §13b UStG?"},"sellableWithoutStock":{"type":"boolean","default":false,"description":"is this product sellable without any quantity at the stock"},"listed":{"type":"boolean","default":true,"description":"soll der Artikel gelistet werden"},"listingState":{"type":"string","description":"Synchronisationsstatus eines Listings","enum":["DISABLED","NEED_SYNCHRONIZE","QUEUED_FOR_SYNCHRONIZE","SYNCHRONIZED","ERRONEOUS","NEED_DELETION","QUEUED_FOR_DELETION"],"readOnly":true},"listingStateChangeTime":{"type":"string","format":"date-time","description":"die letzte Aktualisierung des listingStates","readOnly":true},"identifiers":{"type":"array","description":"all (external) product numbers (SKU, EAN, ...)","items":{"$ref":"#/components/schemas/erp-product-ArticleIdentifier"}},"name":{"type":"string","description":"name of this product"},"alternativeName":{"type":"string","description":"alternative name of this product"},"description":{"type":"string","description":"description of this product"},"listingDescriptionCustom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"availabilityDetermination":{"$ref":"#/components/schemas/erp-product-ArticleAvailabilityDetermination"},"listingCustom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"targetTradingMargin":{"type":"number","description":"Soll-Handelsspanne"},"languageCode":{"type":"string","description":"Einschränkung auf Land"},"dangerousGoodInformation":{"$ref":"#/components/schemas/erp-product-DangerousGoodInformation"},"dangerousGoods":{"type":"boolean","default":false,"description":"Artikel ist Gefahrgut"},"availableAlone":{"type":"boolean","default":true,"description":"alleine lieferbarer Artikel?"},"pickingType":{"type":"string","default":"ACCORDING_TO_TEMPLATE","description":"Definiert die Art, wie ein Artikel kommissioniert werden darf","enum":["ACCORDING_TO_TEMPLATE","PICKING_ALLOWED","PICKING_NOT_ALLOWED","ONLY_SINGLE_ORDER_PICKING_ALLOWED","ONLY_COLLECTIVE_ORDER_PICKING_ALLOWED"]},"workUnitInMinutes":{"type":"integer","format":"int32","description":"Arbeitseinheit in Minuten"},"initialLastPurchasePrice":{"type":"number","description":"Letzter EKP (Startwert)"},"initialAvgPurchasePrice":{"type":"number","description":"Durchschnittl. EKP (Startwert)"},"determineAvgPurchasePrice":{"type":"boolean","default":true,"description":"dEK berechnen?"},"commissionable":{"type":"boolean","default":true,"description":"provisionsberechtiger Artikel?"},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbarer Artikel?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbarer Artikel?"},"contingentArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printWarningIfNoContingentAvailable":{"type":"boolean","default":true,"description":"Nur für Kontingentartikel: soll bei der Abrechnung angedruckt werden, dass kein Kontingent vorhanden ist?"},"freelyPickable":{"type":"boolean","default":false,"description":"Frei kommissionierbar"},"shippingLabelPrinting":{"type":"boolean","default":false,"description":"Versandlabeldruck"},"permissibleForOrderProposal":{"type":"boolean","default":true,"description":"zulässig für Aufnahme in Bestellvorschläge"},"dropShippingPolicy":{"type":"string","default":"STORAGE","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"fabrication":{"type":"boolean","default":false,"description":"Produktion"},"onlyManualFabrication":{"type":"boolean","default":false,"description":"Nur manuelle Produktion"},"fabricationOfComponents":{"type":"string","description":"Produktion von Komponenten","enum":["NEVER","COMPLETELY_IF_NECESSARY","REQUIRED_QUANTITY_IF_NECESSARY","ALWAYS"]},"defaultFabricationCost":{"type":"number","description":"Vorgabe Herstellungskosten"},"printLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerArticleNumber":{"type":"string","description":"Artikelnummer"},"needsAssessmentOnlyOnReservationBasis":{"type":"boolean","default":false,"description":"Bedarfsermittlung nur über Reservierungen"},"onGoodsArrivalConvertIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"remark":{"type":"string","description":"Sonderbemerkung"},"note":{"type":"string","description":"Notiz"},"forcedRecommendedRetailPrice":{"type":"boolean","description":"Ist der UVP verpflichtend?"},"articleAssetInformation":{"$ref":"#/components/schemas/erp-product-ArticleAssetInformation"},"returnable":{"type":"boolean","default":true,"description":"retournierbar"}},"required":["deliverable","dropShippingPolicy","productGroupRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-product-Article.Metric":{"description":"weight and size w.o. packaging","properties":{"weight":{"type":"number","description":"weight"},"weightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sizeUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sizeX":{"type":"number","description":"size"},"sizeY":{"type":"number","description":"size"},"sizeZ":{"type":"number","description":"size"}}},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-product-ArticleIdentifier":{"description":"all (external) product numbers (SKU, EAN, ...)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"value":{"type":"string","description":"identifier","maxLength":255,"minLength":0},"name":{"type":"string","description":"identifier type","maxLength":255,"minLength":0},"defaultArticleIdentifier":{"type":"boolean","default":false,"description":"Standard Artikel Kennung?"}},"required":["defaultArticleIdentifier","name","value"]},"erp-product-ArticleAvailabilityDetermination":{"description":"Verfügbarkeitsermittlung für die Artikelstammdaten/Bestandsansicht","properties":{"inStock":{"type":"string","description":"wie wird der Bestand behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"reserved":{"type":"string","description":"wie werden Reserviert-Mengen behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"ordered":{"type":"string","description":"wie werden Bestellt-Mengen behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"inPicking":{"type":"string","description":"wie werden Mengen in Kommissionierung behandelt","enum":["IGNORE","ADD","SUBTRACT"]},"reporting":{"type":"string","description":"wie werden Meldebestände behandelt","enum":["IGNORE","ADD","SUBTRACT"]}}},"erp-product-DangerousGoodInformation":{"description":"Gefahrgut Informationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"description":{"type":"string","description":"description"},"shippingName":{"type":"string","description":"shipping name"},"technicalName":{"type":"string","description":"technical name"},"adrNumber":{"type":"string","description":"adr identification number"},"unNumber":{"type":"string","description":"united nations number (un number)"},"identificationClass":{"type":"string","description":"identification class"},"classificationCode":{"type":"string","description":"classification code"},"packingGroup":{"type":"string","description":"packing group (I, II, III or blank)"},"packingCode":{"type":"string","description":"packing code"},"transportCategory":{"type":"string","description":"transportation category"},"regulationCode":{"type":"string","description":"regulation code","enum":["FR","LQ","EQ","LR"]},"regulationSet":{"type":"string","description":"regulation Set, e.g. ADR","enum":["ADR","IATA"]},"hazardousWeight":{"type":"number","description":"weight of the hazardous part"},"subsidiaryRisk":{"type":"boolean","default":false,"description":"secundary risk of the dangerous good"},"tunnelRestrictionCode":{"type":"string","description":"tunnel restriction classes","enum":["A","B","C","D","E"]}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"erp-product-ArticleAssetInformation":{"description":"Information zur Verbindung zwischen Asset und Article","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"createAssetOnStorageEntry":{"type":"boolean","default":false,"description":"Assets automatisch beim Lagerzugang erstellen"},"createAssetOnSale":{"type":"boolean","default":false,"description":"Asset automatisch beim Verkauf erstellen"},"createAssetOnDocumentCategory":{"type":"string","description":"Asset erstellen bei Belegtyp","enum":["CUSTOMER_DELIVERY","CUSTOMER_INVOICE"]},"createWithAssetType":{"$ref":"#/components/schemas/erp-asset-AssetType"}}},"erp-asset-AssetType":{"description":"Asset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}}},"erp-stock-Stock":{"description":"Bestand","properties":{"articleId":{"type":"integer","format":"int64","description":"Artikel"},"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz"},"storageBinDisplayName":{"type":"string","description":"Anzeigename vom Lagerplatz","readOnly":true},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"amount":{"type":"number","description":"Bestand"}},"required":["amount","articleId","storageBinId"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-wms-ArticleTrolleyStockInfo":{"description":"Artikel Bestand","properties":{"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"articleNumber":{"type":"string","description":"Article-Number"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"amount":{"type":"number","description":"Bestand"},"lastBookedStorageBinRef":{"$ref":"#/components/schemas/erp-stock-StorageBinRef"},"presetStorageBinRefs":{"type":"array","description":"Für den Artikel vordefinierter Lagerplatzu","items":{"$ref":"#/components/schemas/erp-stock-StorageBinRef"}}},"required":["amount","unit"]},"erp-wms-StockTransferProcessingResponse.WorkbenchStorageBinRef":{"description":"Werkbank-Lagerplatz zu einem Produktionsauftrag","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"displayName":{"type":"string","description":"Anzeigename"},"routePosition":{"type":"integer","format":"int32","description":"Laufwegposition"},"color":{"type":"string","description":"Anzeigefarbe"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fabricationOrderRef":{"$ref":"#/components/schemas/erp-document-DocumentRef"}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]}}}} ``` # Matching Rules The rules for matching openitems with transactions ## GET /erp/finance/openitems/matchingrules/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MatchingRules","description":"The rules for matching openitems with transactions"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/matchingrules/{id}":{"get":{"tags":["MatchingRules"],"summary":"Find an existing Resource by identifier","operationId":"getById_38","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemMatchingRule"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemMatchingRule":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"ruleType":{"type":"string","description":"The type of rule, i.e. used while looking through invoice-related open items","enum":["INVOICE","ORDER","DEPOSIT_INVOICE","NAME","CUSTOMER_NUMBER","SUPPLIER_NUMBER","AMOUNT","EXTERNAL_NUMBER"]},"points":{"type":"integer","format":"int32","description":"The number of points to award for fit"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/finance/openitems/matchingrules/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MatchingRules","description":"The rules for matching openitems with transactions"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/matchingrules/{id}":{"put":{"tags":["MatchingRules"],"summary":"Update existing Resource ","operationId":"update_38","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemMatchingRule"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemMatchingRule"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemMatchingRule":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"ruleType":{"type":"string","description":"The type of rule, i.e. used while looking through invoice-related open items","enum":["INVOICE","ORDER","DEPOSIT_INVOICE","NAME","CUSTOMER_NUMBER","SUPPLIER_NUMBER","AMOUNT","EXTERNAL_NUMBER"]},"points":{"type":"integer","format":"int32","description":"The number of points to award for fit"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/finance/openitems/matchingrules/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MatchingRules","description":"The rules for matching openitems with transactions"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/matchingrules/{id}":{"delete":{"tags":["MatchingRules"],"summary":"Delete an existing Resource","operationId":"delete_35","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/finance/openitems/matchingrules > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MatchingRules","description":"The rules for matching openitems with transactions"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/matchingrules":{"post":{"tags":["MatchingRules"],"summary":"Create new Resource","operationId":"create_34","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemMatchingRule"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemMatchingRule"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemMatchingRule":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"bankRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"ruleType":{"type":"string","description":"The type of rule, i.e. used while looking through invoice-related open items","enum":["INVOICE","ORDER","DEPOSIT_INVOICE","NAME","CUSTOMER_NUMBER","SUPPLIER_NUMBER","AMOUNT","EXTERNAL_NUMBER"]},"points":{"type":"integer","format":"int32","description":"The number of points to award for fit"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/finance/openitems/matchingrules/max\_points > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"MatchingRules","description":"The rules for matching openitems with transactions"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/matchingrules/max_points":{"get":{"tags":["MatchingRules"],"operationId":"getMaxPoints","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` # Attributions Verwaltet Verknüpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP ## GET /dms/attributions/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Attributions","description":"Verwaltet Verknüpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/dms/attributions/{id}":{"get":{"tags":["Attributions"],"summary":"Find an existing Resource by identifier","operationId":"getById_94","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dms-shelf-ShelfDocumentAttribution"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"dms-shelf-ShelfDocumentAttribution":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"refType":{"type":"string","description":"type of the referenced object"},"refId":{"type":"integer","format":"int64","description":"id of the referenced object"},"uiSort":{"type":"integer","format":"int32","description":"UI-verwaltetes Feld"},"uiComment":{"type":"string","description":"UI-verwaltetes Feld"},"uiFavorite":{"type":"boolean","default":false,"description":"UI-verwaltetes Feld"},"mainAttribution":{"type":"boolean","description":"Hauptverknüpfung dieser DMS-Ressource","readOnly":true},"transformationKeys":{"type":"array","description":"Verfügbare Transformationen zum Bild","items":{"type":"string","description":"Verfügbare Transformationen zum Bild"},"readOnly":true},"shelfResourceId":{"type":"integer","format":"int64","description":"ID der verknüpften DMS-Ressource"},"publish":{"type":"boolean","description":"Soll das Dokument veröffentlicht werden?"},"purpose":{"type":"string","description":"Art der Beziehung / Verwendungszweck"}},"required":["purpose"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /dms/attributions/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Attributions","description":"Verwaltet Verknüpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/dms/attributions/{id}":{"put":{"tags":["Attributions"],"summary":"Update existing Resource ","operationId":"update_87","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dms-shelf-ShelfDocumentAttribution"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dms-shelf-ShelfDocumentAttribution"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"dms-shelf-ShelfDocumentAttribution":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"refType":{"type":"string","description":"type of the referenced object"},"refId":{"type":"integer","format":"int64","description":"id of the referenced object"},"uiSort":{"type":"integer","format":"int32","description":"UI-verwaltetes Feld"},"uiComment":{"type":"string","description":"UI-verwaltetes Feld"},"uiFavorite":{"type":"boolean","default":false,"description":"UI-verwaltetes Feld"},"mainAttribution":{"type":"boolean","description":"Hauptverknüpfung dieser DMS-Ressource","readOnly":true},"transformationKeys":{"type":"array","description":"Verfügbare Transformationen zum Bild","items":{"type":"string","description":"Verfügbare Transformationen zum Bild"},"readOnly":true},"shelfResourceId":{"type":"integer","format":"int64","description":"ID der verknüpften DMS-Ressource"},"publish":{"type":"boolean","description":"Soll das Dokument veröffentlicht werden?"},"purpose":{"type":"string","description":"Art der Beziehung / Verwendungszweck"}},"required":["purpose"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /dms/attributions/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Attributions","description":"Verwaltet Verknüpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/dms/attributions/{id}":{"delete":{"tags":["Attributions"],"summary":"Delete an existing Resource","operationId":"delete_83","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /dms/attributions/update-all > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Attributions","description":"Verwaltet Verknüpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/dms/attributions/update-all":{"put":{"tags":["Attributions"],"operationId":"updateAll","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dms-shelf-ShelfDocumentAttribution"}}}},"required":true},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"dms-shelf-ShelfDocumentAttribution":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"refType":{"type":"string","description":"type of the referenced object"},"refId":{"type":"integer","format":"int64","description":"id of the referenced object"},"uiSort":{"type":"integer","format":"int32","description":"UI-verwaltetes Feld"},"uiComment":{"type":"string","description":"UI-verwaltetes Feld"},"uiFavorite":{"type":"boolean","default":false,"description":"UI-verwaltetes Feld"},"mainAttribution":{"type":"boolean","description":"Hauptverknüpfung dieser DMS-Ressource","readOnly":true},"transformationKeys":{"type":"array","description":"Verfügbare Transformationen zum Bild","items":{"type":"string","description":"Verfügbare Transformationen zum Bild"},"readOnly":true},"shelfResourceId":{"type":"integer","format":"int64","description":"ID der verknüpften DMS-Ressource"},"publish":{"type":"boolean","description":"Soll das Dokument veröffentlicht werden?"},"purpose":{"type":"string","description":"Art der Beziehung / Verwendungszweck"}},"required":["purpose"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## GET /dms/attributions > Liefert alle Verknüpfungen, die zu einem ERP-Objekt gehören. ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Attributions","description":"Verwaltet Verknüpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/dms/attributions":{"get":{"tags":["Attributions"],"description":"Liefert alle Verknüpfungen, die zu einem ERP-Objekt gehören.","operationId":"findAttributions","parameters":[{"name":"refId","in":"query","description":"ID des ERP-Objekts","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"refType","in":"query","description":"Um was für ein ERP-Objekt handelt es sich?","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dms-shelf-ShelfDocumentAttribution"}}}}}}}}},"components":{"schemas":{"dms-shelf-ShelfDocumentAttribution":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"refType":{"type":"string","description":"type of the referenced object"},"refId":{"type":"integer","format":"int64","description":"id of the referenced object"},"uiSort":{"type":"integer","format":"int32","description":"UI-verwaltetes Feld"},"uiComment":{"type":"string","description":"UI-verwaltetes Feld"},"uiFavorite":{"type":"boolean","default":false,"description":"UI-verwaltetes Feld"},"mainAttribution":{"type":"boolean","description":"Hauptverknüpfung dieser DMS-Ressource","readOnly":true},"transformationKeys":{"type":"array","description":"Verfügbare Transformationen zum Bild","items":{"type":"string","description":"Verfügbare Transformationen zum Bild"},"readOnly":true},"shelfResourceId":{"type":"integer","format":"int64","description":"ID der verknüpften DMS-Ressource"},"publish":{"type":"boolean","description":"Soll das Dokument veröffentlicht werden?"},"purpose":{"type":"string","description":"Art der Beziehung / Verwendungszweck"}},"required":["purpose"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## POST /dms/attributions > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Attributions","description":"Verwaltet Verknüpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/dms/attributions":{"post":{"tags":["Attributions"],"summary":"Create new Resource","operationId":"create_83","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dms-shelf-ShelfDocumentAttribution"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dms-shelf-ShelfDocumentAttribution"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"dms-shelf-ShelfDocumentAttribution":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"refType":{"type":"string","description":"type of the referenced object"},"refId":{"type":"integer","format":"int64","description":"id of the referenced object"},"uiSort":{"type":"integer","format":"int32","description":"UI-verwaltetes Feld"},"uiComment":{"type":"string","description":"UI-verwaltetes Feld"},"uiFavorite":{"type":"boolean","default":false,"description":"UI-verwaltetes Feld"},"mainAttribution":{"type":"boolean","description":"Hauptverknüpfung dieser DMS-Ressource","readOnly":true},"transformationKeys":{"type":"array","description":"Verfügbare Transformationen zum Bild","items":{"type":"string","description":"Verfügbare Transformationen zum Bild"},"readOnly":true},"shelfResourceId":{"type":"integer","format":"int64","description":"ID der verknüpften DMS-Ressource"},"publish":{"type":"boolean","description":"Soll das Dokument veröffentlicht werden?"},"purpose":{"type":"string","description":"Art der Beziehung / Verwendungszweck"}},"required":["purpose"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Recommended Retail Price RecommendedRetailPrice API ## GET /erp/recommended-retail-price/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Recommended Retail Price","description":"RecommendedRetailPrice API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/recommended-retail-price/{id}":{"get":{"tags":["Recommended Retail Price"],"summary":"Find an existing Resource by identifier","operationId":"getById_21","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-RecommendedRetailPrice"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-RecommendedRetailPrice":{"description":"Unverbindliche Preisempfehlung für einen Artikel","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"currencyCode":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"countryCode":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"value":{"type":"number","description":"Preis"}},"required":["articleRef","currencyCode","value"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/recommended-retail-price/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Recommended Retail Price","description":"RecommendedRetailPrice API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/recommended-retail-price/{id}":{"put":{"tags":["Recommended Retail Price"],"summary":"Update existing Resource ","operationId":"update_20","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-RecommendedRetailPrice"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-RecommendedRetailPrice"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-RecommendedRetailPrice":{"description":"Unverbindliche Preisempfehlung für einen Artikel","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"currencyCode":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"countryCode":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"value":{"type":"number","description":"Preis"}},"required":["articleRef","currencyCode","value"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/recommended-retail-price/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Recommended Retail Price","description":"RecommendedRetailPrice API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/recommended-retail-price/{id}":{"delete":{"tags":["Recommended Retail Price"],"summary":"Delete an existing Resource","operationId":"delete_19","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/recommended-retail-price/ > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Recommended Retail Price","description":"RecommendedRetailPrice API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/recommended-retail-price/":{"post":{"tags":["Recommended Retail Price"],"summary":"Create new Resource","operationId":"create_19","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-RecommendedRetailPrice"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-RecommendedRetailPrice"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-RecommendedRetailPrice":{"description":"Unverbindliche Preisempfehlung für einen Artikel","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"currencyCode":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"countryCode":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"value":{"type":"number","description":"Preis"}},"required":["articleRef","currencyCode","value"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Banking Webform Bankautorisierungen ## DELETE /banking/banking-webform/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"BankingWebform","description":"Bankautorisierungen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/banking/banking-webform/{id}":{"delete":{"tags":["BankingWebform"],"summary":"Delete an existing Resource","operationId":"delete_137","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Cost Center Kostenstellen FiBu ## GET /erp/finance/costcenter/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Cost Center","description":"Kostenstellen FiBu"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/costcenter/{id}":{"get":{"tags":["Cost Center"],"summary":"Find an existing Resource by identifier","operationId":"getById_45","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-CostCenter"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-finance-CostCenter":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Kostenstelle"},"description":{"type":"string","description":"Bezeichnung für die Kostenstelle"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/finance/costcenter/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Cost Center","description":"Kostenstellen FiBu"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/costcenter/{id}":{"put":{"tags":["Cost Center"],"summary":"Update existing Resource ","operationId":"update_42","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-CostCenter"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-CostCenter"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-finance-CostCenter":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Kostenstelle"},"description":{"type":"string","description":"Bezeichnung für die Kostenstelle"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/finance/costcenter/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Cost Center","description":"Kostenstellen FiBu"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/costcenter/{id}":{"delete":{"tags":["Cost Center"],"summary":"Delete an existing Resource","operationId":"delete_40","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/finance/costcenter > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Cost Center","description":"Kostenstellen FiBu"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/costcenter":{"post":{"tags":["Cost Center"],"summary":"Create new Resource","operationId":"create_38","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-CostCenter"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-CostCenter"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-finance-CostCenter":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Kostenstelle"},"description":{"type":"string","description":"Bezeichnung für die Kostenstelle"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Return Groups the ReturnGroup API ## GET /erp/rma/return-groups/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnGroups","description":"the ReturnGroup API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-groups/{id}":{"get":{"tags":["ReturnGroups"],"summary":"Find an existing Resource by identifier","operationId":"getById_19","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnGroup"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnGroup":{"description":"Retourengruppe","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/rma/return-groups/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnGroups","description":"the ReturnGroup API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-groups/{id}":{"put":{"tags":["ReturnGroups"],"summary":"Update existing Resource ","operationId":"update_18","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnGroup"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnGroup"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnGroup":{"description":"Retourengruppe","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/rma/return-groups/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnGroups","description":"the ReturnGroup API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-groups/{id}":{"delete":{"tags":["ReturnGroups"],"summary":"Delete an existing Resource","operationId":"delete_17","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/rma/return-groups/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnGroups","description":"the ReturnGroup API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-groups/{id}/deactivate":{"put":{"tags":["ReturnGroups"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_7","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnGroup"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnGroup":{"description":"Retourengruppe","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/rma/return-groups/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnGroups","description":"the ReturnGroup API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-groups/{id}/activate":{"put":{"tags":["ReturnGroups"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_7","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnGroup"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnGroup":{"description":"Retourengruppe","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/rma/return-groups > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ReturnGroups","description":"the ReturnGroup API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/rma/return-groups":{"post":{"tags":["ReturnGroups"],"summary":"Create new Resource","operationId":"create_17","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnGroup"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-rma-ReturnGroup"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-rma-ReturnGroup":{"description":"Retourengruppe","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"applicableForCustomerReturns":{"type":"boolean","default":true,"description":"Anwendbar für Kundenretouren?"},"applicableForSupplierReturns":{"type":"boolean","default":true,"description":"Anwendbar für Lieferantenretouren?"},"barcode":{"type":"string","description":"Barcode","maxLength":255,"minLength":0},"publish":{"type":"boolean","description":"Veröffentlichen?"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"labels":{"type":"array","description":"Beschreibungen (mehrsprachig)","items":{"$ref":"#/components/schemas/core-api-LocalizedLabelWithDescription"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-api-LocalizedLabelWithDescription":{"description":"Localized label with description","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label/name of this description","maxLength":255,"minLength":0},"description":{"type":"string","description":"Description text","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"ISO 639-1 language code (e.g. 'de', 'en')"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Commodity Code Commodity Code (SOVA) ## GET /cmn/commodity-codes/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommodityCode","description":"Commodity Code (SOVA)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/commodity-codes/{id}":{"get":{"tags":["CommodityCode"],"summary":"Find an existing Resource by identifier","operationId":"getById_158","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CommodityCode"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CommodityCode":{"description":"Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCode":{"type":"string","description":"Warennummer","maxLength":8,"minLength":8,"pattern":"^[0-9]*$"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"specialUnitType":{"type":"string","description":"besondere Maßeinheit","maxLength":16,"minLength":0},"specialUnitTypeCode":{"type":"string","description":"besondere Maßeinheit (numerischer Code)","pattern":"\\d{2}"}},"required":["commodityCode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/commodity-codes/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommodityCode","description":"Commodity Code (SOVA)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/commodity-codes/{id}":{"put":{"tags":["CommodityCode"],"summary":"Update existing Resource ","operationId":"update_147","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CommodityCode"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CommodityCode"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CommodityCode":{"description":"Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCode":{"type":"string","description":"Warennummer","maxLength":8,"minLength":8,"pattern":"^[0-9]*$"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"specialUnitType":{"type":"string","description":"besondere Maßeinheit","maxLength":16,"minLength":0},"specialUnitTypeCode":{"type":"string","description":"besondere Maßeinheit (numerischer Code)","pattern":"\\d{2}"}},"required":["commodityCode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/commodity-codes/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommodityCode","description":"Commodity Code (SOVA)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/commodity-codes/{id}":{"delete":{"tags":["CommodityCode"],"summary":"Delete an existing Resource","operationId":"delete_133","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/commodity-codes/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommodityCode","description":"Commodity Code (SOVA)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/commodity-codes/{id}/deactivate":{"put":{"tags":["CommodityCode"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_69","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CommodityCode"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CommodityCode":{"description":"Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCode":{"type":"string","description":"Warennummer","maxLength":8,"minLength":8,"pattern":"^[0-9]*$"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"specialUnitType":{"type":"string","description":"besondere Maßeinheit","maxLength":16,"minLength":0},"specialUnitTypeCode":{"type":"string","description":"besondere Maßeinheit (numerischer Code)","pattern":"\\d{2}"}},"required":["commodityCode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/commodity-codes/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommodityCode","description":"Commodity Code (SOVA)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/commodity-codes/{id}/activate":{"put":{"tags":["CommodityCode"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_69","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CommodityCode"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CommodityCode":{"description":"Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCode":{"type":"string","description":"Warennummer","maxLength":8,"minLength":8,"pattern":"^[0-9]*$"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"specialUnitType":{"type":"string","description":"besondere Maßeinheit","maxLength":16,"minLength":0},"specialUnitTypeCode":{"type":"string","description":"besondere Maßeinheit (numerischer Code)","pattern":"\\d{2}"}},"required":["commodityCode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/commodity-codes > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommodityCode","description":"Commodity Code (SOVA)"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/commodity-codes":{"post":{"tags":["CommodityCode"],"summary":"Create new Resource","operationId":"create_135","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CommodityCode"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CommodityCode"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CommodityCode":{"description":"Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCode":{"type":"string","description":"Warennummer","maxLength":8,"minLength":8,"pattern":"^[0-9]*$"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"specialUnitType":{"type":"string","description":"besondere Maßeinheit","maxLength":16,"minLength":0},"specialUnitTypeCode":{"type":"string","description":"besondere Maßeinheit (numerischer Code)","pattern":"\\d{2}"}},"required":["commodityCode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Deals CRM Deals ## PUT /erp/crm-deals/{id}/subscription/deactivate > Entfernt eine Subscription auf dem Geschäftsobjekt für den Aufrufer ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/subscription/deactivate":{"put":{"tags":["Deals"],"summary":"Entfernt eine Subscription auf dem Geschäftsobjekt für den Aufrufer","operationId":"deregisterSubscription_2","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## PUT /erp/crm-deals/{id}/subscription/activate > Setzt eine Subscription auf dem Geschäftsobjekt für den Aufrufer ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/subscription/activate":{"put":{"tags":["Deals"],"summary":"Setzt eine Subscription auf dem Geschäftsobjekt für den Aufrufer","operationId":"registerSubscription_2","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## GET /erp/crm-deals/{id}/reminders/{reminderId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/reminders/{reminderId}":{"get":{"tags":["Deals"],"operationId":"getReminder_2","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"reminderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmReminder"}}}}}}}},"components":{"schemas":{"erp-crm-CrmReminder":{"description":"CRM Erinnerungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"crmId":{"type":"integer","format":"int64","description":"ID des CRM Objekts"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"remindAt":{"type":"string","format":"date-time","description":"Erinnerungszeitpunkt"},"note":{"type":"string","description":"Notiz zur Erinnerung"},"critical":{"type":"boolean","description":"Kritische Erinnerung?"}},"required":["crmId","remindAt","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## PUT /erp/crm-deals/{id}/reminders/{reminderId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/reminders/{reminderId}":{"put":{"tags":["Deals"],"operationId":"updateReminder_2","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"reminderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmReminder"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmReminder"}}}}}}}},"components":{"schemas":{"erp-crm-CrmReminder":{"description":"CRM Erinnerungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"crmId":{"type":"integer","format":"int64","description":"ID des CRM Objekts"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"remindAt":{"type":"string","format":"date-time","description":"Erinnerungszeitpunkt"},"note":{"type":"string","description":"Notiz zur Erinnerung"},"critical":{"type":"boolean","description":"Kritische Erinnerung?"}},"required":["crmId","remindAt","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## DELETE /erp/crm-deals/{id}/reminders/{reminderId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/reminders/{reminderId}":{"delete":{"tags":["Deals"],"operationId":"deleteReminder_2","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"reminderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## GET /erp/crm-deals/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}":{"get":{"tags":["Deals"],"summary":"Find an existing Resource by identifier","operationId":"getById_111","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDeal"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmDeal":{"description":"CRM Deals","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priorityRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"Aufgaben-Nummer","readOnly":true},"description":{"type":"string","description":"Notiz/Beschreibung"},"notes":{"type":"string","description":"Notizen"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentRefs":{"type":"array","description":"Übergeordnete CRM-Objekte","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"childRefs":{"type":"array","description":"Untergeordnete CRM-Objekt","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"tags":{"type":"array","description":"Tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"salesDocumentRefs":{"type":"array","description":"Verkaufsbelege","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"contractRefs":{"type":"array","description":"Vertrag","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"observerRefs":{"type":"array","description":"Beobachter","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"processedByWorkflow":{"type":"boolean","description":"In Workflow-Verarbeitung?","readOnly":true},"assignedUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedByUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Aufgabentitel"},"customField":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"responsibleCustomerPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"topicRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"plannedClosingDate":{"type":"string","format":"date","description":"Geplantes Abschluss-Datum"},"plannedPerformanceDate":{"type":"string","format":"date","description":"Geplantes Leistungs-Datum"},"plannedInvestmentSum":{"type":"number","description":"Geplante Investitionssumme"},"chance":{"type":"integer","format":"int32","description":"Chance (in Prozent)","maximum":100,"minimum":0},"healthRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"nextPlannedContactDate":{"type":"string","format":"date-time","description":"Nächster geplanter Kontakt"},"closingType":{"type":"string","description":"Art des Abschluß eines Deals","enum":["POSITIVE","NEGATIVE"]},"closingReasonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"detailedClosingReason":{"type":"string","description":"Freier/Detaillierter Abschlußgrund"},"additionalParticipantsOfCustomer":{"type":"array","description":"Weitere Teilnehmer vom Auftraggeber","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}},"additionalParticipantsOfContractor":{"type":"array","description":"Weitere Teilnehmer vom Auftragnehmer","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}}},"required":["priorityRef","topicRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-crm-CrmParticipant":{"description":"Teilnehmer/Ansprechpartner in einem CRM-Objekt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0}},"required":["accountPersonRef"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/crm-deals/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}":{"put":{"tags":["Deals"],"summary":"Update existing Resource ","operationId":"update_103","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDealCreateOrUpdateRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDeal"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmDealCreateOrUpdateRequest":{"description":"Request zur Erstellung oder Aktualisierung eines Deals","properties":{"toCreateOrUpdate":{"$ref":"#/components/schemas/erp-crm-CrmDeal"},"parameters":{"type":"array","description":"Zusätzliche Parameter (z.B. auch Antworten auf Entscheidungen","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}}},"erp-crm-CrmDeal":{"description":"CRM Deals","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priorityRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"Aufgaben-Nummer","readOnly":true},"description":{"type":"string","description":"Notiz/Beschreibung"},"notes":{"type":"string","description":"Notizen"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentRefs":{"type":"array","description":"Übergeordnete CRM-Objekte","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"childRefs":{"type":"array","description":"Untergeordnete CRM-Objekt","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"tags":{"type":"array","description":"Tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"salesDocumentRefs":{"type":"array","description":"Verkaufsbelege","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"contractRefs":{"type":"array","description":"Vertrag","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"observerRefs":{"type":"array","description":"Beobachter","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"processedByWorkflow":{"type":"boolean","description":"In Workflow-Verarbeitung?","readOnly":true},"assignedUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedByUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Aufgabentitel"},"customField":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"responsibleCustomerPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"topicRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"plannedClosingDate":{"type":"string","format":"date","description":"Geplantes Abschluss-Datum"},"plannedPerformanceDate":{"type":"string","format":"date","description":"Geplantes Leistungs-Datum"},"plannedInvestmentSum":{"type":"number","description":"Geplante Investitionssumme"},"chance":{"type":"integer","format":"int32","description":"Chance (in Prozent)","maximum":100,"minimum":0},"healthRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"nextPlannedContactDate":{"type":"string","format":"date-time","description":"Nächster geplanter Kontakt"},"closingType":{"type":"string","description":"Art des Abschluß eines Deals","enum":["POSITIVE","NEGATIVE"]},"closingReasonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"detailedClosingReason":{"type":"string","description":"Freier/Detaillierter Abschlußgrund"},"additionalParticipantsOfCustomer":{"type":"array","description":"Weitere Teilnehmer vom Auftraggeber","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}},"additionalParticipantsOfContractor":{"type":"array","description":"Weitere Teilnehmer vom Auftragnehmer","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}}},"required":["priorityRef","topicRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-crm-CrmParticipant":{"description":"Teilnehmer/Ansprechpartner in einem CRM-Objekt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0}},"required":["accountPersonRef"]},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /erp/crm-deals/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}":{"delete":{"tags":["Deals"],"summary":"Delete an existing Resource","operationId":"delete_96","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PATCH /erp/crm-deals/{id} > Patch existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}":{"patch":{"tags":["Deals"],"summary":"Patch existing Resource ","operationId":"partialUpdate_2","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDeal"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-crm-CrmDeal":{"description":"CRM Deals","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priorityRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"Aufgaben-Nummer","readOnly":true},"description":{"type":"string","description":"Notiz/Beschreibung"},"notes":{"type":"string","description":"Notizen"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentRefs":{"type":"array","description":"Übergeordnete CRM-Objekte","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"childRefs":{"type":"array","description":"Untergeordnete CRM-Objekt","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"tags":{"type":"array","description":"Tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"salesDocumentRefs":{"type":"array","description":"Verkaufsbelege","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"contractRefs":{"type":"array","description":"Vertrag","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"observerRefs":{"type":"array","description":"Beobachter","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"processedByWorkflow":{"type":"boolean","description":"In Workflow-Verarbeitung?","readOnly":true},"assignedUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedByUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Aufgabentitel"},"customField":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"responsibleCustomerPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"topicRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"plannedClosingDate":{"type":"string","format":"date","description":"Geplantes Abschluss-Datum"},"plannedPerformanceDate":{"type":"string","format":"date","description":"Geplantes Leistungs-Datum"},"plannedInvestmentSum":{"type":"number","description":"Geplante Investitionssumme"},"chance":{"type":"integer","format":"int32","description":"Chance (in Prozent)","maximum":100,"minimum":0},"healthRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"nextPlannedContactDate":{"type":"string","format":"date-time","description":"Nächster geplanter Kontakt"},"closingType":{"type":"string","description":"Art des Abschluß eines Deals","enum":["POSITIVE","NEGATIVE"]},"closingReasonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"detailedClosingReason":{"type":"string","description":"Freier/Detaillierter Abschlußgrund"},"additionalParticipantsOfCustomer":{"type":"array","description":"Weitere Teilnehmer vom Auftraggeber","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}},"additionalParticipantsOfContractor":{"type":"array","description":"Weitere Teilnehmer vom Auftragnehmer","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}}},"required":["priorityRef","topicRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"erp-crm-CrmParticipant":{"description":"Teilnehmer/Ansprechpartner in einem CRM-Objekt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0}},"required":["accountPersonRef"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## GET /erp/crm-deals/parent/{childId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/parent/{childId}":{"get":{"tags":["Deals"],"operationId":"getParents_2","parameters":[{"name":"childId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}}}}}}}}},"components":{"schemas":{"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}}}}} ``` ## PUT /erp/crm-deals/parent/{childId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/parent/{childId}":{"put":{"tags":["Deals"],"operationId":"updateParent_2","parameters":[{"name":"childId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmUpdateParentRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"erp-crm-CrmUpdateParentRequest":{"description":"Request zur Aktualisierung der CRM-Parents","properties":{"parents":{"type":"array","description":"Die übergeordneten Objekte","items":{"$ref":"#/components/schemas/erp-crm-CrmUpdateParentRequest.Parent"}}},"required":["parents"]},"erp-crm-CrmUpdateParentRequest.Parent":{"description":"Ein übergeordnetes Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]}},"required":["id","type"]},"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## DELETE /erp/crm-deals/parent/{childId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/parent/{childId}":{"delete":{"tags":["Deals"],"operationId":"removeParent_2","parameters":[{"name":"childId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## GET /erp/crm-deals/children/{parentId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/children/{parentId}":{"get":{"tags":["Deals"],"operationId":"getChildren_2","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}}}}}}}}},"components":{"schemas":{"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}}}}} ``` ## PUT /erp/crm-deals/children/{parentId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/children/{parentId}":{"put":{"tags":["Deals"],"operationId":"updateChildren_2","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmUpdateChildrenRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}}}}}}}}},"components":{"schemas":{"erp-crm-CrmUpdateChildrenRequest":{"description":"Request zur Aktualisierung der CRM-Children","properties":{"children":{"type":"array","description":"Die abhängigen Objekte","items":{"$ref":"#/components/schemas/erp-crm-CrmUpdateChildrenRequest.Child"}}},"required":["children"]},"erp-crm-CrmUpdateChildrenRequest.Child":{"description":"Ein abhängiges Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]}},"required":["id","type"]},"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}}}}} ``` ## DELETE /erp/crm-deals/children/{parentId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/children/{parentId}":{"delete":{"tags":["Deals"],"operationId":"removeChildren_2","parameters":[{"name":"parentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## POST /erp/crm-deals/{id}/won > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/won":{"post":{"tags":["Deals"],"operationId":"dealWon","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDealCloseRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDeal"}}}}}}}},"components":{"schemas":{"erp-crm-CrmDealCloseRequest":{"description":"Request zum Schließen eines Deals","properties":{"dealId":{"type":"integer","format":"int64","description":"ID des zu schliessenden Deals"},"closingReasonId":{"type":"integer","format":"int64","description":"ID des zu verwendenden Abschlussgrunds"},"detailedClosingReason":{"type":"string","description":"Detaillierter Abschlussgrund"}}},"erp-crm-CrmDeal":{"description":"CRM Deals","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priorityRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"Aufgaben-Nummer","readOnly":true},"description":{"type":"string","description":"Notiz/Beschreibung"},"notes":{"type":"string","description":"Notizen"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentRefs":{"type":"array","description":"Übergeordnete CRM-Objekte","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"childRefs":{"type":"array","description":"Untergeordnete CRM-Objekt","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"tags":{"type":"array","description":"Tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"salesDocumentRefs":{"type":"array","description":"Verkaufsbelege","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"contractRefs":{"type":"array","description":"Vertrag","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"observerRefs":{"type":"array","description":"Beobachter","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"processedByWorkflow":{"type":"boolean","description":"In Workflow-Verarbeitung?","readOnly":true},"assignedUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedByUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Aufgabentitel"},"customField":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"responsibleCustomerPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"topicRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"plannedClosingDate":{"type":"string","format":"date","description":"Geplantes Abschluss-Datum"},"plannedPerformanceDate":{"type":"string","format":"date","description":"Geplantes Leistungs-Datum"},"plannedInvestmentSum":{"type":"number","description":"Geplante Investitionssumme"},"chance":{"type":"integer","format":"int32","description":"Chance (in Prozent)","maximum":100,"minimum":0},"healthRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"nextPlannedContactDate":{"type":"string","format":"date-time","description":"Nächster geplanter Kontakt"},"closingType":{"type":"string","description":"Art des Abschluß eines Deals","enum":["POSITIVE","NEGATIVE"]},"closingReasonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"detailedClosingReason":{"type":"string","description":"Freier/Detaillierter Abschlußgrund"},"additionalParticipantsOfCustomer":{"type":"array","description":"Weitere Teilnehmer vom Auftraggeber","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}},"additionalParticipantsOfContractor":{"type":"array","description":"Weitere Teilnehmer vom Auftragnehmer","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}}},"required":["priorityRef","topicRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-crm-CrmParticipant":{"description":"Teilnehmer/Ansprechpartner in einem CRM-Objekt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0}},"required":["accountPersonRef"]}}}} ``` ## POST /erp/crm-deals/{id}/reminders/ > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/reminders/":{"post":{"tags":["Deals"],"operationId":"createReminder_2","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmReminder"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmReminder"}}}}}}}},"components":{"schemas":{"erp-crm-CrmReminder":{"description":"CRM Erinnerungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"crmId":{"type":"integer","format":"int64","description":"ID des CRM Objekts"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"remindAt":{"type":"string","format":"date-time","description":"Erinnerungszeitpunkt"},"note":{"type":"string","description":"Notiz zur Erinnerung"},"critical":{"type":"boolean","description":"Kritische Erinnerung?"}},"required":["crmId","remindAt","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## POST /erp/crm-deals/{id}/reactivate > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/reactivate":{"post":{"tags":["Deals"],"operationId":"reactivate_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDeal"}}}}}}}},"components":{"schemas":{"erp-crm-CrmDeal":{"description":"CRM Deals","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priorityRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"Aufgaben-Nummer","readOnly":true},"description":{"type":"string","description":"Notiz/Beschreibung"},"notes":{"type":"string","description":"Notizen"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentRefs":{"type":"array","description":"Übergeordnete CRM-Objekte","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"childRefs":{"type":"array","description":"Untergeordnete CRM-Objekt","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"tags":{"type":"array","description":"Tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"salesDocumentRefs":{"type":"array","description":"Verkaufsbelege","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"contractRefs":{"type":"array","description":"Vertrag","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"observerRefs":{"type":"array","description":"Beobachter","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"processedByWorkflow":{"type":"boolean","description":"In Workflow-Verarbeitung?","readOnly":true},"assignedUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedByUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Aufgabentitel"},"customField":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"responsibleCustomerPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"topicRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"plannedClosingDate":{"type":"string","format":"date","description":"Geplantes Abschluss-Datum"},"plannedPerformanceDate":{"type":"string","format":"date","description":"Geplantes Leistungs-Datum"},"plannedInvestmentSum":{"type":"number","description":"Geplante Investitionssumme"},"chance":{"type":"integer","format":"int32","description":"Chance (in Prozent)","maximum":100,"minimum":0},"healthRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"nextPlannedContactDate":{"type":"string","format":"date-time","description":"Nächster geplanter Kontakt"},"closingType":{"type":"string","description":"Art des Abschluß eines Deals","enum":["POSITIVE","NEGATIVE"]},"closingReasonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"detailedClosingReason":{"type":"string","description":"Freier/Detaillierter Abschlußgrund"},"additionalParticipantsOfCustomer":{"type":"array","description":"Weitere Teilnehmer vom Auftraggeber","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}},"additionalParticipantsOfContractor":{"type":"array","description":"Weitere Teilnehmer vom Auftragnehmer","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}}},"required":["priorityRef","topicRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-crm-CrmParticipant":{"description":"Teilnehmer/Ansprechpartner in einem CRM-Objekt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0}},"required":["accountPersonRef"]}}}} ``` ## POST /erp/crm-deals/{id}/lost > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/lost":{"post":{"tags":["Deals"],"operationId":"dealLost","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDealCloseRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDeal"}}}}}}}},"components":{"schemas":{"erp-crm-CrmDealCloseRequest":{"description":"Request zum Schließen eines Deals","properties":{"dealId":{"type":"integer","format":"int64","description":"ID des zu schliessenden Deals"},"closingReasonId":{"type":"integer","format":"int64","description":"ID des zu verwendenden Abschlussgrunds"},"detailedClosingReason":{"type":"string","description":"Detaillierter Abschlussgrund"}}},"erp-crm-CrmDeal":{"description":"CRM Deals","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priorityRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"Aufgaben-Nummer","readOnly":true},"description":{"type":"string","description":"Notiz/Beschreibung"},"notes":{"type":"string","description":"Notizen"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentRefs":{"type":"array","description":"Übergeordnete CRM-Objekte","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"childRefs":{"type":"array","description":"Untergeordnete CRM-Objekt","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"tags":{"type":"array","description":"Tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"salesDocumentRefs":{"type":"array","description":"Verkaufsbelege","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"contractRefs":{"type":"array","description":"Vertrag","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"observerRefs":{"type":"array","description":"Beobachter","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"processedByWorkflow":{"type":"boolean","description":"In Workflow-Verarbeitung?","readOnly":true},"assignedUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedByUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Aufgabentitel"},"customField":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"responsibleCustomerPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"topicRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"plannedClosingDate":{"type":"string","format":"date","description":"Geplantes Abschluss-Datum"},"plannedPerformanceDate":{"type":"string","format":"date","description":"Geplantes Leistungs-Datum"},"plannedInvestmentSum":{"type":"number","description":"Geplante Investitionssumme"},"chance":{"type":"integer","format":"int32","description":"Chance (in Prozent)","maximum":100,"minimum":0},"healthRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"nextPlannedContactDate":{"type":"string","format":"date-time","description":"Nächster geplanter Kontakt"},"closingType":{"type":"string","description":"Art des Abschluß eines Deals","enum":["POSITIVE","NEGATIVE"]},"closingReasonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"detailedClosingReason":{"type":"string","description":"Freier/Detaillierter Abschlußgrund"},"additionalParticipantsOfCustomer":{"type":"array","description":"Weitere Teilnehmer vom Auftraggeber","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}},"additionalParticipantsOfContractor":{"type":"array","description":"Weitere Teilnehmer vom Auftragnehmer","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}}},"required":["priorityRef","topicRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-crm-CrmParticipant":{"description":"Teilnehmer/Ansprechpartner in einem CRM-Objekt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0}},"required":["accountPersonRef"]}}}} ``` ## POST /erp/crm-deals > Neues Projekt erzeugen ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals":{"post":{"tags":["Deals"],"summary":"Neues Projekt erzeugen","operationId":"createByTemplate_2","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CreateCrmDealRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmDeal"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CreateCrmDealRequest":{"properties":{"createTemplateId":{"type":"integer","format":"int64","description":"Vorlage zum Erstellen eines Deals"},"deal":{"$ref":"#/components/schemas/erp-crm-CrmDeal"},"parameters":{"type":"array","description":"Zusätzliche Parameter (z.B. auch Antworten auf Entscheidungen","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}}}},"erp-crm-CrmDeal":{"description":"CRM Deals","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"stateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priorityRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"Aufgaben-Nummer","readOnly":true},"description":{"type":"string","description":"Notiz/Beschreibung"},"notes":{"type":"string","description":"Notizen"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentRefs":{"type":"array","description":"Übergeordnete CRM-Objekte","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"childRefs":{"type":"array","description":"Untergeordnete CRM-Objekt","items":{"$ref":"#/components/schemas/erp-crm-CrmObjectRef"}},"tags":{"type":"array","description":"Tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"salesDocumentRefs":{"type":"array","description":"Verkaufsbelege","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"contractRefs":{"type":"array","description":"Vertrag","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"}},"observerRefs":{"type":"array","description":"Beobachter","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"processedByWorkflow":{"type":"boolean","description":"In Workflow-Verarbeitung?","readOnly":true},"assignedUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"assignedByUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"mainResponsibleGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"label":{"type":"string","description":"Aufgabentitel"},"customField":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"responsibleCustomerPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"topicRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"plannedClosingDate":{"type":"string","format":"date","description":"Geplantes Abschluss-Datum"},"plannedPerformanceDate":{"type":"string","format":"date","description":"Geplantes Leistungs-Datum"},"plannedInvestmentSum":{"type":"number","description":"Geplante Investitionssumme"},"chance":{"type":"integer","format":"int32","description":"Chance (in Prozent)","maximum":100,"minimum":0},"healthRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"nextPlannedContactDate":{"type":"string","format":"date-time","description":"Nächster geplanter Kontakt"},"closingType":{"type":"string","description":"Art des Abschluß eines Deals","enum":["POSITIVE","NEGATIVE"]},"closingReasonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"detailedClosingReason":{"type":"string","description":"Freier/Detaillierter Abschlußgrund"},"additionalParticipantsOfCustomer":{"type":"array","description":"Weitere Teilnehmer vom Auftraggeber","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}},"additionalParticipantsOfContractor":{"type":"array","description":"Weitere Teilnehmer vom Auftragnehmer","items":{"$ref":"#/components/schemas/erp-crm-CrmParticipant"}}},"required":["priorityRef","topicRef","typeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-crm-CrmObjectRef":{"description":"Referenz auf ein CRM-Objekt","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"type":{"type":"string","description":"Möglich CRM-Typen","enum":["TASK","DEAL","PROJECT"]},"number":{"type":"string","description":"Nummer"},"label":{"type":"string","description":"Bezeichung"},"description":{"type":"string","description":"Beschreibung"},"state":{"$ref":"#/components/schemas/erp-crm-CrmState"},"subType":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"required":["id","type"]},"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-crm-CrmParticipant":{"description":"Teilnehmer/Ansprechpartner in einem CRM-Objekt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0}},"required":["accountPersonRef"]},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## GET /erp/crm-deals/{refId}/workflow-state > Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{refId}/workflow-state":{"get":{"tags":["Deals"],"summary":"Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz","operationId":"getWorkflowState_6","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"application/json":{"schema":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}},"404":{"description":"Es existiert noch keine Workflow-Instanz","content":{"application/json":{"schema":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}}}}}}} ``` ## GET /erp/crm-deals/{refId}/workflow-instances-preset > Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{refId}/workflow-instances-preset":{"get":{"tags":["Deals"],"summary":"Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz","operationId":"getWorkflowInstancesPreset_6","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-cunit-QueryPreset"}}}}}}}},"components":{"schemas":{"common-cunit-QueryPreset":{"description":"Adhoc Preset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"templateId":{"type":"string","description":"template dem dieser filter zugeordnet worden ist."},"templateGroupKey":{"type":"string","description":"templateGroupKey dem dieser filter zugeordnet worden ist."},"label":{"type":"string","description":"label für diesen filter"},"uiPayload":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variables":{"type":"array","description":"Variablen für dieses Preset","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"}},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"results":{"type":"array","description":"ergebnisse","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"sortAndOrders":{"type":"array","description":"sortierung","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetPageable"},"option":{"$ref":"#/components/schemas/common-cunit-QueryPresetOption"},"transformations":{"type":"array","description":"zusätzliche konfigurationen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetTransformation"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"definition":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]},"readOnly":true},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"},"forWorkflow":{"type":"boolean","default":false,"description":"für Workflows vorgesehen"},"outputReportGroupIdentifier":{"type":"string","description":"Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird"},"userOptions":{"$ref":"#/components/schemas/common-cunit-QueryPresetUserOptions"}},"required":["forWorkflow","label","mode","permissionAggregation","templateGroupKey","templateId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"common-cunit-QueryPresetVariable":{"description":"Die zu ersetzende Variable","properties":{"path":{"type":"string","description":"Der pfad, der dieses Attribut eindeutig beschreibt"},"definition":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}],"readOnly":true},"mandatory":{"type":"boolean","description":"Ob die Variable ein Pflichtfeld ist oder nicht"},"variableName":{"type":"string","description":"Name der Variablen"},"visible":{"type":"boolean","default":true,"description":"Handelt es sich um eine sichtbare Variable?"},"alignX":{"type":"integer","format":"int32","description":"Anordnung im UI - X-Koordinate"},"alignY":{"type":"integer","format":"int32","description":"Anordnung im UI - Y-Koordinate"},"alignWidth":{"type":"integer","format":"int32","description":"Anordnung im UI - Breite"},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Eindeutiger Schlüssel zur Identifikation des Attributs"},"attribute":{"type":"string","description":"name des attributes der das ergebnis enthält"},"path":{"type":"string","description":"der pfad, der dieses attribut eindeutig beschreibt"},"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"parentDisplayName":{"type":"string","description":"der Name des Referenzierenden Feldes"},"resultable":{"type":"boolean","default":true,"description":"kann dieses Feld ein Ergebnisfeld sein"},"filterable":{"type":"boolean","default":true,"description":"kann nach diesem feld gefiltert werden"},"sortable":{"type":"boolean","default":true,"description":"ist dieses Feld sortierbar"},"visible":{"type":"boolean","default":true,"description":"soll dieses Feld angezeigt werden"},"functions":{"type":"array","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)","items":{"type":"string","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)"}},"sortDirection":{"type":"string","description":"Info, wie diese spalte sortiert worden ist"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"modelType":{"type":"string","description":"Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')","readOnly":true},"headers":{"type":"array","description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-MetaContent":{"description":"Definition dieser Variable","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]}}}},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"}}}]},"core-cunit-CuAttributeConstraint":{"description":"constraints für dieses Attribut","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"minimaler Wert","readOnly":true},"includeMinValue":{"type":"boolean","description":"ist der minimale Wert inklusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"maximaler Wert","readOnly":true},"includeMaxValue":{"type":"boolean","description":"ist der maximale Wert inklusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"ist der Wert 'null' verboten?","readOnly":true},"notBlank":{"type":"boolean","description":"Bei Strings: ist ein String nur aus Whitespace verboten?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximale Anzahl Nachkommastellen","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"data-type für dieses Attribut (falls dataTypeIdentifier leer ist)","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"welcher Typ ist es","readOnly":true},"objectRefIdentifier":{"type":"string","description":"bei Object_Ref: welcher Typ ist es genau","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"welche Funktionen sind erlaubt?","items":{"type":"string","description":"welche Funktionen sind erlaubt?"},"readOnly":true},"predicateOperations":{"type":"array","description":"welche Operations sind erlaubt?","items":{"type":"string","description":"welche Operations sind erlaubt?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit Attribut Filter Optionen","properties":{"filterValues":{"type":"array","description":"Mögliche Filterwerte","items":{"type":"string","description":"Mögliche Filterwerte"}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute.HeaderGroup":{"description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","properties":{"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Bedingungen zur Selektion von Lagerplätzen","properties":{"type":{"type":"string","description":"die Operation für diesen Filter","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"(bei junction) child-definitionen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"filter werte","items":{"type":"string","description":"filter werte"}},"visible":{"type":"boolean","default":true,"description":"Sichtbarkeit bei Variablen"},"functions":{"type":"array","description":"Eine SQL-Funktion, die im Predicate angewendet wird","items":{"type":"string","description":"Eine SQL-Funktion, die im Predicate angewendet wird"}}},"required":["operator","type"]},"common-cunit-QueryPresetResult":{"description":"Ergebnisse","properties":{"property":{"type":"string","description":"property"},"displayName":{"type":"string","description":"title dieser spalte"},"functions":{"type":"array","description":"funktionen","items":{"type":"string","description":"funktionen"}},"visible":{"type":"boolean","default":true,"description":"sichtbare Ergebnisspalte"}},"required":["property"]},"common-cunit-QueryPresetSortOrder":{"description":"sort and order anweisungen","properties":{"property":{"type":"string","description":"property"},"functions":{"type":"array","description":"Functions","items":{"type":"string","description":"Functions"}},"direction":{"type":"string","description":"sort order","enum":["ASC","DESC"]}},"required":["direction","property"]},"common-cunit-QueryPresetPageable":{"description":"pageable","properties":{"limit":{"type":"integer","format":"int64","description":"das Limit (MaxRecordCount) für diesen Query"}}},"common-cunit-QueryPresetOption":{"description":"options","properties":{"distinctResult":{"type":"boolean","description":"soll der Query mit einem Distinct durchgeführt werden"}}},"common-cunit-QueryPresetTransformation":{"description":"zusätzliche konfigurationen","properties":{"crossTable":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation"}}},"common-cunit-QueryPresetCrossTableTransformation":{"description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","properties":{"rowSpecs":{"type":"array","description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"columnSpecs":{"type":"array","description":"enthält die felder, die in der cross-table als dynamische spalten erstellt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"results":{"type":"array","description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell"}}},"required":["columnSpecs","results","rowSpecs"]},"common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell":{"description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","properties":{"result":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"cellView":{"type":"string","description":"darstellung der werte","enum":["AS_IS","PERCENT_COL"]},"sumColumn":{"type":"boolean","default":false,"description":"soll eine spaltensumme erzeugt werden"},"rowMode":{"type":"string","description":"soll eine zeilensumme erzeugt werden","enum":["DATA","DATA_AND_TOTAL","TOTAL"]},"aggregateFunction":{"type":"string","description":"die funktion mit der die werte der Zelle aggregiert werden"}}},"common-cunit-ArithmeticQueryTerm":{"description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","properties":{"termName":{"type":"string","description":"Der Name des Terms für die Verarbeitung und Darstellung"},"terms":{"type":"array","description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermInner"}},"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-cunit-ArithmeticQueryTermInner":{"description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","properties":{"fragment":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermFragment"},"attribute":{"type":"string","description":"Ein echtes Attribut aus dem Template"},"fixedValue":{"type":"number","description":"Ein Fixwert"}}},"common-cunit-ArithmeticQueryTermFragment":{"description":"Das Termfragment - eine weitere Verschachtelung mit eigenen Operationen","properties":{"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-cunit-QueryPresetUserOptions":{"description":"nutzerbezogene Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"pinned":{"type":"boolean","default":false,"description":"angepinnt?"}},"required":["pinned"]}}}} ``` ## GET /erp/crm-deals/{refId}/latest-workflow-instance > Liefert die neuste Workflow-Instanz zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{refId}/latest-workflow-instance":{"get":{"tags":["Deals"],"summary":"Liefert die neuste Workflow-Instanz zu der gegebenen Referenz","operationId":"getLatestWorkflowInstance_6","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}},"404":{"description":"Es existiert noch keine Workflow-Instanz","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}}}}}},"components":{"schemas":{"common-workflow-WorkflowInstance":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]},"workflowRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workItems":{"type":"array","description":"Schritte des Workflows","items":{"$ref":"#/components/schemas/common-workflow-WorkItem"}},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-workflow-WorkItem":{"description":"Schritte des Workflows","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Bearbeitungszustand eines Work-Items","enum":["OPEN","IN_PROCESS","COMPLETED","ERRONEOUS","ABORTED"]},"workflowElementRef":{"type":"integer","format":"int64","description":"Workflow-Element, das abgebildet wird"},"parentWorkItemRef":{"type":"integer","format":"int64","description":"Work-Item im übergeordneten Workflow, wenn es sich um einen Unter-Workflow handelt"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}},"splitResult":{"type":"string","description":"Für Split-Gateways: mit welchem Ergebnis wurde dieses Work-Item ausgeführt"}}},"common-workflow-WorkflowInstanceLogLine":{"description":"Logging-Einträge chronologisch sortiert","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"workflowInstanceId":{"type":"integer","format":"int64","description":"ID der Workflow-Instanz"},"workItemId":{"type":"integer","format":"int64","description":"ID des Work-Items"},"logTime":{"type":"string","format":"date-time","description":"Zeitstempel"},"origin":{"type":"string","description":"Wodurch wurde dieser Eintrag ausgelöst","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"message":{"type":"string","description":"Nachricht"},"messageKey":{"type":"string","description":"I18n-Key"},"propertyPath":{"type":"string","description":"Pfad"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"Parameter für die I18n-Nachricht"},"description":"Parameter für die I18n-Nachricht"}}}}}} ``` ## GET /erp/crm-deals/{id}/subscription > Liefert alle Subscription auf dem Geschäftsobjekt ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/subscription":{"get":{"tags":["Deals"],"summary":"Liefert alle Subscription auf dem Geschäftsobjekt","operationId":"getSubscriber_2","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}}}}}}}},"components":{"schemas":{"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/crm-deals/{id}/reminders > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/{id}/reminders":{"get":{"tags":["Deals"],"operationId":"getReminders_2","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-crm-CrmReminder"}}}}}}}}},"components":{"schemas":{"erp-crm-CrmReminder":{"description":"CRM Erinnerungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"crmId":{"type":"integer","format":"int64","description":"ID des CRM Objekts"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"remindAt":{"type":"string","format":"date-time","description":"Erinnerungszeitpunkt"},"note":{"type":"string","description":"Notiz zur Erinnerung"},"critical":{"type":"boolean","description":"Kritische Erinnerung?"}},"required":["crmId","remindAt","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## GET /erp/crm-deals/reminders > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Deals","description":"CRM Deals"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-deals/reminders":{"get":{"tags":["Deals"],"operationId":"getAllReminders_2","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-crm-CrmReminder"}}}}}}}}},"components":{"schemas":{"erp-crm-CrmReminder":{"description":"CRM Erinnerungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"crmId":{"type":"integer","format":"int64","description":"ID des CRM Objekts"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"remindAt":{"type":"string","format":"date-time","description":"Erinnerungszeitpunkt"},"note":{"type":"string","description":"Notiz zur Erinnerung"},"critical":{"type":"boolean","description":"Kritische Erinnerung?"}},"required":["crmId","remindAt","userRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` # Logs Log Resource ## GET /cmn/system/log-entries/{id} > Find an existing Instance by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Logs","description":"Log Resource"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/system/log-entries/{id}":{"get":{"tags":["Logs"],"summary":"Find an existing Instance by identifier","operationId":"getById_114","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-api-LogEntryGet"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-LogEntryGet":{"properties":{"logTime":{"type":"string","format":"date-time","description":"Log-Time"},"loggerName":{"type":"string","description":"Logger Name"},"userRef":{"type":"string","description":"User Reference"},"level":{"type":"string","description":"log level","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"requestId":{"type":"string","description":"request identifier"},"message":{"type":"string","description":"message"},"messageThrowable":{"type":"string","description":"messageThrowable"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"id":{"type":"integer","format":"int64","description":"id","readOnly":true},"messageTopic":{"type":"string","description":"topic of message entry","readOnly":true}},"required":["loggerName"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/system/log-entries/{id} > Update a Instance ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Logs","description":"Log Resource"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/system/log-entries/{id}":{"put":{"tags":["Logs"],"summary":"Update a Instance","operationId":"update_106","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-LogEntry"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-api-LogEntryGet"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-LogEntry":{"properties":{"logTime":{"type":"string","format":"date-time","description":"Log-Time"},"loggerName":{"type":"string","description":"Logger Name"},"userRef":{"type":"string","description":"User Reference"},"level":{"type":"string","description":"log level","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"requestId":{"type":"string","description":"request identifier"},"message":{"type":"string","description":"message"},"messageThrowable":{"type":"string","description":"messageThrowable"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"}},"required":["loggerName"]},"common-api-LogEntryGet":{"properties":{"logTime":{"type":"string","format":"date-time","description":"Log-Time"},"loggerName":{"type":"string","description":"Logger Name"},"userRef":{"type":"string","description":"User Reference"},"level":{"type":"string","description":"log level","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"requestId":{"type":"string","description":"request identifier"},"message":{"type":"string","description":"message"},"messageThrowable":{"type":"string","description":"messageThrowable"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"id":{"type":"integer","format":"int64","description":"id","readOnly":true},"messageTopic":{"type":"string","description":"topic of message entry","readOnly":true}},"required":["loggerName"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/system/log-entries > Create a Instance ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Logs","description":"Log Resource"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/system/log-entries":{"post":{"tags":["Logs"],"summary":"Create a Instance","operationId":"create_98","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-LogEntry"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-api-LogEntryGet"}}}},"422":{"description":"Resource was unable to create","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-LogEntry":{"properties":{"logTime":{"type":"string","format":"date-time","description":"Log-Time"},"loggerName":{"type":"string","description":"Logger Name"},"userRef":{"type":"string","description":"User Reference"},"level":{"type":"string","description":"log level","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"requestId":{"type":"string","description":"request identifier"},"message":{"type":"string","description":"message"},"messageThrowable":{"type":"string","description":"messageThrowable"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"}},"required":["loggerName"]},"common-api-LogEntryGet":{"properties":{"logTime":{"type":"string","format":"date-time","description":"Log-Time"},"loggerName":{"type":"string","description":"Logger Name"},"userRef":{"type":"string","description":"User Reference"},"level":{"type":"string","description":"log level","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"requestId":{"type":"string","description":"request identifier"},"message":{"type":"string","description":"message"},"messageThrowable":{"type":"string","description":"messageThrowable"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"id":{"type":"integer","format":"int64","description":"id","readOnly":true},"messageTopic":{"type":"string","description":"topic of message entry","readOnly":true}},"required":["loggerName"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Article Customer the Article Costumer API ## GET /erp/article-customers/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleCustomer","description":"the Article Costumer API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-customers/{id}":{"get":{"tags":["ArticleCustomer"],"summary":"Find an existing Resource by identifier","operationId":"getById_85","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleCustomer"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleCustomer":{"description":"Article-Customer-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"integer","format":"int64","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"integer","format":"int64","description":"Referenced Customer-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","description":"Aktiv?"},"deviatingArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"deviatingArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"deviatingArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"deviatingArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useDeviatingArticleNumber":{"type":"boolean","description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useDeviatingArticleName":{"type":"boolean","description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleDescription":{"type":"boolean","description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleIdentifier":{"type":"boolean","description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"lockedForCustomer":{"type":"boolean","description":"Ist das Produkt für den Kunden gesperrt?"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Kunden-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"customerPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"},"priceDetermination":{"type":"string","default":"DEFAULT","description":"Art der Preisermittlung","enum":["DEFAULT","SPECIAL","ONLY_DEFAULT_PRICE"]}},"required":["accountId","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/article-customers/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleCustomer","description":"the Article Costumer API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-customers/{id}":{"put":{"tags":["ArticleCustomer"],"summary":"Update existing Resource ","operationId":"update_79","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleCustomer"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleCustomer"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleCustomer":{"description":"Article-Customer-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"integer","format":"int64","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"integer","format":"int64","description":"Referenced Customer-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","description":"Aktiv?"},"deviatingArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"deviatingArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"deviatingArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"deviatingArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useDeviatingArticleNumber":{"type":"boolean","description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useDeviatingArticleName":{"type":"boolean","description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleDescription":{"type":"boolean","description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleIdentifier":{"type":"boolean","description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"lockedForCustomer":{"type":"boolean","description":"Ist das Produkt für den Kunden gesperrt?"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Kunden-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"customerPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"},"priceDetermination":{"type":"string","default":"DEFAULT","description":"Art der Preisermittlung","enum":["DEFAULT","SPECIAL","ONLY_DEFAULT_PRICE"]}},"required":["accountId","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/article-customers/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleCustomer","description":"the Article Costumer API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-customers/{id}":{"delete":{"tags":["ArticleCustomer"],"summary":"Delete an existing Resource","operationId":"delete_76","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/article-customers/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleCustomer","description":"the Article Costumer API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-customers/{id}/deactivate":{"put":{"tags":["ArticleCustomer"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_39","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleCustomer"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleCustomer":{"description":"Article-Customer-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"integer","format":"int64","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"integer","format":"int64","description":"Referenced Customer-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","description":"Aktiv?"},"deviatingArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"deviatingArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"deviatingArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"deviatingArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useDeviatingArticleNumber":{"type":"boolean","description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useDeviatingArticleName":{"type":"boolean","description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleDescription":{"type":"boolean","description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleIdentifier":{"type":"boolean","description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"lockedForCustomer":{"type":"boolean","description":"Ist das Produkt für den Kunden gesperrt?"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Kunden-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"customerPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"},"priceDetermination":{"type":"string","default":"DEFAULT","description":"Art der Preisermittlung","enum":["DEFAULT","SPECIAL","ONLY_DEFAULT_PRICE"]}},"required":["accountId","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/article-customers/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleCustomer","description":"the Article Costumer API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-customers/{id}/activate":{"put":{"tags":["ArticleCustomer"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_39","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleCustomer"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleCustomer":{"description":"Article-Customer-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"integer","format":"int64","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"integer","format":"int64","description":"Referenced Customer-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","description":"Aktiv?"},"deviatingArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"deviatingArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"deviatingArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"deviatingArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useDeviatingArticleNumber":{"type":"boolean","description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useDeviatingArticleName":{"type":"boolean","description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleDescription":{"type":"boolean","description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleIdentifier":{"type":"boolean","description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"lockedForCustomer":{"type":"boolean","description":"Ist das Produkt für den Kunden gesperrt?"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Kunden-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"customerPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"},"priceDetermination":{"type":"string","default":"DEFAULT","description":"Art der Preisermittlung","enum":["DEFAULT","SPECIAL","ONLY_DEFAULT_PRICE"]}},"required":["accountId","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/article-customers > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"ArticleCustomer","description":"the Article Costumer API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/article-customers":{"post":{"tags":["ArticleCustomer"],"summary":"Create new Resource","operationId":"create_75","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleCustomer"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-product-ArticleCustomer"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-product-ArticleCustomer":{"description":"Article-Customer-Relation","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"integer","format":"int64","description":"Referenced Article"},"articleName":{"type":"string","description":"Referenced Article name"},"accountId":{"type":"integer","format":"int64","description":"Referenced Customer-Account"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"accountDisplayName":{"type":"string","description":"Anzeigename des Accounts","readOnly":true},"active":{"type":"boolean","description":"Aktiv?"},"deviatingArticleNumber":{"type":"string","description":"Abweichende Produktnummer"},"deviatingArticleName":{"type":"string","description":"Abweichende Produktbezeichnung"},"deviatingArticleDescription":{"type":"string","description":"Abweichende Produktbeschreibung"},"deviatingArticleIdentifier":{"type":"string","description":"Abweichender Produktidentifer (z.B. Barcode)"},"useDeviatingArticleNumber":{"type":"boolean","description":"Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)"},"useDeviatingArticleName":{"type":"boolean","description":"Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleDescription":{"type":"boolean","description":"Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)"},"useDeviatingArticleIdentifier":{"type":"boolean","description":"Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)"},"lockedForCustomer":{"type":"boolean","description":"Ist das Produkt für den Kunden gesperrt?"},"defaultNetPrice":{"type":"number","description":"Standardpreis Netto"},"defaultGrossPrice":{"type":"number","description":"Standardpreis Brutto"},"productPrices":{"type":"array","description":"Kunden-Preise","items":{"$ref":"#/components/schemas/erp-product-ProductPrice"},"readOnly":true},"customerPrintLabelSettings":{"$ref":"#/components/schemas/erp-product-ArticlePrintLabelSettings"},"priceDetermination":{"type":"string","default":"DEFAULT","description":"Art der Preisermittlung","enum":["DEFAULT","SPECIAL","ONLY_DEFAULT_PRICE"]}},"required":["accountId","articleId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-product-ProductPrice":{"description":"Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"netPrice":{"type":"number","description":"Netto-Preis"},"grossPrice":{"type":"number","description":"Brutto-Preis"},"priceBase":{"type":"string","description":"Preisbasis","enum":["NET_PRICE","GROSS_PRICE"]},"usedTaxRate":{"$ref":"#/components/schemas/erp-tax-TaxRate"},"qualifier":{"type":"string","description":"Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt","enum":["SALES","PURCHASE"],"readOnly":true},"purchasePriceSource":{"type":"string","description":"Einkaufspreis zur Kalkulation","enum":["NONE","AVERAGE","MOST_RECENT"]},"modifierValueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"modifierValue":{"type":"number","description":"Wert des Aufschlags bei EK-Kalkulation"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accessoryMainArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"productGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"currencyRef":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"fromQuantity":{"type":"number","description":"Bestimmt ab welcher Menge dieser Preis gültig ist"},"validFrom":{"type":"string","format":"date","description":"Gültig von"},"validUntil":{"type":"string","format":"date","description":"Gültig bis"},"specialOfferPrice":{"type":"boolean","default":false,"description":"Aktionpreis"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"supplierGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"manufacturerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-tax-TaxRate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"typeRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"},"active":{"type":"boolean","default":true,"description":"is this tax-rate active (selectable)","readOnly":true},"countryCode":{"type":"string","description":"the country code for this tax-rate"},"rate":{"type":"number","description":"the rate of this tax-rate"},"validFrom":{"type":"string","format":"date","description":"the date, this entry is valid from"}},"required":["countryCode","rate","typeRef","validFrom"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"erp-product-ArticlePrintLabelSettings":{"description":"Etikettdruck-Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"report":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"incomingCalculationMode":{"type":"string","description":"Wareneingang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"incomingPrintQuantity":{"type":"integer","format":"int32","description":"Wareneingang: Druckmenge"},"outgoingCalculationMode":{"type":"string","description":"Warenausgang: Bestimmung der Druckmenge","enum":["NO_LABEL","FIXED_AMOUNT","QUANTITY_TIMES_AMOUNT","QUANTITY_PER_PACKAGING_UNIT","QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY"]},"outgoingPrintQuantity":{"type":"integer","format":"int32","description":"Warenausgang: Druckmenge"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Open Item the Finance OpenItem API ## PUT /erp/finance/openitems/{openItemId}/change > Ändert Stammdaten am Offenen Posten wie Mahnsperre ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{openItemId}/change":{"put":{"tags":["OpenItem"],"description":"Ändert Stammdaten am Offenen Posten wie Mahnsperre","operationId":"update_36","parameters":[{"name":"openItemId","in":"path","description":"openItem Identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemChangeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemChangeRequest":{"properties":{"manualPaymentDueDate":{"type":"string","format":"date","description":"manuelles vorrangiges Fälligkeitsdatum"},"dunningBlock":{"type":"boolean","description":"Mahnsperre"},"inReview":{"type":"boolean","description":"In Klärung setzen"},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"clearValueDate":{"type":"boolean","description":"Valutadatum löschen"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","description":"Zahlungssperre"},"externalNumber":{"type":"string","description":"Externe OP-Nummer"},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte. Bei Änderung auf eine Wert ungleich USER_DEFINED werden die Werte wieder neu geladen.","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"paymentDays1":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen (Skonto 1), setzt den Ursprung der Skontowerte auf USER_DEFINED"},"paymentDiscount1":{"type":"number","description":"Skonto 1 in Prozent, setzt den Ursprung der Skontowerte auf USER_DEFINED"},"paymentDays2":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen (Skonto 2), setzt den Ursprung der Skontowerte auf USER_DEFINED"},"paymentDiscount2":{"type":"number","description":"Skonto 2 in Prozent, setzt den Ursprung der Skontowerte auf USER_DEFINED"},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (Ersatz für die Kontenermittlung ohne Beleg)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (Ersatz für die Kontenermittlung ohne Beleg)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (Ersatz für die Kontenermittlung ohne Beleg)"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## PUT /erp/finance/openitems/additional-functions/{openItemId}/UpdateTags > Update Tags ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/additional-functions/{openItemId}/UpdateTags":{"put":{"tags":["OpenItem"],"summary":"Update Tags","operationId":"setOpenItemTags","parameters":[{"name":"openItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## GET /erp/finance/openitems/account/{accountId}/print > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/account/{accountId}/print":{"get":{"tags":["OpenItem"],"operationId":"getPrintPreview","parameters":[{"name":"accountId","in":"path","description":"account identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{}}}}}}}}} ``` ## PUT /erp/finance/openitems/account/{accountId}/print > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/account/{accountId}/print":{"put":{"tags":["OpenItem"],"operationId":"printDunning","parameters":[{"name":"accountId","in":"path","description":"account identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{}},"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"common-output-OutputRequest":{"properties":{"exportFormat":{"type":"string","description":"output-format für mail/file-export","enum":["PDF","XLSX","JSON_RAW","REPORT_TEMPLATE"]},"exportFilename":{"type":"string","description":"filename (ohne extension) bei einem file-export"},"mailRecipients":{"type":"array","description":"Empfänger","items":{"$ref":"#/components/schemas/common-output-OutputRecipient.MailRecipient"}},"outputType":{"type":"string","description":"outputType"},"groupIdentifier":{"type":"string","description":"OutputReportGroup Identifier (optional), sonst Default-Group des Moduls"},"published":{"type":"boolean","default":false,"description":"sollen nur bereits veröffentlichte Dokumente beachtet werden?"}}},"common-output-OutputRecipient.MailRecipient":{"description":"Empfänger","properties":{"type":{"type":"string","description":"(mail) recipient type","enum":["TO","CC","BCC"]},"address":{"type":"string","description":"(mail) recipient address"},"name":{"type":"string","description":"(mail) recipient name"}}}}}} ``` ## POST /erp/finance/openitems/{openItemid}/calculate\_discount/{discountDate} > Gibt den Skontobetrag und die Gültigkeit des Skonto für ein angegebenes Datum zurück ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{openItemid}/calculate_discount/{discountDate}":{"post":{"tags":["OpenItem"],"description":"Gibt den Skontobetrag und die Gültigkeit des Skonto für ein angegebenes Datum zurück","operationId":"calculateDiscountForDate","parameters":[{"name":"openItemid","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"discountDate","in":"path","required":true,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-DiscountCalculationResponse"}}}}}}}},"components":{"schemas":{"erp-finance-DiscountCalculationResponse":{"properties":{"discountDate":{"type":"string","format":"date","description":"Skontodatum"},"discountAmount":{"type":"number","description":"Skontobetrag"},"isApplicable":{"type":"boolean","description":"Skonto ist anwandbar"}}}}}} ``` ## POST /erp/finance/openitems/{openItemId}/{openItemRecordId}/reassignTransaction > weist eine Transaction einem anderen OP zu ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{openItemId}/{openItemRecordId}/reassignTransaction":{"post":{"tags":["OpenItem"],"description":"weist eine Transaction einem anderen OP zu","operationId":"reassignTransaction","parameters":[{"name":"openItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"openItemRecordId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemTransactionReassignRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemTransactionReassignRequest":{"properties":{"targetOpenItemId":{"type":"integer","format":"int64","description":"neuer OP dem die Transaction zugewiesen werden soll"}}},"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## POST /erp/finance/openitems/{openItemId}/startUpdate > Sperrt einen OP zur Bearbeitung ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{openItemId}/startUpdate":{"post":{"tags":["OpenItem"],"description":"Sperrt einen OP zur Bearbeitung","operationId":"startUpdate","parameters":[{"name":"openItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-unknownmodule-LeasableLock"}}}}}}}},"components":{"schemas":{"core-unknownmodule-LeasableLock":{"properties":{"key":{"type":"string"},"token":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"},"lockedBySystem":{"type":"boolean"},"validUntil":{"type":"string","format":"date-time"},"id":{"type":"string","description":"Unique identifier of the Object","readOnly":true}},"required":["key","token"]}}}} ``` ## POST /erp/finance/openitems/{openItemId}/cancelUpdate > Gibt einen OP wieder frei ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{openItemId}/cancelUpdate":{"post":{"tags":["OpenItem"],"description":"Gibt einen OP wieder frei","operationId":"cancelUpdate","parameters":[{"name":"openItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## POST /erp/finance/openitems/{id}/revert/{recordId} > storniert eine Zahlung oder eine Verrechnung ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{id}/revert/{recordId}":{"post":{"tags":["OpenItem"],"description":"storniert eine Zahlung oder eine Verrechnung","operationId":"revert","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"recordId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## GET /erp/finance/openitems/{firstOpenItemId}/clear\_with/{secondOpenItemId} > Gibt das Saldo nach Verrechnung zurück ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{firstOpenItemId}/clear_with/{secondOpenItemId}":{"get":{"tags":["OpenItem"],"description":"Gibt das Saldo nach Verrechnung zurück","operationId":"calculateExpectedBalance","parameters":[{"name":"firstOpenItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"secondOpenItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-ClearingExpectedResponse"}}}}}}}},"components":{"schemas":{"erp-finance-ClearingExpectedResponse":{"properties":{"qualifier":{"type":"string","description":"Forderung oder Verbindlichkeit","enum":["PAYABLE","RECEIVABLE"]},"amount":{"type":"number","description":"saldo"}}}}}} ``` ## POST /erp/finance/openitems/{firstOpenItemId}/clear\_with/{secondOpenItemId} > Verrechnet zwei OPs ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{firstOpenItemId}/clear_with/{secondOpenItemId}":{"post":{"tags":["OpenItem"],"description":"Verrechnet zwei OPs","operationId":"clearReceivableWithPayable","parameters":[{"name":"firstOpenItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"secondOpenItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-ClearingResponse"}}}}}}}},"components":{"schemas":{"erp-finance-ClearingResponse":{"properties":{"firstOpenItemId":{"type":"integer","format":"int64","description":"ID des ersten OPs"},"secondOpenItemId":{"type":"integer","format":"int64","description":"ID des zweiten OPs"},"clearedAmount":{"type":"number","description":"Verrechneter Betrag"}}}}}} ``` ## POST /erp/finance/openitems/recalculate/{openItemID} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/recalculate/{openItemID}":{"post":{"tags":["OpenItem"],"operationId":"recalculate","parameters":[{"name":"openItemID","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemRecalculateRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemRecalculateRequest":{"properties":{"grantDeliveryApproval":{"type":"boolean","description":"Lieferfreigabe erteilen"},"newBalance":{"type":"number","description":"neuer Saldo"}}},"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## POST /erp/finance/openitems/create\_op\_from\_transaction > Creates an open item from a bank transaction ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/create_op_from_transaction":{"post":{"tags":["OpenItem"],"description":"Creates an open item from a bank transaction","operationId":"createFromTransaction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-TransactionToOpenItemRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"erp-finance-TransactionToOpenItemRequest":{"properties":{"transactionId":{"type":"integer","format":"int64","description":"ID of the bank transaction"},"accountId":{"type":"integer","format":"int64","description":"ID of the account the new open item is assigned to"},"paymentMethodId":{"type":"integer","format":"int64","description":"ID of the payment method to set on the open item"},"bookingAccountType":{"type":"string","description":"Booking account type: CUSTOMER (debtor) or SUPPLIER (creditor)","enum":["CUSTOMER","SUPPLIER"]}},"required":["bookingAccountType"]},"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## GET /erp/finance/openitems/account/{accountId}/offset\_credit\_notes > Vorschau: verrechnet offene Gutschriften des Kontos gegen dessen offene Rechnungen (älteste zuerst) ohne zu buchen und meldet zurück, was verrechnet würde ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/account/{accountId}/offset_credit_notes":{"get":{"tags":["OpenItem"],"description":"Vorschau: verrechnet offene Gutschriften des Kontos gegen dessen offene Rechnungen (älteste zuerst) ohne zu buchen und meldet zurück, was verrechnet würde","operationId":"previewOffsetCreditNotes","parameters":[{"name":"accountId","in":"path","description":"account identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemOffsetResult"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemOffsetResult":{"properties":{"preview":{"type":"boolean","default":false,"description":"true = nur Vorschau (es wurde nicht gebucht), false = tatsächlich verrechnet"},"totalOffsetAmount":{"type":"number","description":"Gesamtsumme der verrechneten Beträge"},"lines":{"type":"array","description":"Die einzelnen Verrechnungen (Gutschrift gegen Rechnung)","items":{"$ref":"#/components/schemas/erp-finance-OpenItemOffsetLine"}}}},"erp-finance-OpenItemOffsetLine":{"description":"Die einzelnen Verrechnungen (Gutschrift gegen Rechnung)","properties":{"receivableOpenItemId":{"type":"integer","format":"int64","description":"ID des Rechnungs-OPs (Forderung)"},"receivableNumber":{"type":"string","description":"Nummer des Rechnungs-OPs"},"creditNoteOpenItemId":{"type":"integer","format":"int64","description":"ID des Gutschrift-OPs (Verbindlichkeit)"},"creditNoteNumber":{"type":"string","description":"Nummer des Gutschrift-OPs"},"offsetAmount":{"type":"number","description":"Verrechneter Betrag"},"currencyCode":{"type":"string","description":"Währung der Verrechnung (ISO-Code)"}}}}}} ``` ## POST /erp/finance/openitems/account/{accountId}/offset\_credit\_notes > Verrechnet offene Gutschriften des Kontos gegen dessen offene Rechnungen (älteste zuerst) und meldet zurück, was verrechnet wurde ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/account/{accountId}/offset_credit_notes":{"post":{"tags":["OpenItem"],"description":"Verrechnet offene Gutschriften des Kontos gegen dessen offene Rechnungen (älteste zuerst) und meldet zurück, was verrechnet wurde","operationId":"offsetCreditNotes","parameters":[{"name":"accountId","in":"path","description":"account identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemOffsetResult"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemOffsetResult":{"properties":{"preview":{"type":"boolean","default":false,"description":"true = nur Vorschau (es wurde nicht gebucht), false = tatsächlich verrechnet"},"totalOffsetAmount":{"type":"number","description":"Gesamtsumme der verrechneten Beträge"},"lines":{"type":"array","description":"Die einzelnen Verrechnungen (Gutschrift gegen Rechnung)","items":{"$ref":"#/components/schemas/erp-finance-OpenItemOffsetLine"}}}},"erp-finance-OpenItemOffsetLine":{"description":"Die einzelnen Verrechnungen (Gutschrift gegen Rechnung)","properties":{"receivableOpenItemId":{"type":"integer","format":"int64","description":"ID des Rechnungs-OPs (Forderung)"},"receivableNumber":{"type":"string","description":"Nummer des Rechnungs-OPs"},"creditNoteOpenItemId":{"type":"integer","format":"int64","description":"ID des Gutschrift-OPs (Verbindlichkeit)"},"creditNoteNumber":{"type":"string","description":"Nummer des Gutschrift-OPs"},"offsetAmount":{"type":"number","description":"Verrechneter Betrag"},"currencyCode":{"type":"string","description":"Währung der Verrechnung (ISO-Code)"}}}}}} ``` ## GET /erp/finance/openitems/{refId}/workflow-state > Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{refId}/workflow-state":{"get":{"tags":["OpenItem"],"summary":"Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz","operationId":"getWorkflowState","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"*/*":{"schema":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}},"404":{"description":"Es existiert noch keine Workflow-Instanz","content":{"*/*":{"schema":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}}}}}}} ``` ## GET /erp/finance/openitems/{refId}/workflow-instances-preset > Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{refId}/workflow-instances-preset":{"get":{"tags":["OpenItem"],"summary":"Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz","operationId":"getWorkflowInstancesPreset","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-cunit-QueryPreset"}}}}}}}},"components":{"schemas":{"common-cunit-QueryPreset":{"description":"Adhoc Preset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"templateId":{"type":"string","description":"template dem dieser filter zugeordnet worden ist."},"templateGroupKey":{"type":"string","description":"templateGroupKey dem dieser filter zugeordnet worden ist."},"label":{"type":"string","description":"label für diesen filter"},"uiPayload":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variables":{"type":"array","description":"Variablen für dieses Preset","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"}},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"results":{"type":"array","description":"ergebnisse","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"sortAndOrders":{"type":"array","description":"sortierung","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetPageable"},"option":{"$ref":"#/components/schemas/common-cunit-QueryPresetOption"},"transformations":{"type":"array","description":"zusätzliche konfigurationen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetTransformation"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"definition":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]},"readOnly":true},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"},"forWorkflow":{"type":"boolean","default":false,"description":"für Workflows vorgesehen"},"outputReportGroupIdentifier":{"type":"string","description":"Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird"},"userOptions":{"$ref":"#/components/schemas/common-cunit-QueryPresetUserOptions"}},"required":["forWorkflow","label","mode","permissionAggregation","templateGroupKey","templateId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"common-cunit-QueryPresetVariable":{"description":"Die zu ersetzende Variable","properties":{"path":{"type":"string","description":"Der pfad, der dieses Attribut eindeutig beschreibt"},"definition":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}],"readOnly":true},"mandatory":{"type":"boolean","description":"Ob die Variable ein Pflichtfeld ist oder nicht"},"variableName":{"type":"string","description":"Name der Variablen"},"visible":{"type":"boolean","default":true,"description":"Handelt es sich um eine sichtbare Variable?"},"alignX":{"type":"integer","format":"int32","description":"Anordnung im UI - X-Koordinate"},"alignY":{"type":"integer","format":"int32","description":"Anordnung im UI - Y-Koordinate"},"alignWidth":{"type":"integer","format":"int32","description":"Anordnung im UI - Breite"},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Eindeutiger Schlüssel zur Identifikation des Attributs"},"attribute":{"type":"string","description":"name des attributes der das ergebnis enthält"},"path":{"type":"string","description":"der pfad, der dieses attribut eindeutig beschreibt"},"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"parentDisplayName":{"type":"string","description":"der Name des Referenzierenden Feldes"},"resultable":{"type":"boolean","default":true,"description":"kann dieses Feld ein Ergebnisfeld sein"},"filterable":{"type":"boolean","default":true,"description":"kann nach diesem feld gefiltert werden"},"sortable":{"type":"boolean","default":true,"description":"ist dieses Feld sortierbar"},"visible":{"type":"boolean","default":true,"description":"soll dieses Feld angezeigt werden"},"functions":{"type":"array","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)","items":{"type":"string","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)"}},"sortDirection":{"type":"string","description":"Info, wie diese spalte sortiert worden ist"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"modelType":{"type":"string","description":"Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')","readOnly":true},"headers":{"type":"array","description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-MetaContent":{"description":"Definition dieser Variable","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]}}}},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"}}}]},"core-cunit-CuAttributeConstraint":{"description":"constraints für dieses Attribut","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"minimaler Wert","readOnly":true},"includeMinValue":{"type":"boolean","description":"ist der minimale Wert inklusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"maximaler Wert","readOnly":true},"includeMaxValue":{"type":"boolean","description":"ist der maximale Wert inklusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"ist der Wert 'null' verboten?","readOnly":true},"notBlank":{"type":"boolean","description":"Bei Strings: ist ein String nur aus Whitespace verboten?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximale Anzahl Nachkommastellen","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"data-type für dieses Attribut (falls dataTypeIdentifier leer ist)","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"welcher Typ ist es","readOnly":true},"objectRefIdentifier":{"type":"string","description":"bei Object_Ref: welcher Typ ist es genau","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"welche Funktionen sind erlaubt?","items":{"type":"string","description":"welche Funktionen sind erlaubt?"},"readOnly":true},"predicateOperations":{"type":"array","description":"welche Operations sind erlaubt?","items":{"type":"string","description":"welche Operations sind erlaubt?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit Attribut Filter Optionen","properties":{"filterValues":{"type":"array","description":"Mögliche Filterwerte","items":{"type":"string","description":"Mögliche Filterwerte"}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute.HeaderGroup":{"description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","properties":{"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Bedingungen zur Selektion von Lagerplätzen","properties":{"type":{"type":"string","description":"die Operation für diesen Filter","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"(bei junction) child-definitionen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"filter werte","items":{"type":"string","description":"filter werte"}},"visible":{"type":"boolean","default":true,"description":"Sichtbarkeit bei Variablen"},"functions":{"type":"array","description":"Eine SQL-Funktion, die im Predicate angewendet wird","items":{"type":"string","description":"Eine SQL-Funktion, die im Predicate angewendet wird"}}},"required":["operator","type"]},"common-cunit-QueryPresetResult":{"description":"Ergebnisse","properties":{"property":{"type":"string","description":"property"},"displayName":{"type":"string","description":"title dieser spalte"},"functions":{"type":"array","description":"funktionen","items":{"type":"string","description":"funktionen"}},"visible":{"type":"boolean","default":true,"description":"sichtbare Ergebnisspalte"}},"required":["property"]},"common-cunit-QueryPresetSortOrder":{"description":"sort and order anweisungen","properties":{"property":{"type":"string","description":"property"},"functions":{"type":"array","description":"Functions","items":{"type":"string","description":"Functions"}},"direction":{"type":"string","description":"sort order","enum":["ASC","DESC"]}},"required":["direction","property"]},"common-cunit-QueryPresetPageable":{"description":"pageable","properties":{"limit":{"type":"integer","format":"int64","description":"das Limit (MaxRecordCount) für diesen Query"}}},"common-cunit-QueryPresetOption":{"description":"options","properties":{"distinctResult":{"type":"boolean","description":"soll der Query mit einem Distinct durchgeführt werden"}}},"common-cunit-QueryPresetTransformation":{"description":"zusätzliche konfigurationen","properties":{"crossTable":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation"}}},"common-cunit-QueryPresetCrossTableTransformation":{"description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","properties":{"rowSpecs":{"type":"array","description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"columnSpecs":{"type":"array","description":"enthält die felder, die in der cross-table als dynamische spalten erstellt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"results":{"type":"array","description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell"}}},"required":["columnSpecs","results","rowSpecs"]},"common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell":{"description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","properties":{"result":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"cellView":{"type":"string","description":"darstellung der werte","enum":["AS_IS","PERCENT_COL"]},"sumColumn":{"type":"boolean","default":false,"description":"soll eine spaltensumme erzeugt werden"},"rowMode":{"type":"string","description":"soll eine zeilensumme erzeugt werden","enum":["DATA","DATA_AND_TOTAL","TOTAL"]},"aggregateFunction":{"type":"string","description":"die funktion mit der die werte der Zelle aggregiert werden"}}},"common-cunit-ArithmeticQueryTerm":{"description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","properties":{"termName":{"type":"string","description":"Der Name des Terms für die Verarbeitung und Darstellung"},"terms":{"type":"array","description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermInner"}},"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-cunit-ArithmeticQueryTermInner":{"description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","properties":{"fragment":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermFragment"},"attribute":{"type":"string","description":"Ein echtes Attribut aus dem Template"},"fixedValue":{"type":"number","description":"Ein Fixwert"}}},"common-cunit-ArithmeticQueryTermFragment":{"description":"Das Termfragment - eine weitere Verschachtelung mit eigenen Operationen","properties":{"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-cunit-QueryPresetUserOptions":{"description":"nutzerbezogene Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"pinned":{"type":"boolean","default":false,"description":"angepinnt?"}},"required":["pinned"]}}}} ``` ## GET /erp/finance/openitems/{refId}/latest-workflow-instance > Liefert die neuste Workflow-Instanz zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{refId}/latest-workflow-instance":{"get":{"tags":["OpenItem"],"summary":"Liefert die neuste Workflow-Instanz zu der gegebenen Referenz","operationId":"getLatestWorkflowInstance","parameters":[{"name":"refId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}},"404":{"description":"Es existiert noch keine Workflow-Instanz","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}}}}}},"components":{"schemas":{"common-workflow-WorkflowInstance":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]},"workflowRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workItems":{"type":"array","description":"Schritte des Workflows","items":{"$ref":"#/components/schemas/common-workflow-WorkItem"}},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-workflow-WorkItem":{"description":"Schritte des Workflows","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Bearbeitungszustand eines Work-Items","enum":["OPEN","IN_PROCESS","COMPLETED","ERRONEOUS","ABORTED"]},"workflowElementRef":{"type":"integer","format":"int64","description":"Workflow-Element, das abgebildet wird"},"parentWorkItemRef":{"type":"integer","format":"int64","description":"Work-Item im übergeordneten Workflow, wenn es sich um einen Unter-Workflow handelt"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}},"splitResult":{"type":"string","description":"Für Split-Gateways: mit welchem Ergebnis wurde dieses Work-Item ausgeführt"}}},"common-workflow-WorkflowInstanceLogLine":{"description":"Logging-Einträge chronologisch sortiert","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"workflowInstanceId":{"type":"integer","format":"int64","description":"ID der Workflow-Instanz"},"workItemId":{"type":"integer","format":"int64","description":"ID des Work-Items"},"logTime":{"type":"string","format":"date-time","description":"Zeitstempel"},"origin":{"type":"string","description":"Wodurch wurde dieser Eintrag ausgelöst","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"message":{"type":"string","description":"Nachricht"},"messageKey":{"type":"string","description":"I18n-Key"},"propertyPath":{"type":"string","description":"Pfad"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"Parameter für die I18n-Nachricht"},"description":"Parameter für die I18n-Nachricht"}}}}}} ``` ## GET /erp/finance/openitems/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/{id}":{"get":{"tags":["OpenItem"],"summary":"Find an existing Resource by identifier","operationId":"getById_37","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/finance/openitems/selector > select the OpenItems with different parameter ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItem","description":"the Finance OpenItem API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/selector":{"get":{"tags":["OpenItem"],"description":"select the OpenItems with different parameter","operationId":"findAllBySelector","parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"balanced","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"documentId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"documentQualifier","in":"query","required":false,"schema":{"type":"string","enum":["PAYABLE","RECEIVABLE"]}},{"name":"bookingRecordId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}}},"components":{"schemas":{"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` # Open Item Closure Offene Posten - Manueller Abschluss ## POST /erp/finance/openitems/closure/{openItemId}/reopen > Eröffnet einen manuell abgeschlossenen OP wieder ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItemClosure","description":"Offene Posten - Manueller Abschluss"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/closure/{openItemId}/reopen":{"post":{"tags":["OpenItemClosure"],"description":"Eröffnet einen manuell abgeschlossenen OP wieder","operationId":"reopen","parameters":[{"name":"openItemId","in":"path","description":"openItem Identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemReopenRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemReopenRequest":{"properties":{"comment":{"type":"string","description":"Kommentar zur Wiederöffnung"},"businessTransactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## POST /erp/finance/openitems/closure/{openItemId}/close > Schließt einen offenen Posten ab ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItemClosure","description":"Offene Posten - Manueller Abschluss"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/closure/{openItemId}/close":{"post":{"tags":["OpenItemClosure"],"description":"Schließt einen offenen Posten ab","operationId":"close","parameters":[{"name":"openItemId","in":"path","description":"openItem Identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemCloseRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItem"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemCloseRequest":{"properties":{"reimbursePayments":{"type":"boolean","description":"bisherige Zahlungen zurückerstatten"},"comment":{"type":"string","description":"Kommentar zur Schliessung"},"closeableAmount":{"type":"number","description":"Betrag zur Schliessung"},"businessTransactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grantDeliveryApproval":{"type":"boolean","description":"Lieferfreigabe erteilen"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItem":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"order":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"invoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"creditNote":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositInvoice":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"account":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"number":{"type":"string","description":"OP-Nummer","readOnly":true},"externalNumber":{"type":"string","description":"Externe OP-Nummer ","readOnly":true},"depositPaymentAmount":{"type":"number","description":"agreed Deposit payment amount","readOnly":true},"depositPaymentDate":{"type":"string","format":"date","description":"agreed Deposit payment date","readOnly":true},"depositPayed":{"type":"boolean","default":false,"description":"is the agreed deposit payed?","readOnly":true},"balancedDate":{"type":"string","format":"date","description":"balanced date of this open item (calculated)","readOnly":true},"balanceState":{"type":"string","description":"whether this open item is balanced, partially paid or open","enum":["OPEN","PARTIALLY_BALANCED","BALANCED","OVERPAID"],"readOnly":true},"balance":{"type":"number","description":"saldo","readOnly":true},"sumPayments":{"type":"number","description":"Summe gebuchte Zahlungen","readOnly":true},"sumDunnings":{"type":"number","description":"Summe Mahngebühren und Zinsen","readOnly":true},"sumTotalAmount":{"type":"number","description":"Rechnungsbetrag","readOnly":true},"sumDiscountableAmount":{"type":"number","description":"skontierbarer Rechnungsbetrag","readOnly":true},"sumFee":{"type":"number","description":"allgemeine Gebühren","readOnly":true},"records":{"type":"array","description":"free payments","items":{"$ref":"#/components/schemas/erp-finance-OpenItemRecord"},"readOnly":true},"basisPaymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentDays1":{"type":"integer","format":"int32","description":"How many days are given for using the first discount rule","readOnly":true},"paymentDiscount1":{"type":"number","description":"How much discount can be given for speedy payment, rule 1","readOnly":true},"paymentDiscount1DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto1)","readOnly":true},"paymentDays2":{"type":"integer","format":"int32","description":"How many days are given for using the second discount rule","readOnly":true},"paymentDiscount2":{"type":"number","description":"How much discount can be given for speedy payment, rule 2","readOnly":true},"paymentDiscount2DueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum (Skonto2)","readOnly":true},"paymentDiscountOrigin":{"type":"string","description":"Ursprung der Skontowerte (Tage und Prozentsätze)","enum":["FROM_PAYMENT_TERM","FROM_ACCOUNT","USER_DEFINED"]},"qualifier":{"type":"string","description":"Does this open item belong to accounts payable or accounts receivable","enum":["PAYABLE","RECEIVABLE"],"readOnly":true},"fullPaymentAmount":{"type":"number","description":"The full amount of the payment","readOnly":true},"paymentAmount":{"type":"number","description":"Der momentan gültige zu zahlende Betrag","readOnly":true},"paymentKind":{"type":"string","description":"The kind of payment","enum":["PREPAYMENT","PAYMENT"],"readOnly":true},"refundType":{"type":"string","description":"how should a refund be done?","enum":["DISBURSE","OFFSET_LATER"]},"dunningBlock":{"type":"boolean","default":false,"description":"Mahnsperre"},"paymentState":{"type":"string","description":"Der Zustand der Zahlung","enum":["NO_PAYMENT","PAYMENT_CREATED","PAYMENT_TRANSFERRED","PAYMENT_COMMITTED"]},"dunningState":{"type":"string","description":"Der Mahnzustand","enum":["IN_DUNNING","NO_DUNNING","DUNNING_PAID","DUNNING_PARTIALLY_PAID","DUNNING_OVERPAID"]},"dunningLevel":{"type":"integer","format":"int32","description":"Die Mahnstufe","readOnly":true},"dunningCount":{"type":"integer","format":"int32","description":"Anzahl Mahnpositionen/Mahnungen für diesen OP","readOnly":true},"originalPaymentDueDate":{"type":"string","format":"date","description":"Ursprüngliches Fälligkeitsdatum","readOnly":true},"paymentDaysNet":{"type":"integer","format":"int32","description":"Fälligkeit in Tagen"},"paymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"paymentDiscount1Amount":{"type":"number","description":"Skontobetrag 1"},"paymentDiscount2Amount":{"type":"number","description":"Skontobetrag 2"},"paymentTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"purpose":{"type":"string","description":"Verwendungszweck"},"comment":{"type":"string","description":"Kommentar"},"paymentBlock":{"type":"boolean","default":false,"description":"Zahlungssperre"},"tags":{"type":"array","description":"List of tags","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"paymentPlan":{"$ref":"#/components/schemas/erp-finance-OpenItemPaymentPlan"},"valueDateReadOnly":{"type":"boolean","default":false,"description":"Valutadatum schreibgeschützt"},"canBeReopened":{"type":"boolean","default":false,"description":"kann wiedereröffet werden"},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseDepositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag in Basiswährung"},"baseSumPayments":{"type":"number","description":"Summe der Zahlungen in Basiswährung"},"baseSumDiscount":{"type":"number","description":"Summe der Abzüge (Skonto usw.) in Basiswährung"},"baseSumDunnings":{"type":"number","description":"Summe der Mahngebühren und Zinsen in Basiswährung"},"baseSumTotalAmount":{"type":"number","description":"Gesamtsumme der Rechnungsbeträge in Basiswährung"},"baseSumDiscountableAmount":{"type":"number","description":"Summe der skontierbaren Rechnungsbeträge in Basiswährung"},"baseBalance":{"type":"number","description":"Offener Betrag (Saldo) in Basiswährung"},"baseSumFee":{"type":"number","description":"allgemeine Gebühren in Basiswährung"},"blockedByDocument":{"type":"boolean","default":false,"description":"Ist der OP durch ein Dokument geblockt?"},"bookingAccountType":{"type":"string","description":"Buchung auf Lieferant oder Kunde bei manuellen OPs","enum":["CUSTOMER","SUPPLIER"],"readOnly":true},"taxPerformanceLocation":{"type":"string","description":"Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"taxState":{"type":"string","description":"Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)","enum":["TAX_FREE","TAX_ABLE"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)"},"balanced":{"type":"boolean"}},"required":["number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-finance-OpenItemRecord":{"description":"free payments","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"recordDate":{"type":"string","format":"date","description":"record date","readOnly":true},"totalAmount":{"type":"number","description":"record total amount","readOnly":true},"discountableAmount":{"type":"number","description":"record discountable amount","readOnly":true},"amount":{"type":"number","description":"record amount","readOnly":true},"discountAmount":{"type":"number","description":"record discount amount","readOnly":true},"bookingRecordId":{"type":"integer","format":"int64","description":"ref to the financialBookingRecord","readOnly":true},"origin":{"type":"string","description":"origin for this record","enum":["DOCUMENT","PAYMENT","PAYMENT_DISSOLVED","REIMBURSEMENT","REIMBURSEMENT_DISSOLVED","MANUAL_CLOSURE","MANUAL_REOPENING","DUNNING","DUNNING_DISSOLVED","DUNNING_INTEREST_REVERSAL","IMPORT","PAYMENT_PLAN","PAYMENT_PLAN_ENTRY","PAYMENT_IMPORT","CLEARING","CLEARING_DISSOLVED","DEPOSIT","CREDIT_NOTE","BALANCE_ADJUSTMENT","FEE","DUNNING_PAYMENT","DUNNING_PAYMENT_DISSOLVED","POS_PAYMENT"],"readOnly":true},"document":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethod":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"accountBankdetailsRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bankAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessTransaction":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"revertedByRecordId":{"type":"integer","format":"int64","description":"id des records, der diesen storniert hat","readOnly":true},"transactionId":{"type":"integer","format":"int64","description":"id der transaction, die diesen record hervorgerufen hat","readOnly":true},"qualifier":{"type":"string","description":"qualifier of open item","enum":["PAYABLE","RECEIVABLE","PAYMENT_RECEIVED","PAYMENT_SENT","PAYMENT_RECEIVED_REVERTED","PAYMENT_SENT_REVERTED","DUNNING_RECEIVABLE","DUNNING_PAYABLE","DUNNING_RECEIVABLE_REVERTED","DUNNING_PAYABLE_REVERTED"],"readOnly":true},"bookingType":{"type":"string","description":"Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)","enum":["PAYABLE","RECEIVABLE","PAYMENT_PAYABLE","PAYMENT_RECEIVABLE","PAYMENT_PAYABLE_DISSOLVED","PAYMENT_RECEIVABLE_DISSOLVED","DUNNING_PAYABLE","DUNNING_RECEIVABLE","DUNNING_PAYABLE_DISSOLVED","DUNNING_RECEIVABLE_DISSOLVED"],"readOnly":true},"number":{"type":"string","description":"Eine Vorgangsnummer die zur Buchung führte","readOnly":true},"comment":{"type":"string","description":"comment","readOnly":true},"locked":{"type":"boolean","description":"locked","readOnly":true},"revertable":{"type":"boolean","description":"revertable","readOnly":true},"recordReferenceNumber":{"type":"string","description":"record reference number","readOnly":true},"dunningLvl":{"type":"integer","format":"int32","description":"Mahnstufe","readOnly":true},"currencyCode":{"type":"string","description":"Währung des offenen Postens (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des offenen Postens (ISO-A3)"},"baseAmount":{"type":"number","description":"Buchungsbetrag in Basiswährung"},"baseDiscountAmount":{"type":"number","description":"Abzugsbetrag in Basiswährung"},"baseTotalAmount":{"type":"number","description":"Gesamtbetrag in Basiswährung"},"baseDiscountableAmount":{"type":"number","description":"Skontierbarer Gesamtbetrag in Basiswährung"},"baseDunningFee":{"type":"number","description":"Mahngebühren in Basiswährung"},"baseDunningInterest":{"type":"number","description":"Mahnzinsen in Basiswährung"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-finance-OpenItemPaymentPlan":{"description":"Zahlungsplan","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"paymentPlanType":{"type":"string","description":"Zahlungsplantyp","enum":["RULE","MANUAL"]},"dueDateCalculation":{"type":"string","description":"Fälligkeitsregel"},"amount":{"type":"number","description":"Betrag"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"endDate":{"type":"string","format":"date","description":"Enddatum"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","description":"Aktiv"},"dueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum"},"manualRuleEntries":{"type":"array","description":"manuelle Buchungsvorgaben","items":{"$ref":"#/components/schemas/erp-finance-PaymentPlanManualRule"}},"currencyCode":{"type":"string","description":"Währung des Zahlungsplans (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Zahlungsplans (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}},"erp-finance-PaymentPlanManualRule":{"description":"manuelle Buchungsvorgaben","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"amount":{"type":"number","description":"Betrag"},"processed":{"type":"boolean","description":"bereits verarbeitet","readOnly":true},"currencyCode":{"type":"string","description":"Währung (ISO-A3)"},"exchangeRate":{"type":"number","description":"Kurs der Währung zu Basiswährung"},"baseCurrencyCode":{"type":"string","description":"Basiswährung (ISO-A3)"},"baseAmount":{"type":"number","description":"Betrag in Basiswährung"}}}}}} ``` ## POST /erp/finance/openitems/closure/{openItemId}/calculate > Berechnet die Verteilung der Abschlussbuchungen ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"OpenItemClosure","description":"Offene Posten - Manueller Abschluss"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/finance/openitems/closure/{openItemId}/calculate":{"post":{"tags":["OpenItemClosure"],"description":"Berechnet die Verteilung der Abschlussbuchungen","operationId":"calculateCloseableAmounts","parameters":[{"name":"openItemId","in":"path","description":"openItem Identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemCloseRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-finance-OpenItemCloseableAmounts"}}}}}}}},"components":{"schemas":{"erp-finance-OpenItemCloseRequest":{"properties":{"reimbursePayments":{"type":"boolean","description":"bisherige Zahlungen zurückerstatten"},"comment":{"type":"string","description":"Kommentar zur Schliessung"},"closeableAmount":{"type":"number","description":"Betrag zur Schliessung"},"businessTransactionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grantDeliveryApproval":{"type":"boolean","description":"Lieferfreigabe erteilen"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-finance-OpenItemCloseableAmounts":{"properties":{"reimbursableAmount":{"type":"number","description":"zurückzuerstattender Betrag"},"cancellationDunningAmount":{"type":"number","description":"zurückzubuchende Mahnbeträge"},"closeableAmount":{"type":"number","description":"abzuschliessender Betrag"}}}}}} ``` # Typen Von Aufgaben CRM Aufgaben: Verwaltung von Typen ## PUT /erp/crm-tasks/types/{taskSubTypeId}/move/{position} > moves a line to a new position ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Aufgaben","description":"CRM Aufgaben: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/types/{taskSubTypeId}/move/{position}":{"put":{"tags":["Typen von Aufgaben"],"summary":"moves a line to a new position","operationId":"moveLine_1","parameters":[{"name":"taskSubTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"position","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## GET /erp/crm-tasks/types/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Aufgaben","description":"CRM Aufgaben: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/types/{id}":{"get":{"tags":["Typen von Aufgaben"],"summary":"Find an existing Resource by identifier","operationId":"getById_52","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-tasks/types/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Aufgaben","description":"CRM Aufgaben: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/types/{id}":{"put":{"tags":["Typen von Aufgaben"],"summary":"Update existing Resource ","operationId":"update_48","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/crm-tasks/types/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Aufgaben","description":"CRM Aufgaben: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/types/{id}":{"delete":{"tags":["Typen von Aufgaben"],"summary":"Delete an existing Resource","operationId":"delete_46","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-tasks/types/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Aufgaben","description":"CRM Aufgaben: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/types/{id}/deactivate":{"put":{"tags":["Typen von Aufgaben"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_20","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-tasks/types/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Aufgaben","description":"CRM Aufgaben: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/types/{id}/activate":{"put":{"tags":["Typen von Aufgaben"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_20","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/crm-tasks/types > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Aufgaben","description":"CRM Aufgaben: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/types":{"get":{"tags":["Typen von Aufgaben"],"operationId":"getAll","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}}}}} ``` ## POST /erp/crm-tasks/types > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Typen von Aufgaben","description":"CRM Aufgaben: Verwaltung von Typen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/types":{"post":{"tags":["Typen von Aufgaben"],"summary":"Create new Resource","operationId":"create_44","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Commission Run Provisionslauf ## PUT /erp/commission/run/print\_commission/{accountId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommissionRun","description":"Provisionslauf"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/commission/run/print_commission/{accountId}":{"put":{"tags":["CommissionRun"],"operationId":"printCommission","parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{}}}}}}}},"components":{"schemas":{"common-output-OutputRequest":{"properties":{"exportFormat":{"type":"string","description":"output-format für mail/file-export","enum":["PDF","XLSX","JSON_RAW","REPORT_TEMPLATE"]},"exportFilename":{"type":"string","description":"filename (ohne extension) bei einem file-export"},"mailRecipients":{"type":"array","description":"Empfänger","items":{"$ref":"#/components/schemas/common-output-OutputRecipient.MailRecipient"}},"outputType":{"type":"string","description":"outputType"},"groupIdentifier":{"type":"string","description":"OutputReportGroup Identifier (optional), sonst Default-Group des Moduls"},"published":{"type":"boolean","default":false,"description":"sollen nur bereits veröffentlichte Dokumente beachtet werden?"}}},"common-output-OutputRecipient.MailRecipient":{"description":"Empfänger","properties":{"type":{"type":"string","description":"(mail) recipient type","enum":["TO","CC","BCC"]},"address":{"type":"string","description":"(mail) recipient address"},"name":{"type":"string","description":"(mail) recipient name"}}}}}} ``` ## POST /erp/commission/run/{id}/revert > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommissionRun","description":"Provisionslauf"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/commission/run/{id}/revert":{"post":{"tags":["CommissionRun"],"operationId":"revertById","parameters":[{"name":"id","in":"path","description":"id of commission run","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-commission-CommissionRun"}}}}}}}},"components":{"schemas":{"erp-commission-CommissionRun":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"number of commission run","maxLength":255,"minLength":0},"runState":{"type":"string","description":"Verarbeitungsstatus Provisionslauf","enum":["OPEN","COMMITTED","REVERTED"],"readOnly":true},"salesAgents":{"type":"array","description":"sales agents","items":{"$ref":"#/components/schemas/erp-commission-CommissionRunSalesAgent"},"readOnly":true},"runDate":{"type":"string","format":"date","description":"run date","readOnly":true},"dateFrom":{"type":"string","format":"date","description":"date from","readOnly":true},"dateTo":{"type":"string","format":"date","description":"date to","readOnly":true},"numberFrom":{"type":"string","description":"SalesAgent number from","readOnly":true},"numberTo":{"type":"string","description":"SalesAgent number to","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-commission-CommissionRunSalesAgent":{"description":"sales agents","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionType":{"type":"string","description":"commission type of sales agent","enum":["INVOICE","ORDER","PAYMENT"]},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fees":{"type":"array","description":"fees","items":{"$ref":"#/components/schemas/erp-commission-CommissionRunFee"},"readOnly":true},"files":{"type":"array","description":"export files","items":{"$ref":"#/components/schemas/erp-commission-CommissionExportFile"},"readOnly":true},"totalCommissionNetPrice":{"type":"number","description":"Sum Commission Net Price"},"totalCommissionGrossPrice":{"type":"number","description":"Sum Commission Gross Price"},"commissionCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"},"documentRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-commission-CommissionRunFee":{"description":"fees","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionDate":{"type":"string","format":"date","description":"Commission Date"},"description":{"type":"string","description":"Description"},"comment":{"type":"string","description":"User comment"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission Value"},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3 for the fee value"},"feeOrigin":{"type":"string","description":"Fee origin type","enum":["USER_DEFINED","USER_DEFINED_REVERTED","SALES_DOCUMENT","SALES_DOCUMENT_REVERTED"]},"valueOrigin":{"type":"string","description":"value origin","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"originReference":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionableNetPrice":{"type":"number","description":"commissionable Net Price"},"commissionableGrossPrice":{"type":"number","description":"commissionable Gross Price"},"commissionableCurrencyCode":{"type":"string","description":"the Commissionable currency-code IsoAlpha3"},"commissionableExchangeRate":{"type":"number","description":"Commissionable Exchange rate"},"baseCommissionableCurrencyCode":{"type":"string","description":"the Commissionable base currency-code IsoAlpha3"},"baseCommissionableNetPrice":{"type":"number","description":"commissionable base Net Price"},"baseCommissionableGrossPrice":{"type":"number","description":"commissionable base Gross Price"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionNetPrice":{"type":"number","description":"Commission Net Price"},"commissionGrossPrice":{"type":"number","description":"Commission Gross Price"},"commissionCurrencyCode":{"type":"string","description":"the Commission currency-code IsoAlpha3"},"baseCommissionCurrencyCode":{"type":"string","description":"the Commission base currency-code IsoAlpha3"},"commissionExchangeRate":{"type":"number","description":"Commission Exchange rate"},"baseCommissionNetPrice":{"type":"number","description":"Commission Base Net Price"},"baseCommissionGrossPrice":{"type":"number","description":"Commission Base Gross Price"}}},"erp-commission-CommissionExportFile":{"description":"export files","properties":{"shelfDocumentId":{"type":"integer","format":"int64","description":"Shelf Document ID"},"description":{"type":"string","description":"Beschreibung"}}}}}} ``` ## POST /erp/commission/run/{id}/commit > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommissionRun","description":"Provisionslauf"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/commission/run/{id}/commit":{"post":{"tags":["CommissionRun"],"operationId":"commitById","parameters":[{"name":"id","in":"path","description":"id of commission run","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-commission-CommissionRun"}}}}}}}},"components":{"schemas":{"erp-commission-CommissionRun":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"number of commission run","maxLength":255,"minLength":0},"runState":{"type":"string","description":"Verarbeitungsstatus Provisionslauf","enum":["OPEN","COMMITTED","REVERTED"],"readOnly":true},"salesAgents":{"type":"array","description":"sales agents","items":{"$ref":"#/components/schemas/erp-commission-CommissionRunSalesAgent"},"readOnly":true},"runDate":{"type":"string","format":"date","description":"run date","readOnly":true},"dateFrom":{"type":"string","format":"date","description":"date from","readOnly":true},"dateTo":{"type":"string","format":"date","description":"date to","readOnly":true},"numberFrom":{"type":"string","description":"SalesAgent number from","readOnly":true},"numberTo":{"type":"string","description":"SalesAgent number to","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-commission-CommissionRunSalesAgent":{"description":"sales agents","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionType":{"type":"string","description":"commission type of sales agent","enum":["INVOICE","ORDER","PAYMENT"]},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fees":{"type":"array","description":"fees","items":{"$ref":"#/components/schemas/erp-commission-CommissionRunFee"},"readOnly":true},"files":{"type":"array","description":"export files","items":{"$ref":"#/components/schemas/erp-commission-CommissionExportFile"},"readOnly":true},"totalCommissionNetPrice":{"type":"number","description":"Sum Commission Net Price"},"totalCommissionGrossPrice":{"type":"number","description":"Sum Commission Gross Price"},"commissionCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"},"documentRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-commission-CommissionRunFee":{"description":"fees","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionDate":{"type":"string","format":"date","description":"Commission Date"},"description":{"type":"string","description":"Description"},"comment":{"type":"string","description":"User comment"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission Value"},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3 for the fee value"},"feeOrigin":{"type":"string","description":"Fee origin type","enum":["USER_DEFINED","USER_DEFINED_REVERTED","SALES_DOCUMENT","SALES_DOCUMENT_REVERTED"]},"valueOrigin":{"type":"string","description":"value origin","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"originReference":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionableNetPrice":{"type":"number","description":"commissionable Net Price"},"commissionableGrossPrice":{"type":"number","description":"commissionable Gross Price"},"commissionableCurrencyCode":{"type":"string","description":"the Commissionable currency-code IsoAlpha3"},"commissionableExchangeRate":{"type":"number","description":"Commissionable Exchange rate"},"baseCommissionableCurrencyCode":{"type":"string","description":"the Commissionable base currency-code IsoAlpha3"},"baseCommissionableNetPrice":{"type":"number","description":"commissionable base Net Price"},"baseCommissionableGrossPrice":{"type":"number","description":"commissionable base Gross Price"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionNetPrice":{"type":"number","description":"Commission Net Price"},"commissionGrossPrice":{"type":"number","description":"Commission Gross Price"},"commissionCurrencyCode":{"type":"string","description":"the Commission currency-code IsoAlpha3"},"baseCommissionCurrencyCode":{"type":"string","description":"the Commission base currency-code IsoAlpha3"},"commissionExchangeRate":{"type":"number","description":"Commission Exchange rate"},"baseCommissionNetPrice":{"type":"number","description":"Commission Base Net Price"},"baseCommissionGrossPrice":{"type":"number","description":"Commission Base Gross Price"}}},"erp-commission-CommissionExportFile":{"description":"export files","properties":{"shelfDocumentId":{"type":"integer","format":"int64","description":"Shelf Document ID"},"description":{"type":"string","description":"Beschreibung"}}}}}} ``` ## POST /erp/commission/run/singlerun > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommissionRun","description":"Provisionslauf"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/commission/run/singlerun":{"post":{"tags":["CommissionRun"],"operationId":"startRun_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-commission-CommissionRunRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"erp-commission-CommissionRunRequest":{"properties":{"dateFrom":{"type":"string","format":"date","description":"date from"},"dateTo":{"type":"string","format":"date","description":"date to"},"runDate":{"type":"string","format":"date","description":"run date"},"numberFrom":{"type":"string","description":"SalesAgent number from"},"numberTo":{"type":"string","description":"SalesAgent number to"}}},"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## GET /erp/commission/run/{id} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommissionRun","description":"Provisionslauf"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/commission/run/{id}":{"get":{"tags":["CommissionRun"],"operationId":"getById_72","parameters":[{"name":"id","in":"path","description":"id of commission run","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-commission-CommissionRun"}}}}}}}},"components":{"schemas":{"erp-commission-CommissionRun":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"number of commission run","maxLength":255,"minLength":0},"runState":{"type":"string","description":"Verarbeitungsstatus Provisionslauf","enum":["OPEN","COMMITTED","REVERTED"],"readOnly":true},"salesAgents":{"type":"array","description":"sales agents","items":{"$ref":"#/components/schemas/erp-commission-CommissionRunSalesAgent"},"readOnly":true},"runDate":{"type":"string","format":"date","description":"run date","readOnly":true},"dateFrom":{"type":"string","format":"date","description":"date from","readOnly":true},"dateTo":{"type":"string","format":"date","description":"date to","readOnly":true},"numberFrom":{"type":"string","description":"SalesAgent number from","readOnly":true},"numberTo":{"type":"string","description":"SalesAgent number to","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-commission-CommissionRunSalesAgent":{"description":"sales agents","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionType":{"type":"string","description":"commission type of sales agent","enum":["INVOICE","ORDER","PAYMENT"]},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fees":{"type":"array","description":"fees","items":{"$ref":"#/components/schemas/erp-commission-CommissionRunFee"},"readOnly":true},"files":{"type":"array","description":"export files","items":{"$ref":"#/components/schemas/erp-commission-CommissionExportFile"},"readOnly":true},"totalCommissionNetPrice":{"type":"number","description":"Sum Commission Net Price"},"totalCommissionGrossPrice":{"type":"number","description":"Sum Commission Gross Price"},"commissionCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"},"documentRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-commission-CommissionRunFee":{"description":"fees","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionDate":{"type":"string","format":"date","description":"Commission Date"},"description":{"type":"string","description":"Description"},"comment":{"type":"string","description":"User comment"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Commission Value"},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3 for the fee value"},"feeOrigin":{"type":"string","description":"Fee origin type","enum":["USER_DEFINED","USER_DEFINED_REVERTED","SALES_DOCUMENT","SALES_DOCUMENT_REVERTED"]},"valueOrigin":{"type":"string","description":"value origin","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"originReference":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionableNetPrice":{"type":"number","description":"commissionable Net Price"},"commissionableGrossPrice":{"type":"number","description":"commissionable Gross Price"},"commissionableCurrencyCode":{"type":"string","description":"the Commissionable currency-code IsoAlpha3"},"commissionableExchangeRate":{"type":"number","description":"Commissionable Exchange rate"},"baseCommissionableCurrencyCode":{"type":"string","description":"the Commissionable base currency-code IsoAlpha3"},"baseCommissionableNetPrice":{"type":"number","description":"commissionable base Net Price"},"baseCommissionableGrossPrice":{"type":"number","description":"commissionable base Gross Price"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"commissionNetPrice":{"type":"number","description":"Commission Net Price"},"commissionGrossPrice":{"type":"number","description":"Commission Gross Price"},"commissionCurrencyCode":{"type":"string","description":"the Commission currency-code IsoAlpha3"},"baseCommissionCurrencyCode":{"type":"string","description":"the Commission base currency-code IsoAlpha3"},"commissionExchangeRate":{"type":"number","description":"Commission Exchange rate"},"baseCommissionNetPrice":{"type":"number","description":"Commission Base Net Price"},"baseCommissionGrossPrice":{"type":"number","description":"Commission Base Gross Price"}}},"erp-commission-CommissionExportFile":{"description":"export files","properties":{"shelfDocumentId":{"type":"integer","format":"int64","description":"Shelf Document ID"},"description":{"type":"string","description":"Beschreibung"}}}}}} ``` ## GET /erp/commission/run/check > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CommissionRun","description":"Provisionslauf"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/commission/run/check":{"get":{"tags":["CommissionRun"],"operationId":"check","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"boolean"}}}}}}}}} ``` # Unit Type the UnitType API ## GET /cmn/unit-types/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"UnitType","description":"the UnitType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/unit-types/{id}":{"get":{"tags":["UnitType"],"summary":"Find an existing Resource by identifier","operationId":"getById_131","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-UnitType"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-UnitType":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"einheiten typ","enum":["UNDEFINED","AMOUNT","LENGTH","WEIGHT","AREA","VOLUME","SPEED","TIME"]},"name":{"type":"string","description":"einheiten name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"einheiten abkürzung","maxLength":255,"minLength":0},"uneceUnitOfMeasureRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["abbreviation","name","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/unit-types/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"UnitType","description":"the UnitType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/unit-types/{id}":{"put":{"tags":["UnitType"],"summary":"Update existing Resource ","operationId":"update_120","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-UnitType"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-UnitType"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-UnitType":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"einheiten typ","enum":["UNDEFINED","AMOUNT","LENGTH","WEIGHT","AREA","VOLUME","SPEED","TIME"]},"name":{"type":"string","description":"einheiten name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"einheiten abkürzung","maxLength":255,"minLength":0},"uneceUnitOfMeasureRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["abbreviation","name","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/unit-types/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"UnitType","description":"the UnitType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/unit-types/{id}":{"delete":{"tags":["UnitType"],"summary":"Delete an existing Resource","operationId":"delete_110","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/unit-types > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"UnitType","description":"the UnitType API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/unit-types":{"post":{"tags":["UnitType"],"summary":"Create new Resource","operationId":"create_112","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-UnitType"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-UnitType"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-UnitType":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"einheiten typ","enum":["UNDEFINED","AMOUNT","LENGTH","WEIGHT","AREA","VOLUME","SPEED","TIME"]},"name":{"type":"string","description":"einheiten name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"einheiten abkürzung","maxLength":255,"minLength":0},"uneceUnitOfMeasureRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["abbreviation","name","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Output Rule Ausgabe-Regeln ## GET /cmn/output/consumer-rule/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Output-Rule","description":"Ausgabe-Regeln"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/output/consumer-rule/{id}":{"get":{"tags":["Output-Rule"],"summary":"Find an existing Resource by identifier","operationId":"getById_121","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-OutputConsumerRule"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-OutputConsumerRule":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleRef":{"$ref":"#/components/schemas/common-output-OutputModuleRef"},"outputModuleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sourceOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sourceReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"outputQuantity":{"type":"integer","format":"int32","description":"Anzahl der Ausgabe","minimum":1},"systemPresetting":{"type":"boolean","description":"handelt es sich um den systemreport. Bei diesem darf die selektion nicht verändert werden","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-output-OutputModuleRef":{"description":"print module key","properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /cmn/output/consumer-rule/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Output-Rule","description":"Ausgabe-Regeln"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/output/consumer-rule/{id}":{"put":{"tags":["Output-Rule"],"summary":"Update existing Resource ","operationId":"update_111","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-OutputConsumerRule"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-OutputConsumerRule"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-OutputConsumerRule":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleRef":{"$ref":"#/components/schemas/common-output-OutputModuleRef"},"outputModuleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sourceOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sourceReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"outputQuantity":{"type":"integer","format":"int32","description":"Anzahl der Ausgabe","minimum":1},"systemPresetting":{"type":"boolean","description":"handelt es sich um den systemreport. Bei diesem darf die selektion nicht verändert werden","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-output-OutputModuleRef":{"description":"print module key","properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /cmn/output/consumer-rule/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Output-Rule","description":"Ausgabe-Regeln"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/output/consumer-rule/{id}":{"delete":{"tags":["Output-Rule"],"summary":"Delete an existing Resource","operationId":"delete_103","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/output/consumer-rule > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Output-Rule","description":"Ausgabe-Regeln"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/output/consumer-rule":{"post":{"tags":["Output-Rule"],"summary":"Create new Resource","operationId":"create_102","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-OutputConsumerRule"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-api-OutputConsumerRule"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-api-OutputConsumerRule":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleRef":{"$ref":"#/components/schemas/common-output-OutputModuleRef"},"outputModuleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sourceOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"sourceReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetOutputConsumerResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"outputQuantity":{"type":"integer","format":"int32","description":"Anzahl der Ausgabe","minimum":1},"systemPresetting":{"type":"boolean","description":"handelt es sich um den systemreport. Bei diesem darf die selektion nicht verändert werden","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-output-OutputModuleRef":{"description":"print module key","properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` # Category Tree Kategorie-Bäume verwalten ## GET /cmn/category-tree/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CategoryTree","description":"Kategorie-Bäume verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/category-tree/{id}":{"get":{"tags":["CategoryTree"],"summary":"Find an existing Resource by identifier","operationId":"getById_160","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CategoryTree"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CategoryTree":{"description":"Kategorie-Baum","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-Category":{"description":"Kategorie","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"parentCategoryTreeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentCategoryRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"hasChildren":{"type":"boolean","description":"Hat untergeordnete Kategorien (nur bei Kind-Kategorien gesetzt, deren Kinder nicht geladen werden)","readOnly":true},"labels":{"type":"array","description":"Bezeichnung (mehrsprachig)","items":{"$ref":"#/components/schemas/common-masterdata-CategoryDescription"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierung"},"externalReference":{"type":"string","description":"Externe Referenz","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["labels","sortOrder"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CategoryDescription":{"description":"Mehrsprachige Kategorie-Bezeichnung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"Sprachcode (ISO 639-1)"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label","languageCode"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /cmn/category-tree/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CategoryTree","description":"Kategorie-Bäume verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/category-tree/{id}":{"put":{"tags":["CategoryTree"],"summary":"Update existing Resource ","operationId":"update_149","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CategoryTree"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CategoryTree"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CategoryTree":{"description":"Kategorie-Baum","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-Category":{"description":"Kategorie","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"parentCategoryTreeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentCategoryRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"hasChildren":{"type":"boolean","description":"Hat untergeordnete Kategorien (nur bei Kind-Kategorien gesetzt, deren Kinder nicht geladen werden)","readOnly":true},"labels":{"type":"array","description":"Bezeichnung (mehrsprachig)","items":{"$ref":"#/components/schemas/common-masterdata-CategoryDescription"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierung"},"externalReference":{"type":"string","description":"Externe Referenz","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["labels","sortOrder"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CategoryDescription":{"description":"Mehrsprachige Kategorie-Bezeichnung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"Sprachcode (ISO 639-1)"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label","languageCode"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /cmn/category-tree/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CategoryTree","description":"Kategorie-Bäume verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/category-tree/{id}":{"delete":{"tags":["CategoryTree"],"summary":"Delete an existing Resource","operationId":"delete_135","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/category-tree/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CategoryTree","description":"Kategorie-Bäume verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/category-tree/{id}/deactivate":{"put":{"tags":["CategoryTree"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_71","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CategoryTree"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CategoryTree":{"description":"Kategorie-Baum","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-Category":{"description":"Kategorie","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"parentCategoryTreeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentCategoryRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"hasChildren":{"type":"boolean","description":"Hat untergeordnete Kategorien (nur bei Kind-Kategorien gesetzt, deren Kinder nicht geladen werden)","readOnly":true},"labels":{"type":"array","description":"Bezeichnung (mehrsprachig)","items":{"$ref":"#/components/schemas/common-masterdata-CategoryDescription"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierung"},"externalReference":{"type":"string","description":"Externe Referenz","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["labels","sortOrder"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CategoryDescription":{"description":"Mehrsprachige Kategorie-Bezeichnung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"Sprachcode (ISO 639-1)"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label","languageCode"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /cmn/category-tree/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CategoryTree","description":"Kategorie-Bäume verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/category-tree/{id}/activate":{"put":{"tags":["CategoryTree"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_71","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CategoryTree"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CategoryTree":{"description":"Kategorie-Baum","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-Category":{"description":"Kategorie","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"parentCategoryTreeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentCategoryRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"hasChildren":{"type":"boolean","description":"Hat untergeordnete Kategorien (nur bei Kind-Kategorien gesetzt, deren Kinder nicht geladen werden)","readOnly":true},"labels":{"type":"array","description":"Bezeichnung (mehrsprachig)","items":{"$ref":"#/components/schemas/common-masterdata-CategoryDescription"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierung"},"externalReference":{"type":"string","description":"Externe Referenz","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["labels","sortOrder"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CategoryDescription":{"description":"Mehrsprachige Kategorie-Bezeichnung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"Sprachcode (ISO 639-1)"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label","languageCode"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## POST /cmn/category-tree > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CategoryTree","description":"Kategorie-Bäume verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/category-tree":{"post":{"tags":["CategoryTree"],"summary":"Create new Resource","operationId":"create_136","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CategoryTree"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CategoryTree"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CategoryTree":{"description":"Kategorie-Baum","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-Category":{"description":"Kategorie","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"parentCategoryTreeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parentCategoryRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"childCategories":{"type":"array","description":"Untergeordnete Kategorien","items":{"$ref":"#/components/schemas/common-masterdata-Category"}},"hasChildren":{"type":"boolean","description":"Hat untergeordnete Kategorien (nur bei Kind-Kategorien gesetzt, deren Kinder nicht geladen werden)","readOnly":true},"labels":{"type":"array","description":"Bezeichnung (mehrsprachig)","items":{"$ref":"#/components/schemas/common-masterdata-CategoryDescription"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierung"},"externalReference":{"type":"string","description":"Externe Referenz","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv","readOnly":true}},"required":["labels","sortOrder"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-masterdata-CategoryDescription":{"description":"Mehrsprachige Kategorie-Bezeichnung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"languageCode":{"type":"string","description":"Sprachcode (ISO 639-1)"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label","languageCode"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` # Payment Templates Zahlungsvorlagen ## GET /erp/payments/templates/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentTemplates","description":"Zahlungsvorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/payments/templates/{id}":{"get":{"tags":["PaymentTemplates"],"summary":"Find an existing Resource by identifier","operationId":"getById_33","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-payment-PaymentTemplate"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-payment-PaymentTemplate":{"description":"Zahlungsvorlage zur Vorbelegung von Feldern in einer Zahlung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Zahlungsvorlage"},"description":{"type":"string","description":"Beschreibung der Zahlungsvorlage"},"defaultPaymentTemplate":{"type":"boolean","default":false,"description":"Standard-Zahlungsvorlage"},"batchPayment":{"type":"boolean","default":false,"description":"Sammelauftrag möglich"},"consolidateRecords":{"type":"boolean","default":false,"description":"Positionen je Empfänger zu einer Sammelposition zusammenfassen"},"alwaysUseDiscount1":{"type":"boolean","default":false,"description":"Skonto immer ziehen"},"manuallySetExecutionDate":{"type":"boolean","default":false,"description":"Ausführungsdatum manuell setzen"},"offsetCreditNotesBeforeDirectDebit":{"type":"boolean","default":false,"description":"Offene Gutschriften vor der Lastschrifterstellung mit den Rechnungen verrechnen (nur bei Vorlagentyp DIRECT_DEBIT erlaubt)"},"paymentTemplateType":{"type":"string","default":"PAYMENT_NOT_BOUND","description":"Typ der Zahlungsvorlage","enum":["PAYMENT_INVOICE","PAYMENT_CREDIT_NOTE","PAYMENT_NOT_BOUND","DIRECT_DEBIT"]},"paymentTemplateEntries":{"type":"array","description":"Die einzelnen Feldvorbelegungen der Zahlungsvorlage","items":{"$ref":"#/components/schemas/erp-payment-PaymentTemplateEntry"}}},"required":["label","paymentTemplateType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-payment-PaymentTemplateEntry":{"description":"Eintrag für eine Feldvorbelegung einer Zahlungsvorlage","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"fieldName":{"type":"string","description":"Feldname für Vorbelegung"},"value":{"type":"string","description":"Wert für Vorbelegung"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/payments/templates/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentTemplates","description":"Zahlungsvorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/payments/templates/{id}":{"put":{"tags":["PaymentTemplates"],"summary":"Update existing Resource ","operationId":"update_33","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-payment-PaymentTemplate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-payment-PaymentTemplate"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-payment-PaymentTemplate":{"description":"Zahlungsvorlage zur Vorbelegung von Feldern in einer Zahlung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Zahlungsvorlage"},"description":{"type":"string","description":"Beschreibung der Zahlungsvorlage"},"defaultPaymentTemplate":{"type":"boolean","default":false,"description":"Standard-Zahlungsvorlage"},"batchPayment":{"type":"boolean","default":false,"description":"Sammelauftrag möglich"},"consolidateRecords":{"type":"boolean","default":false,"description":"Positionen je Empfänger zu einer Sammelposition zusammenfassen"},"alwaysUseDiscount1":{"type":"boolean","default":false,"description":"Skonto immer ziehen"},"manuallySetExecutionDate":{"type":"boolean","default":false,"description":"Ausführungsdatum manuell setzen"},"offsetCreditNotesBeforeDirectDebit":{"type":"boolean","default":false,"description":"Offene Gutschriften vor der Lastschrifterstellung mit den Rechnungen verrechnen (nur bei Vorlagentyp DIRECT_DEBIT erlaubt)"},"paymentTemplateType":{"type":"string","default":"PAYMENT_NOT_BOUND","description":"Typ der Zahlungsvorlage","enum":["PAYMENT_INVOICE","PAYMENT_CREDIT_NOTE","PAYMENT_NOT_BOUND","DIRECT_DEBIT"]},"paymentTemplateEntries":{"type":"array","description":"Die einzelnen Feldvorbelegungen der Zahlungsvorlage","items":{"$ref":"#/components/schemas/erp-payment-PaymentTemplateEntry"}}},"required":["label","paymentTemplateType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-payment-PaymentTemplateEntry":{"description":"Eintrag für eine Feldvorbelegung einer Zahlungsvorlage","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"fieldName":{"type":"string","description":"Feldname für Vorbelegung"},"value":{"type":"string","description":"Wert für Vorbelegung"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/payments/templates/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentTemplates","description":"Zahlungsvorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/payments/templates/{id}":{"delete":{"tags":["PaymentTemplates"],"summary":"Delete an existing Resource","operationId":"delete_32","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/payments/templates > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentTemplates","description":"Zahlungsvorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/payments/templates":{"post":{"tags":["PaymentTemplates"],"summary":"Create new Resource","operationId":"create_31","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-payment-PaymentTemplate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-payment-PaymentTemplate"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-payment-PaymentTemplate":{"description":"Zahlungsvorlage zur Vorbelegung von Feldern in einer Zahlung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Zahlungsvorlage"},"description":{"type":"string","description":"Beschreibung der Zahlungsvorlage"},"defaultPaymentTemplate":{"type":"boolean","default":false,"description":"Standard-Zahlungsvorlage"},"batchPayment":{"type":"boolean","default":false,"description":"Sammelauftrag möglich"},"consolidateRecords":{"type":"boolean","default":false,"description":"Positionen je Empfänger zu einer Sammelposition zusammenfassen"},"alwaysUseDiscount1":{"type":"boolean","default":false,"description":"Skonto immer ziehen"},"manuallySetExecutionDate":{"type":"boolean","default":false,"description":"Ausführungsdatum manuell setzen"},"offsetCreditNotesBeforeDirectDebit":{"type":"boolean","default":false,"description":"Offene Gutschriften vor der Lastschrifterstellung mit den Rechnungen verrechnen (nur bei Vorlagentyp DIRECT_DEBIT erlaubt)"},"paymentTemplateType":{"type":"string","default":"PAYMENT_NOT_BOUND","description":"Typ der Zahlungsvorlage","enum":["PAYMENT_INVOICE","PAYMENT_CREDIT_NOTE","PAYMENT_NOT_BOUND","DIRECT_DEBIT"]},"paymentTemplateEntries":{"type":"array","description":"Die einzelnen Feldvorbelegungen der Zahlungsvorlage","items":{"$ref":"#/components/schemas/erp-payment-PaymentTemplateEntry"}}},"required":["label","paymentTemplateType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-payment-PaymentTemplateEntry":{"description":"Eintrag für eine Feldvorbelegung einer Zahlungsvorlage","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"fieldName":{"type":"string","description":"Feldname für Vorbelegung"},"value":{"type":"string","description":"Wert für Vorbelegung"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/payments/templates/get\_standard > gibt die Standard-Zahlungsträgervorlage für den angegeben Typ zurück ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentTemplates","description":"Zahlungsvorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/payments/templates/get_standard":{"get":{"tags":["PaymentTemplates"],"description":"gibt die Standard-Zahlungsträgervorlage für den angegeben Typ zurück","operationId":"findStandardForType","parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["PAYMENT_INVOICE","PAYMENT_CREDIT_NOTE","PAYMENT_NOT_BOUND","DIRECT_DEBIT"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-payment-PaymentTemplate"}}}}}}}},"components":{"schemas":{"erp-payment-PaymentTemplate":{"description":"Zahlungsvorlage zur Vorbelegung von Feldern in einer Zahlung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Zahlungsvorlage"},"description":{"type":"string","description":"Beschreibung der Zahlungsvorlage"},"defaultPaymentTemplate":{"type":"boolean","default":false,"description":"Standard-Zahlungsvorlage"},"batchPayment":{"type":"boolean","default":false,"description":"Sammelauftrag möglich"},"consolidateRecords":{"type":"boolean","default":false,"description":"Positionen je Empfänger zu einer Sammelposition zusammenfassen"},"alwaysUseDiscount1":{"type":"boolean","default":false,"description":"Skonto immer ziehen"},"manuallySetExecutionDate":{"type":"boolean","default":false,"description":"Ausführungsdatum manuell setzen"},"offsetCreditNotesBeforeDirectDebit":{"type":"boolean","default":false,"description":"Offene Gutschriften vor der Lastschrifterstellung mit den Rechnungen verrechnen (nur bei Vorlagentyp DIRECT_DEBIT erlaubt)"},"paymentTemplateType":{"type":"string","default":"PAYMENT_NOT_BOUND","description":"Typ der Zahlungsvorlage","enum":["PAYMENT_INVOICE","PAYMENT_CREDIT_NOTE","PAYMENT_NOT_BOUND","DIRECT_DEBIT"]},"paymentTemplateEntries":{"type":"array","description":"Die einzelnen Feldvorbelegungen der Zahlungsvorlage","items":{"$ref":"#/components/schemas/erp-payment-PaymentTemplateEntry"}}},"required":["label","paymentTemplateType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-payment-PaymentTemplateEntry":{"description":"Eintrag für eine Feldvorbelegung einer Zahlungsvorlage","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"fieldName":{"type":"string","description":"Feldname für Vorbelegung"},"value":{"type":"string","description":"Wert für Vorbelegung"}}}}}} ``` ## GET /erp/payments/templates/get\_available\_fields > gibt die Felder, die in einer Zahlungsvorlage verwendet werden können, zurück ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PaymentTemplates","description":"Zahlungsvorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/payments/templates/get_available_fields":{"get":{"tags":["PaymentTemplates"],"description":"gibt die Felder, die in einer Zahlungsvorlage verwendet werden können, zurück","operationId":"getAvailableFields","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-payment-PaymentTemplateField"}}}}}}}}},"components":{"schemas":{"erp-payment-PaymentTemplateField":{"properties":{"label":{"type":"string"},"fieldName":{"type":"string"}}}}}} ``` # Create Templates Vorlagen ## GET /cmn/create-templates/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CreateTemplates","description":"Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/create-templates/{id}":{"get":{"tags":["CreateTemplates"],"summary":"Find an existing Resource by identifier","operationId":"getById_153","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-create_template-CreateTemplate"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-create_template-CreateTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Domain"},"name":{"type":"string","description":"Name"},"standard":{"type":"boolean","default":false,"description":"Standard-Vorlage?"},"content":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["content","domain","name"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /cmn/create-templates/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CreateTemplates","description":"Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/create-templates/{id}":{"put":{"tags":["CreateTemplates"],"summary":"Update existing Resource ","operationId":"update_142","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-create_template-CreateTemplate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-create_template-CreateTemplate"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-create_template-CreateTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Domain"},"name":{"type":"string","description":"Name"},"standard":{"type":"boolean","default":false,"description":"Standard-Vorlage?"},"content":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["content","domain","name"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /cmn/create-templates/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CreateTemplates","description":"Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/create-templates/{id}":{"delete":{"tags":["CreateTemplates"],"summary":"Delete an existing Resource","operationId":"delete_129","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /cmn/create-templates > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CreateTemplates","description":"Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/create-templates":{"get":{"tags":["CreateTemplates"],"operationId":"getAll_9","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-create_template-CreateTemplate"}}}}}}}}},"components":{"schemas":{"common-create_template-CreateTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Domain"},"name":{"type":"string","description":"Name"},"standard":{"type":"boolean","default":false,"description":"Standard-Vorlage?"},"content":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["content","domain","name"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/create-templates > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CreateTemplates","description":"Vorlagen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/create-templates":{"post":{"tags":["CreateTemplates"],"summary":"Create new Resource","operationId":"create_130","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-create_template-CreateTemplate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-create_template-CreateTemplate"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-create_template-CreateTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Domain"},"name":{"type":"string","description":"Name"},"standard":{"type":"boolean","default":false,"description":"Standard-Vorlage?"},"content":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["content","domain","name"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` # Customs Measure customs measures ## GET /cmn/customs-measures/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CustomsMeasure","description":"customs measures"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/customs-measures/{id}":{"get":{"tags":["CustomsMeasure"],"summary":"Find an existing Resource by identifier","operationId":"getById_150","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CustomsMeasure"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CustomsMeasure":{"description":"Zollsatz zu Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"originCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"destinationCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"dutyRate":{"type":"number","description":"Zollsatz"},"penaltyDutyRate":{"type":"number","description":"Straf-Zollsatz"},"validFrom":{"type":"string","format":"date","description":"gültig ab"}},"required":["commodityCodeRef","destinationCountryCodeRef","dutyRate","originCountryCodeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/customs-measures/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CustomsMeasure","description":"customs measures"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/customs-measures/{id}":{"put":{"tags":["CustomsMeasure"],"summary":"Update existing Resource ","operationId":"update_139","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CustomsMeasure"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CustomsMeasure"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CustomsMeasure":{"description":"Zollsatz zu Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"originCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"destinationCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"dutyRate":{"type":"number","description":"Zollsatz"},"penaltyDutyRate":{"type":"number","description":"Straf-Zollsatz"},"validFrom":{"type":"string","format":"date","description":"gültig ab"}},"required":["commodityCodeRef","destinationCountryCodeRef","dutyRate","originCountryCodeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/customs-measures/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CustomsMeasure","description":"customs measures"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/customs-measures/{id}":{"delete":{"tags":["CustomsMeasure"],"summary":"Delete an existing Resource","operationId":"delete_126","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/customs-measures/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CustomsMeasure","description":"customs measures"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/customs-measures/{id}/deactivate":{"put":{"tags":["CustomsMeasure"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_64","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CustomsMeasure"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CustomsMeasure":{"description":"Zollsatz zu Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"originCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"destinationCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"dutyRate":{"type":"number","description":"Zollsatz"},"penaltyDutyRate":{"type":"number","description":"Straf-Zollsatz"},"validFrom":{"type":"string","format":"date","description":"gültig ab"}},"required":["commodityCodeRef","destinationCountryCodeRef","dutyRate","originCountryCodeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/customs-measures/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CustomsMeasure","description":"customs measures"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/customs-measures/{id}/activate":{"put":{"tags":["CustomsMeasure"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_64","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CustomsMeasure"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CustomsMeasure":{"description":"Zollsatz zu Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"originCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"destinationCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"dutyRate":{"type":"number","description":"Zollsatz"},"penaltyDutyRate":{"type":"number","description":"Straf-Zollsatz"},"validFrom":{"type":"string","format":"date","description":"gültig ab"}},"required":["commodityCodeRef","destinationCountryCodeRef","dutyRate","originCountryCodeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/customs-measures > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CustomsMeasure","description":"customs measures"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/customs-measures":{"post":{"tags":["CustomsMeasure"],"summary":"Create new Resource","operationId":"create_127","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CustomsMeasure"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CustomsMeasure"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CustomsMeasure":{"description":"Zollsatz zu Warennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"active","readOnly":true},"commodityCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"originCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"destinationCountryCodeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"dutyRate":{"type":"number","description":"Zollsatz"},"penaltyDutyRate":{"type":"number","description":"Straf-Zollsatz"},"validFrom":{"type":"string","format":"date","description":"gültig ab"}},"required":["commodityCodeRef","destinationCountryCodeRef","dutyRate","originCountryCodeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Workflow Instance the workflow instance API ## PUT /cmn/workflow-instances/{id}/resume > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkflowInstance","description":"the workflow instance API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/workflow-instances/{id}/resume":{"put":{"tags":["WorkflowInstance"],"operationId":"resumeWorkflowInstance","parameters":[{"name":"id","in":"path","description":"ID of workflow-instance","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## PUT /cmn/workflow-instances/{id}/kill > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkflowInstance","description":"the workflow instance API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/workflow-instances/{id}/kill":{"put":{"tags":["WorkflowInstance"],"operationId":"killWorkflowInstance","parameters":[{"name":"id","in":"path","description":"ID of workflow-instance","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## GET /cmn/workflow-instances/{id} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkflowInstance","description":"the workflow instance API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/workflow-instances/{id}":{"get":{"tags":["WorkflowInstance"],"operationId":"getById_126","parameters":[{"name":"id","in":"path","description":"ID einer Workflow-Instant","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}}}}}},"components":{"schemas":{"common-workflow-WorkflowInstance":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]},"workflowRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workItems":{"type":"array","description":"Schritte des Workflows","items":{"$ref":"#/components/schemas/common-workflow-WorkItem"}},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-workflow-WorkItem":{"description":"Schritte des Workflows","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Bearbeitungszustand eines Work-Items","enum":["OPEN","IN_PROCESS","COMPLETED","ERRONEOUS","ABORTED"]},"workflowElementRef":{"type":"integer","format":"int64","description":"Workflow-Element, das abgebildet wird"},"parentWorkItemRef":{"type":"integer","format":"int64","description":"Work-Item im übergeordneten Workflow, wenn es sich um einen Unter-Workflow handelt"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}},"splitResult":{"type":"string","description":"Für Split-Gateways: mit welchem Ergebnis wurde dieses Work-Item ausgeführt"}}},"common-workflow-WorkflowInstanceLogLine":{"description":"Logging-Einträge chronologisch sortiert","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"workflowInstanceId":{"type":"integer","format":"int64","description":"ID der Workflow-Instanz"},"workItemId":{"type":"integer","format":"int64","description":"ID des Work-Items"},"logTime":{"type":"string","format":"date-time","description":"Zeitstempel"},"origin":{"type":"string","description":"Wodurch wurde dieser Eintrag ausgelöst","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"message":{"type":"string","description":"Nachricht"},"messageKey":{"type":"string","description":"I18n-Key"},"propertyPath":{"type":"string","description":"Pfad"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"Parameter für die I18n-Nachricht"},"description":"Parameter für die I18n-Nachricht"}}}}}} ``` ## GET /cmn/workflow-instances/workflow-state/{referenceKey}/{referenceId} > Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkflowInstance","description":"the workflow instance API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/workflow-instances/workflow-state/{referenceKey}/{referenceId}":{"get":{"tags":["WorkflowInstance"],"summary":"Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz","operationId":"getWorkflowState_8","parameters":[{"name":"referenceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"referenceKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"application/json":{"schema":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}},"404":{"description":"Es existiert noch keine Workflow-Instanz","content":{"application/json":{"schema":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]}}}}}}}}} ``` ## GET /cmn/workflow-instances/workflow-instances-preset/{referenceKey}/{referenceId} > Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkflowInstance","description":"the workflow instance API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/workflow-instances/workflow-instances-preset/{referenceKey}/{referenceId}":{"get":{"tags":["WorkflowInstance"],"summary":"Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz","operationId":"getWorkflowInstancesPreset_8","parameters":[{"name":"referenceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"referenceKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-cunit-QueryPreset"}}}}}}}},"components":{"schemas":{"common-cunit-QueryPreset":{"description":"Adhoc Preset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"templateId":{"type":"string","description":"template dem dieser filter zugeordnet worden ist."},"templateGroupKey":{"type":"string","description":"templateGroupKey dem dieser filter zugeordnet worden ist."},"label":{"type":"string","description":"label für diesen filter"},"uiPayload":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variables":{"type":"array","description":"Variablen für dieses Preset","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"}},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"results":{"type":"array","description":"ergebnisse","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"sortAndOrders":{"type":"array","description":"sortierung","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetPageable"},"option":{"$ref":"#/components/schemas/common-cunit-QueryPresetOption"},"transformations":{"type":"array","description":"zusätzliche konfigurationen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetTransformation"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"definition":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]},"readOnly":true},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"},"forWorkflow":{"type":"boolean","default":false,"description":"für Workflows vorgesehen"},"outputReportGroupIdentifier":{"type":"string","description":"Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird"},"userOptions":{"$ref":"#/components/schemas/common-cunit-QueryPresetUserOptions"}},"required":["forWorkflow","label","mode","permissionAggregation","templateGroupKey","templateId"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"common-cunit-QueryPresetVariable":{"description":"Die zu ersetzende Variable","properties":{"path":{"type":"string","description":"Der pfad, der dieses Attribut eindeutig beschreibt"},"definition":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}],"readOnly":true},"mandatory":{"type":"boolean","description":"Ob die Variable ein Pflichtfeld ist oder nicht"},"variableName":{"type":"string","description":"Name der Variablen"},"visible":{"type":"boolean","default":true,"description":"Handelt es sich um eine sichtbare Variable?"},"alignX":{"type":"integer","format":"int32","description":"Anordnung im UI - X-Koordinate"},"alignY":{"type":"integer","format":"int32","description":"Anordnung im UI - Y-Koordinate"},"alignWidth":{"type":"integer","format":"int32","description":"Anordnung im UI - Breite"},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Eindeutiger Schlüssel zur Identifikation des Attributs"},"attribute":{"type":"string","description":"name des attributes der das ergebnis enthält"},"path":{"type":"string","description":"der pfad, der dieses attribut eindeutig beschreibt"},"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"parentDisplayName":{"type":"string","description":"der Name des Referenzierenden Feldes"},"resultable":{"type":"boolean","default":true,"description":"kann dieses Feld ein Ergebnisfeld sein"},"filterable":{"type":"boolean","default":true,"description":"kann nach diesem feld gefiltert werden"},"sortable":{"type":"boolean","default":true,"description":"ist dieses Feld sortierbar"},"visible":{"type":"boolean","default":true,"description":"soll dieses Feld angezeigt werden"},"functions":{"type":"array","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)","items":{"type":"string","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)"}},"sortDirection":{"type":"string","description":"Info, wie diese spalte sortiert worden ist"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"modelType":{"type":"string","description":"Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')","readOnly":true},"headers":{"type":"array","description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-MetaContent":{"description":"Definition dieser Variable","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]}}}},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"}}}]},"core-cunit-CuAttributeConstraint":{"description":"constraints für dieses Attribut","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"minimaler Wert","readOnly":true},"includeMinValue":{"type":"boolean","description":"ist der minimale Wert inklusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"maximaler Wert","readOnly":true},"includeMaxValue":{"type":"boolean","description":"ist der maximale Wert inklusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"ist der Wert 'null' verboten?","readOnly":true},"notBlank":{"type":"boolean","description":"Bei Strings: ist ein String nur aus Whitespace verboten?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximale Anzahl Nachkommastellen","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"data-type für dieses Attribut (falls dataTypeIdentifier leer ist)","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"welcher Typ ist es","readOnly":true},"objectRefIdentifier":{"type":"string","description":"bei Object_Ref: welcher Typ ist es genau","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"welche Funktionen sind erlaubt?","items":{"type":"string","description":"welche Funktionen sind erlaubt?"},"readOnly":true},"predicateOperations":{"type":"array","description":"welche Operations sind erlaubt?","items":{"type":"string","description":"welche Operations sind erlaubt?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit Attribut Filter Optionen","properties":{"filterValues":{"type":"array","description":"Mögliche Filterwerte","items":{"type":"string","description":"Mögliche Filterwerte"}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute.HeaderGroup":{"description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","properties":{"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Bedingungen zur Selektion von Lagerplätzen","properties":{"type":{"type":"string","description":"die Operation für diesen Filter","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"(bei junction) child-definitionen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"filter werte","items":{"type":"string","description":"filter werte"}},"visible":{"type":"boolean","default":true,"description":"Sichtbarkeit bei Variablen"},"functions":{"type":"array","description":"Eine SQL-Funktion, die im Predicate angewendet wird","items":{"type":"string","description":"Eine SQL-Funktion, die im Predicate angewendet wird"}}},"required":["operator","type"]},"common-cunit-QueryPresetResult":{"description":"Ergebnisse","properties":{"property":{"type":"string","description":"property"},"displayName":{"type":"string","description":"title dieser spalte"},"functions":{"type":"array","description":"funktionen","items":{"type":"string","description":"funktionen"}},"visible":{"type":"boolean","default":true,"description":"sichtbare Ergebnisspalte"}},"required":["property"]},"common-cunit-QueryPresetSortOrder":{"description":"sort and order anweisungen","properties":{"property":{"type":"string","description":"property"},"functions":{"type":"array","description":"Functions","items":{"type":"string","description":"Functions"}},"direction":{"type":"string","description":"sort order","enum":["ASC","DESC"]}},"required":["direction","property"]},"common-cunit-QueryPresetPageable":{"description":"pageable","properties":{"limit":{"type":"integer","format":"int64","description":"das Limit (MaxRecordCount) für diesen Query"}}},"common-cunit-QueryPresetOption":{"description":"options","properties":{"distinctResult":{"type":"boolean","description":"soll der Query mit einem Distinct durchgeführt werden"}}},"common-cunit-QueryPresetTransformation":{"description":"zusätzliche konfigurationen","properties":{"crossTable":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation"}}},"common-cunit-QueryPresetCrossTableTransformation":{"description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","properties":{"rowSpecs":{"type":"array","description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"columnSpecs":{"type":"array","description":"enthält die felder, die in der cross-table als dynamische spalten erstellt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"results":{"type":"array","description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell"}}},"required":["columnSpecs","results","rowSpecs"]},"common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell":{"description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","properties":{"result":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"cellView":{"type":"string","description":"darstellung der werte","enum":["AS_IS","PERCENT_COL"]},"sumColumn":{"type":"boolean","default":false,"description":"soll eine spaltensumme erzeugt werden"},"rowMode":{"type":"string","description":"soll eine zeilensumme erzeugt werden","enum":["DATA","DATA_AND_TOTAL","TOTAL"]},"aggregateFunction":{"type":"string","description":"die funktion mit der die werte der Zelle aggregiert werden"}}},"common-cunit-ArithmeticQueryTerm":{"description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","properties":{"termName":{"type":"string","description":"Der Name des Terms für die Verarbeitung und Darstellung"},"terms":{"type":"array","description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermInner"}},"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-cunit-ArithmeticQueryTermInner":{"description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","properties":{"fragment":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermFragment"},"attribute":{"type":"string","description":"Ein echtes Attribut aus dem Template"},"fixedValue":{"type":"number","description":"Ein Fixwert"}}},"common-cunit-ArithmeticQueryTermFragment":{"description":"Das Termfragment - eine weitere Verschachtelung mit eigenen Operationen","properties":{"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-cunit-QueryPresetUserOptions":{"description":"nutzerbezogene Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"pinned":{"type":"boolean","default":false,"description":"angepinnt?"}},"required":["pinned"]}}}} ``` ## GET /cmn/workflow-instances/latest-workflow-instance/{referenceKey}/{referenceId} > Liefert die neuste Workflow-Instanz zu der gegebenen Referenz ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkflowInstance","description":"the workflow instance API"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/workflow-instances/latest-workflow-instance/{referenceKey}/{referenceId}":{"get":{"tags":["WorkflowInstance"],"summary":"Liefert die neuste Workflow-Instanz zu der gegebenen Referenz","operationId":"getLatestWorkflowInstance_8","parameters":[{"name":"referenceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"referenceKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Workflow-Instanz gefunden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}},"404":{"description":"Es existiert noch keine Workflow-Instanz","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-workflow-WorkflowInstance"}}}}}}}},"components":{"schemas":{"common-workflow-WorkflowInstance":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Status einer Workflow-Instanz","enum":["CREATED","IN_PROCESS","COMPLETED_SUCCESSFULLY","COMPLETED_WITH_FAILURE","ERRONEOUS","ABORTED_CRASHED","ABORTED_MANUALLY","CRASHED","WAITING","INTERRUPTED"]},"workflowRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workItems":{"type":"array","description":"Schritte des Workflows","items":{"$ref":"#/components/schemas/common-workflow-WorkItem"}},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-workflow-WorkItem":{"description":"Schritte des Workflows","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Bearbeitungszustand eines Work-Items","enum":["OPEN","IN_PROCESS","COMPLETED","ERRONEOUS","ABORTED"]},"workflowElementRef":{"type":"integer","format":"int64","description":"Workflow-Element, das abgebildet wird"},"parentWorkItemRef":{"type":"integer","format":"int64","description":"Work-Item im übergeordneten Workflow, wenn es sich um einen Unter-Workflow handelt"},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"logEntries":{"type":"array","description":"Logging-Einträge chronologisch sortiert","items":{"$ref":"#/components/schemas/common-workflow-WorkflowInstanceLogLine"}},"splitResult":{"type":"string","description":"Für Split-Gateways: mit welchem Ergebnis wurde dieses Work-Item ausgeführt"}}},"common-workflow-WorkflowInstanceLogLine":{"description":"Logging-Einträge chronologisch sortiert","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"workflowInstanceId":{"type":"integer","format":"int64","description":"ID der Workflow-Instanz"},"workItemId":{"type":"integer","format":"int64","description":"ID des Work-Items"},"logTime":{"type":"string","format":"date-time","description":"Zeitstempel"},"origin":{"type":"string","description":"Wodurch wurde dieser Eintrag ausgelöst","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"]},"message":{"type":"string","description":"Nachricht"},"messageKey":{"type":"string","description":"I18n-Key"},"propertyPath":{"type":"string","description":"Pfad"},"messageParameter":{"type":"object","additionalProperties":{"type":"object","description":"Parameter für die I18n-Nachricht"},"description":"Parameter für die I18n-Nachricht"}}}}}} ``` # Verkaufskanal Lagerzuordnung Vorlagen für Verkaufskanal-Lagerzuordnung ## GET /erp/sales-channels/storage-schema/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Verkaufskanal-Lagerzuordnung","description":"Vorlagen für Verkaufskanal-Lagerzuordnung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/storage-schema/{id}":{"get":{"tags":["Verkaufskanal-Lagerzuordnung"],"summary":"Find an existing Resource by identifier","operationId":"getById_18","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorageSchema"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelStorageSchema":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/sales-channels/storage-schema/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Verkaufskanal-Lagerzuordnung","description":"Vorlagen für Verkaufskanal-Lagerzuordnung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/storage-schema/{id}":{"put":{"tags":["Verkaufskanal-Lagerzuordnung"],"summary":"Update existing Resource ","operationId":"update_17","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorageSchema"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorageSchema"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelStorageSchema":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/sales-channels/storage-schema/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Verkaufskanal-Lagerzuordnung","description":"Vorlagen für Verkaufskanal-Lagerzuordnung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/storage-schema/{id}":{"delete":{"tags":["Verkaufskanal-Lagerzuordnung"],"summary":"Delete an existing Resource","operationId":"delete_16","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/sales-channels/storage-schema/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Verkaufskanal-Lagerzuordnung","description":"Vorlagen für Verkaufskanal-Lagerzuordnung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/storage-schema/{id}/deactivate":{"put":{"tags":["Verkaufskanal-Lagerzuordnung"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_6","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorageSchema"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelStorageSchema":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/sales-channels/storage-schema/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Verkaufskanal-Lagerzuordnung","description":"Vorlagen für Verkaufskanal-Lagerzuordnung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/storage-schema/{id}/activate":{"put":{"tags":["Verkaufskanal-Lagerzuordnung"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_6","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorageSchema"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelStorageSchema":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/sales-channels/storage-schema > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Verkaufskanal-Lagerzuordnung","description":"Vorlagen für Verkaufskanal-Lagerzuordnung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/storage-schema":{"post":{"tags":["Verkaufskanal-Lagerzuordnung"],"summary":"Create new Resource","operationId":"create_16","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorageSchema"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorageSchema"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelStorageSchema":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Pos Payment Consumer POS-Payment-Consumer verwalten ## PUT /erp/pos/payment/consumer/{id}/rule-value > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer/{id}/rule-value":{"put":{"tags":["PosPaymentConsumer"],"operationId":"updateRuleValue","parameters":[{"name":"id","in":"path","description":"ID des Payment-Consumers","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK"}}}}}} ``` ## PUT /erp/pos/payment/consumer/{id}/request-refresh > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer/{id}/request-refresh":{"put":{"tags":["PosPaymentConsumer"],"operationId":"requestRefresh","parameters":[{"name":"id","in":"path","description":"ID des Payment-Consumers","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## PUT /erp/pos/payment/consumer/{id}/heart-beat > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer/{id}/heart-beat":{"put":{"tags":["PosPaymentConsumer"],"operationId":"doHeartbeat","parameters":[{"name":"id","in":"path","description":"ID des Payment-Consumers","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## PUT /erp/pos/payment/consumer/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer/{id}/deactivate":{"put":{"tags":["PosPaymentConsumer"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_47","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentConsumer"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentConsumer":{"description":"POS-Payment-Consumer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":1000,"minLength":0},"pushMode":{"type":"string","description":"Push-Modus für POS-Payment-Consumer","enum":["NONE","LOCAL_EVENT","WEBSOCKET","WEBHOOK"]},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"ruleValue":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"lastSeenAt":{"type":"string","format":"date-time","description":"Zeitpunkt des letzten Heartbeats","readOnly":true}},"required":["label","pushMode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/pos/payment/consumer/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer/{id}/activate":{"put":{"tags":["PosPaymentConsumer"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_47","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentConsumer"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentConsumer":{"description":"POS-Payment-Consumer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":1000,"minLength":0},"pushMode":{"type":"string","description":"Push-Modus für POS-Payment-Consumer","enum":["NONE","LOCAL_EVENT","WEBSOCKET","WEBHOOK"]},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"ruleValue":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"lastSeenAt":{"type":"string","format":"date-time","description":"Zeitpunkt des letzten Heartbeats","readOnly":true}},"required":["label","pushMode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## GET /erp/pos/payment/consumer/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer/{id}":{"get":{"tags":["PosPaymentConsumer"],"summary":"Find an existing Resource by identifier","operationId":"getById_104","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentConsumer"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentConsumer":{"description":"POS-Payment-Consumer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":1000,"minLength":0},"pushMode":{"type":"string","description":"Push-Modus für POS-Payment-Consumer","enum":["NONE","LOCAL_EVENT","WEBSOCKET","WEBHOOK"]},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"ruleValue":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"lastSeenAt":{"type":"string","format":"date-time","description":"Zeitpunkt des letzten Heartbeats","readOnly":true}},"required":["label","pushMode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/pos/payment/consumer/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer/{id}":{"put":{"tags":["PosPaymentConsumer"],"summary":"Update existing Resource ","operationId":"update_97","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentConsumer"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentConsumer"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentConsumer":{"description":"POS-Payment-Consumer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":1000,"minLength":0},"pushMode":{"type":"string","description":"Push-Modus für POS-Payment-Consumer","enum":["NONE","LOCAL_EVENT","WEBSOCKET","WEBHOOK"]},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"ruleValue":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"lastSeenAt":{"type":"string","format":"date-time","description":"Zeitpunkt des letzten Heartbeats","readOnly":true}},"required":["label","pushMode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /erp/pos/payment/consumer/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer/{id}":{"delete":{"tags":["PosPaymentConsumer"],"summary":"Delete an existing Resource","operationId":"delete_90","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/pos/payment/consumer/{id}/request-next > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer/{id}/request-next":{"post":{"tags":["PosPaymentConsumer"],"operationId":"requestNextOrder","parameters":[{"name":"id","in":"path","description":"ID des Payment-Consumers","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentOrder"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentOrder":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"amount":{"type":"number","description":"Betrag der Zahlung"},"currency":{"type":"string","description":"Währung (ISO Alpha-3)"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID vom Backend","maxLength":255,"minLength":0},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend","maxLength":1000,"minLength":0},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung","maxLength":255,"minLength":0},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentConsumerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"ruleResult":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["amount"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/pos/payment/consumer > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"PosPaymentConsumer","description":"POS-Payment-Consumer verwalten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/payment/consumer":{"post":{"tags":["PosPaymentConsumer"],"summary":"Create new Resource","operationId":"create_93","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentConsumer"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-PosPaymentConsumer"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-PosPaymentConsumer":{"description":"POS-Payment-Consumer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":1000,"minLength":0},"pushMode":{"type":"string","description":"Push-Modus für POS-Payment-Consumer","enum":["NONE","LOCAL_EVENT","WEBSOCKET","WEBHOOK"]},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"ruleValue":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"lastSeenAt":{"type":"string","format":"date-time","description":"Zeitpunkt des letzten Heartbeats","readOnly":true}},"required":["label","pushMode"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` # System System Resource ## GET /cmn/systems/messages/ > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"System","description":"System Resource"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/systems/messages/":{"get":{"tags":["System"],"operationId":"getCodes","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}}}}}}},"components":{"schemas":{"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /cmn/systems/licenses/ > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"System","description":"System Resource"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/systems/licenses/":{"get":{"tags":["System"],"operationId":"getAllLicenses","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/core-product-AvailableLicense"}}}}}}}}},"components":{"schemas":{"core-product-AvailableLicense":{"properties":{"licenseKey":{"type":"string","description":"der valide lizenz-key"},"licenseValidTo":{"type":"string","format":"date","description":"Bei Testlizenzen -> valide bis"}}}}}} ``` # Skript Modul Skript-Modul ## GET /cmn/scripting/modules/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Skript-Modul","description":"Skript-Modul"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/scripting/modules/{id}":{"get":{"tags":["Skript-Modul"],"summary":"Find an existing Resource by identifier","operationId":"getById_140","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-scripting-ScriptModule":{"description":"Skript-Modul","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Verwendungsbereiche für die Skriptmodule","enum":["UNDEFINED","LIBRARY","APP","IMPORT_BATCH_PROCESSING","WORKFLOW_INTERMEDIATE_EVENT","WORKFLOW_SCRIPT","WORKFLOW_SPLIT_GATEWAY"]},"name":{"type":"string","description":"Name","maxLength":255,"minLength":0,"pattern":"[a-zA-Z0-9_-]*"},"description":{"type":"string","description":"Beschreibung"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"script":{"type":"string","description":"Skript"},"sameAsPresettingScript":{"type":"boolean","default":false,"description":"Entspricht das Skript dem Presetting-Skript?","readOnly":true},"withPresettingScript":{"type":"boolean","default":false,"description":"Gibt es ein Presetting-Skript?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Parameter, welche im Skript-Modul verwendet werden","items":{"$ref":"#/components/schemas/common-scripting-ScriptModuleParameter"}},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["domain","name","permissionAggregation","script"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-scripting-ScriptModuleParameter":{"description":"Skript-Modul-Parameter","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name des Parameters","maxLength":255,"minLength":0},"valueType":{"type":"string","description":"Typ des Parameters","maxLength":255,"minLength":0}},"required":["name","valueType"]},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/scripting/modules/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Skript-Modul","description":"Skript-Modul"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/scripting/modules/{id}":{"put":{"tags":["Skript-Modul"],"summary":"Update existing Resource ","operationId":"update_129","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-scripting-ScriptModule":{"description":"Skript-Modul","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Verwendungsbereiche für die Skriptmodule","enum":["UNDEFINED","LIBRARY","APP","IMPORT_BATCH_PROCESSING","WORKFLOW_INTERMEDIATE_EVENT","WORKFLOW_SCRIPT","WORKFLOW_SPLIT_GATEWAY"]},"name":{"type":"string","description":"Name","maxLength":255,"minLength":0,"pattern":"[a-zA-Z0-9_-]*"},"description":{"type":"string","description":"Beschreibung"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"script":{"type":"string","description":"Skript"},"sameAsPresettingScript":{"type":"boolean","default":false,"description":"Entspricht das Skript dem Presetting-Skript?","readOnly":true},"withPresettingScript":{"type":"boolean","default":false,"description":"Gibt es ein Presetting-Skript?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Parameter, welche im Skript-Modul verwendet werden","items":{"$ref":"#/components/schemas/common-scripting-ScriptModuleParameter"}},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["domain","name","permissionAggregation","script"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-scripting-ScriptModuleParameter":{"description":"Skript-Modul-Parameter","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name des Parameters","maxLength":255,"minLength":0},"valueType":{"type":"string","description":"Typ des Parameters","maxLength":255,"minLength":0}},"required":["name","valueType"]},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/scripting/modules/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Skript-Modul","description":"Skript-Modul"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/scripting/modules/{id}":{"delete":{"tags":["Skript-Modul"],"summary":"Delete an existing Resource","operationId":"delete_118","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /cmn/scripting/modules/{id}/presettings > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Skript-Modul","description":"Skript-Modul"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/scripting/modules/{id}/presettings":{"get":{"tags":["Skript-Modul"],"operationId":"getPresetting","parameters":[{"name":"id","in":"path","description":"ID eines Skript-Moduls","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}}}}}}},"components":{"schemas":{"common-scripting-ScriptModule":{"description":"Skript-Modul","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Verwendungsbereiche für die Skriptmodule","enum":["UNDEFINED","LIBRARY","APP","IMPORT_BATCH_PROCESSING","WORKFLOW_INTERMEDIATE_EVENT","WORKFLOW_SCRIPT","WORKFLOW_SPLIT_GATEWAY"]},"name":{"type":"string","description":"Name","maxLength":255,"minLength":0,"pattern":"[a-zA-Z0-9_-]*"},"description":{"type":"string","description":"Beschreibung"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"script":{"type":"string","description":"Skript"},"sameAsPresettingScript":{"type":"boolean","default":false,"description":"Entspricht das Skript dem Presetting-Skript?","readOnly":true},"withPresettingScript":{"type":"boolean","default":false,"description":"Gibt es ein Presetting-Skript?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Parameter, welche im Skript-Modul verwendet werden","items":{"$ref":"#/components/schemas/common-scripting-ScriptModuleParameter"}},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["domain","name","permissionAggregation","script"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-scripting-ScriptModuleParameter":{"description":"Skript-Modul-Parameter","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name des Parameters","maxLength":255,"minLength":0},"valueType":{"type":"string","description":"Typ des Parameters","maxLength":255,"minLength":0}},"required":["name","valueType"]},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}}}}} ``` ## PUT /cmn/scripting/modules/{id}/presettings > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Skript-Modul","description":"Skript-Modul"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/scripting/modules/{id}/presettings":{"put":{"tags":["Skript-Modul"],"operationId":"updatePresetting","parameters":[{"name":"id","in":"path","description":"ID eines Skript-Moduls","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}}}}}}},"components":{"schemas":{"common-scripting-ScriptModule":{"description":"Skript-Modul","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Verwendungsbereiche für die Skriptmodule","enum":["UNDEFINED","LIBRARY","APP","IMPORT_BATCH_PROCESSING","WORKFLOW_INTERMEDIATE_EVENT","WORKFLOW_SCRIPT","WORKFLOW_SPLIT_GATEWAY"]},"name":{"type":"string","description":"Name","maxLength":255,"minLength":0,"pattern":"[a-zA-Z0-9_-]*"},"description":{"type":"string","description":"Beschreibung"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"script":{"type":"string","description":"Skript"},"sameAsPresettingScript":{"type":"boolean","default":false,"description":"Entspricht das Skript dem Presetting-Skript?","readOnly":true},"withPresettingScript":{"type":"boolean","default":false,"description":"Gibt es ein Presetting-Skript?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Parameter, welche im Skript-Modul verwendet werden","items":{"$ref":"#/components/schemas/common-scripting-ScriptModuleParameter"}},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["domain","name","permissionAggregation","script"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-scripting-ScriptModuleParameter":{"description":"Skript-Modul-Parameter","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name des Parameters","maxLength":255,"minLength":0},"valueType":{"type":"string","description":"Typ des Parameters","maxLength":255,"minLength":0}},"required":["name","valueType"]},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}}}}} ``` ## PUT /cmn/scripting/modules/{id}/presettings/reset > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Skript-Modul","description":"Skript-Modul"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/scripting/modules/{id}/presettings/reset":{"put":{"tags":["Skript-Modul"],"operationId":"resetPresetting","parameters":[{"name":"id","in":"path","description":"ID eines Skript-Moduls","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}}}}}}},"components":{"schemas":{"common-scripting-ScriptModule":{"description":"Skript-Modul","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Verwendungsbereiche für die Skriptmodule","enum":["UNDEFINED","LIBRARY","APP","IMPORT_BATCH_PROCESSING","WORKFLOW_INTERMEDIATE_EVENT","WORKFLOW_SCRIPT","WORKFLOW_SPLIT_GATEWAY"]},"name":{"type":"string","description":"Name","maxLength":255,"minLength":0,"pattern":"[a-zA-Z0-9_-]*"},"description":{"type":"string","description":"Beschreibung"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"script":{"type":"string","description":"Skript"},"sameAsPresettingScript":{"type":"boolean","default":false,"description":"Entspricht das Skript dem Presetting-Skript?","readOnly":true},"withPresettingScript":{"type":"boolean","default":false,"description":"Gibt es ein Presetting-Skript?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Parameter, welche im Skript-Modul verwendet werden","items":{"$ref":"#/components/schemas/common-scripting-ScriptModuleParameter"}},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["domain","name","permissionAggregation","script"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-scripting-ScriptModuleParameter":{"description":"Skript-Modul-Parameter","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name des Parameters","maxLength":255,"minLength":0},"valueType":{"type":"string","description":"Typ des Parameters","maxLength":255,"minLength":0}},"required":["name","valueType"]},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}}}}} ``` ## POST /cmn/scripting/modules > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Skript-Modul","description":"Skript-Modul"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/scripting/modules":{"post":{"tags":["Skript-Modul"],"summary":"Create new Resource","operationId":"create_119","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-scripting-ScriptModule":{"description":"Skript-Modul","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Verwendungsbereiche für die Skriptmodule","enum":["UNDEFINED","LIBRARY","APP","IMPORT_BATCH_PROCESSING","WORKFLOW_INTERMEDIATE_EVENT","WORKFLOW_SCRIPT","WORKFLOW_SPLIT_GATEWAY"]},"name":{"type":"string","description":"Name","maxLength":255,"minLength":0,"pattern":"[a-zA-Z0-9_-]*"},"description":{"type":"string","description":"Beschreibung"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"script":{"type":"string","description":"Skript"},"sameAsPresettingScript":{"type":"boolean","default":false,"description":"Entspricht das Skript dem Presetting-Skript?","readOnly":true},"withPresettingScript":{"type":"boolean","default":false,"description":"Gibt es ein Presetting-Skript?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Parameter, welche im Skript-Modul verwendet werden","items":{"$ref":"#/components/schemas/common-scripting-ScriptModuleParameter"}},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["domain","name","permissionAggregation","script"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-scripting-ScriptModuleParameter":{"description":"Skript-Modul-Parameter","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name des Parameters","maxLength":255,"minLength":0},"valueType":{"type":"string","description":"Typ des Parameters","maxLength":255,"minLength":0}},"required":["name","valueType"]},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/scripting/modules/presettings > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Skript-Modul","description":"Skript-Modul"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/scripting/modules/presettings":{"post":{"tags":["Skript-Modul"],"operationId":"createPresetting","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-scripting-ScriptModule"}}}}}}}},"components":{"schemas":{"common-scripting-ScriptModule":{"description":"Skript-Modul","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"domain":{"type":"string","description":"Verwendungsbereiche für die Skriptmodule","enum":["UNDEFINED","LIBRARY","APP","IMPORT_BATCH_PROCESSING","WORKFLOW_INTERMEDIATE_EVENT","WORKFLOW_SCRIPT","WORKFLOW_SPLIT_GATEWAY"]},"name":{"type":"string","description":"Name","maxLength":255,"minLength":0,"pattern":"[a-zA-Z0-9_-]*"},"description":{"type":"string","description":"Beschreibung"},"appIdentifier":{"type":"string","format":"uuid","description":"Identifier der App"},"script":{"type":"string","description":"Skript"},"sameAsPresettingScript":{"type":"boolean","default":false,"description":"Entspricht das Skript dem Presetting-Skript?","readOnly":true},"withPresettingScript":{"type":"boolean","default":false,"description":"Gibt es ein Presetting-Skript?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"parameters":{"type":"array","description":"Parameter, welche im Skript-Modul verwendet werden","items":{"$ref":"#/components/schemas/common-scripting-ScriptModuleParameter"}},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"}},"required":["domain","name","permissionAggregation","script"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-scripting-ScriptModuleParameter":{"description":"Skript-Modul-Parameter","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name des Parameters","maxLength":255,"minLength":0},"valueType":{"type":"string","description":"Typ des Parameters","maxLength":255,"minLength":0}},"required":["name","valueType"]},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}}}}} ``` # Leasable Lock (Zeitlich begrenzbare) Sperren für Entitäten/Vorgänge ## PUT /cmn/leasable-locks/{token} > Verlängert eine Sperre ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"LeasableLock","description":"(Zeitlich begrenzbare) Sperren für Entitäten/Vorgänge"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/leasable-locks/{token}":{"put":{"tags":["LeasableLock"],"summary":"Verlängert eine Sperre","operationId":"refreshLeasableLock_4","parameters":[{"name":"token","in":"path","description":"Token einer Sperre","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"leasePeriod","in":"query","description":"Lease-Dauer in Sekunden","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-locknlease-LeasableLockDto"}}}}}}}},"components":{"schemas":{"common-locknlease-LeasableLockDto":{"properties":{"key":{"type":"string","description":"Key des Locks","readOnly":true},"token":{"type":"integer","format":"int64","description":"Token des Locks","readOnly":true},"user":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"lockedBySystem":{"type":"boolean","default":false,"description":"Wurde diese Sperre vom System erzeugt?","readOnly":true},"validUntil":{"type":"string","format":"date-time","description":"Ablaufuhrzeit","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## DELETE /cmn/leasable-locks/{token} > Gibt eine Sperre automatisch frei, gesteuert vom Frontend ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"LeasableLock","description":"(Zeitlich begrenzbare) Sperren für Entitäten/Vorgänge"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/leasable-locks/{token}":{"delete":{"tags":["LeasableLock"],"summary":"Gibt eine Sperre automatisch frei, gesteuert vom Frontend","operationId":"removeLock","parameters":[{"name":"token","in":"path","description":"Token einer Sperre","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## GET /cmn/leasable-locks > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"LeasableLock","description":"(Zeitlich begrenzbare) Sperren für Entitäten/Vorgänge"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/leasable-locks":{"get":{"tags":["LeasableLock"],"operationId":"getAllActiveLocks","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-locknlease-LeasableLockDto"}}}}}}}}},"components":{"schemas":{"common-locknlease-LeasableLockDto":{"properties":{"key":{"type":"string","description":"Key des Locks","readOnly":true},"token":{"type":"integer","format":"int64","description":"Token des Locks","readOnly":true},"user":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"lockedBySystem":{"type":"boolean","default":false,"description":"Wurde diese Sperre vom System erzeugt?","readOnly":true},"validUntil":{"type":"string","format":"date-time","description":"Ablaufuhrzeit","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## DELETE /cmn/leasable-locks/custom/{token} > Gibt eine Sperre manuell frei, z.B. über Systemeinstellungen ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"LeasableLock","description":"(Zeitlich begrenzbare) Sperren für Entitäten/Vorgänge"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/leasable-locks/custom/{token}":{"delete":{"tags":["LeasableLock"],"summary":"Gibt eine Sperre manuell frei, z.B. über Systemeinstellungen","operationId":"customRemoveLock","parameters":[{"name":"token","in":"path","description":"Token einer Sperre","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` # Sales Channel Verkaufskanäle bearbeiten ## PUT /erp/sales-channels/{salesChannelId}/tss/register > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/tss/register":{"put":{"tags":["SalesChannel"],"operationId":"registerTss","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-TssAdminPuk"}}}}}}}},"components":{"schemas":{"erp-pos-TssAdminPuk":{"description":"Request zum Ändern des TSS-Pins","properties":{"adminPuk":{"type":"string","description":"Admin-PUK für die TSS"},"newAdminPin":{"type":"string","description":"Neuer Admin-PIN für die TSS"}},"required":["adminPuk"]}}}} ``` ## PUT /erp/sales-channels/{salesChannelId}/tss/initialize > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/tss/initialize":{"put":{"tags":["SalesChannel"],"operationId":"initializeTss","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-TssAdminPin"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","enum":["CREATED","UNINITIALIZED","INITIALIZED","DISABLED","DELETED","DEFECTIVE","EVICTED"]}}}}}}}},"components":{"schemas":{"erp-pos-TssAdminPin":{"description":"Request für TSS-Admin-Operationen","properties":{"adminPin":{"type":"string","description":"Admin-PIN für die TSS"}},"required":["adminPin"]}}}} ``` ## PUT /erp/sales-channels/{salesChannelId}/tss/deregister > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/tss/deregister":{"put":{"tags":["SalesChannel"],"operationId":"deregisterTss","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-TssAdminPin"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","enum":["CREATED","UNINITIALIZED","INITIALIZED","DISABLED","DELETED","DEFECTIVE","EVICTED"]}}}}}}}},"components":{"schemas":{"erp-pos-TssAdminPin":{"description":"Request für TSS-Admin-Operationen","properties":{"adminPin":{"type":"string","description":"Admin-PIN für die TSS"}},"required":["adminPin"]}}}} ``` ## PUT /erp/sales-channels/{salesChannelId}/tss/deploy > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/tss/deploy":{"put":{"tags":["SalesChannel"],"operationId":"deployTss","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","enum":["CREATED","UNINITIALIZED","INITIALIZED","DISABLED","DELETED","DEFECTIVE","EVICTED"]}}}}}}}}} ``` ## PUT /erp/sales-channels/{salesChannelId}/tss/changePin > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/tss/changePin":{"put":{"tags":["SalesChannel"],"operationId":"changePin","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-TssAdminPuk"}}},"required":true},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"erp-pos-TssAdminPuk":{"description":"Request zum Ändern des TSS-Pins","properties":{"adminPuk":{"type":"string","description":"Admin-PUK für die TSS"},"newAdminPin":{"type":"string","description":"Neuer Admin-PIN für die TSS"}},"required":["adminPuk"]}}}} ``` ## PUT /erp/sales-channels/{salesChannelId}/storage/{storageId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/storage/{storageId}":{"put":{"tags":["SalesChannel"],"operationId":"updateSalesChannelStorage","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"storageId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## DELETE /erp/sales-channels/{salesChannelId}/storage/{storageId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/storage/{storageId}":{"delete":{"tags":["SalesChannel"],"operationId":"deleteSalesChannelStorage","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"storageId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}}}}} ``` ## PUT /erp/sales-channels/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{id}/deactivate":{"put":{"tags":["SalesChannel"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_44","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannel"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannel":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"ist dieser channel aktiv"},"channelType":{"type":"string","description":"typ/klassifizierung des sales channel","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]},"channelBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"discountFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"calculationMode":{"type":"string","description":"calculation mode of this sales channel","enum":["HORIZONTAL","VERTICAL"]},"roundingMode":{"type":"string","default":"NONE","description":"Endbetragsrundung","enum":["NONE","SWITZERLAND"]},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"defaultSalesChannel":{"type":"boolean","description":"Standard-Verkaufskanal"},"blockManualInvoiceTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Rechnung unterbinden"},"blockManualCreditNoteTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Gutschrift unterbinden"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessRelationType":{"type":"string","description":"Geschäftsbeziehungs-Typen für Geschäftspartner","enum":["B2B","B2C","B2G"]},"categoryTree":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalReferences":{"type":"string","description":"Externe Referenzen","readOnly":true},"tssExportState":{"type":"string","description":"TSS-Export-Zustand","enum":["PENDING","FINISHED"],"readOnly":true},"lastTssExportDate":{"type":"string","format":"date","description":"Letzter TSS-Export-Tag","readOnly":true},"pendingTssExportDateEnd":{"type":"string","format":"date","description":"Aktuell laufender TSS-Export bis","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/sales-channels/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{id}/activate":{"put":{"tags":["SalesChannel"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_44","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannel"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannel":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"ist dieser channel aktiv"},"channelType":{"type":"string","description":"typ/klassifizierung des sales channel","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]},"channelBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"discountFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"calculationMode":{"type":"string","description":"calculation mode of this sales channel","enum":["HORIZONTAL","VERTICAL"]},"roundingMode":{"type":"string","default":"NONE","description":"Endbetragsrundung","enum":["NONE","SWITZERLAND"]},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"defaultSalesChannel":{"type":"boolean","description":"Standard-Verkaufskanal"},"blockManualInvoiceTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Rechnung unterbinden"},"blockManualCreditNoteTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Gutschrift unterbinden"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessRelationType":{"type":"string","description":"Geschäftsbeziehungs-Typen für Geschäftspartner","enum":["B2B","B2C","B2G"]},"categoryTree":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalReferences":{"type":"string","description":"Externe Referenzen","readOnly":true},"tssExportState":{"type":"string","description":"TSS-Export-Zustand","enum":["PENDING","FINISHED"],"readOnly":true},"lastTssExportDate":{"type":"string","format":"date","description":"Letzter TSS-Export-Tag","readOnly":true},"pendingTssExportDateEnd":{"type":"string","format":"date","description":"Aktuell laufender TSS-Export bis","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## GET /erp/sales-channels/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{id}":{"get":{"tags":["SalesChannel"],"summary":"Find an existing Resource by identifier","operationId":"getById_100","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannel"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannel":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"ist dieser channel aktiv"},"channelType":{"type":"string","description":"typ/klassifizierung des sales channel","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]},"channelBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"discountFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"calculationMode":{"type":"string","description":"calculation mode of this sales channel","enum":["HORIZONTAL","VERTICAL"]},"roundingMode":{"type":"string","default":"NONE","description":"Endbetragsrundung","enum":["NONE","SWITZERLAND"]},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"defaultSalesChannel":{"type":"boolean","description":"Standard-Verkaufskanal"},"blockManualInvoiceTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Rechnung unterbinden"},"blockManualCreditNoteTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Gutschrift unterbinden"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessRelationType":{"type":"string","description":"Geschäftsbeziehungs-Typen für Geschäftspartner","enum":["B2B","B2C","B2G"]},"categoryTree":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalReferences":{"type":"string","description":"Externe Referenzen","readOnly":true},"tssExportState":{"type":"string","description":"TSS-Export-Zustand","enum":["PENDING","FINISHED"],"readOnly":true},"lastTssExportDate":{"type":"string","format":"date","description":"Letzter TSS-Export-Tag","readOnly":true},"pendingTssExportDateEnd":{"type":"string","format":"date","description":"Aktuell laufender TSS-Export bis","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/sales-channels/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{id}":{"put":{"tags":["SalesChannel"],"summary":"Update existing Resource ","operationId":"update_93","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannel"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannel"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannel":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"ist dieser channel aktiv"},"channelType":{"type":"string","description":"typ/klassifizierung des sales channel","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]},"channelBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"discountFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"calculationMode":{"type":"string","description":"calculation mode of this sales channel","enum":["HORIZONTAL","VERTICAL"]},"roundingMode":{"type":"string","default":"NONE","description":"Endbetragsrundung","enum":["NONE","SWITZERLAND"]},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"defaultSalesChannel":{"type":"boolean","description":"Standard-Verkaufskanal"},"blockManualInvoiceTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Rechnung unterbinden"},"blockManualCreditNoteTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Gutschrift unterbinden"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessRelationType":{"type":"string","description":"Geschäftsbeziehungs-Typen für Geschäftspartner","enum":["B2B","B2C","B2G"]},"categoryTree":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalReferences":{"type":"string","description":"Externe Referenzen","readOnly":true},"tssExportState":{"type":"string","description":"TSS-Export-Zustand","enum":["PENDING","FINISHED"],"readOnly":true},"lastTssExportDate":{"type":"string","format":"date","description":"Letzter TSS-Export-Tag","readOnly":true},"pendingTssExportDateEnd":{"type":"string","format":"date","description":"Aktuell laufender TSS-Export bis","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /erp/sales-channels/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{id}":{"delete":{"tags":["SalesChannel"],"summary":"Delete an existing Resource","operationId":"delete_86","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/sales-channels/backend/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/backend/{id}/deactivate":{"put":{"tags":["SalesChannel"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_45","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"validChannelTypes":{"type":"array","description":"Erlaubte typen","items":{"type":"string","description":"Erlaubte typen","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]}}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/sales-channels/backend/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/backend/{id}/activate":{"put":{"tags":["SalesChannel"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_45","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"validChannelTypes":{"type":"array","description":"Erlaubte typen","items":{"type":"string","description":"Erlaubte typen","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]}}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/sales-channels/backend/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/backend/{id}":{"get":{"tags":["SalesChannel"],"summary":"Find an existing Resource by identifier","operationId":"getById_101","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelBackend"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"validChannelTypes":{"type":"array","description":"Erlaubte typen","items":{"type":"string","description":"Erlaubte typen","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]}}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/sales-channels/backend/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/backend/{id}":{"put":{"tags":["SalesChannel"],"summary":"Update existing Resource ","operationId":"update_94","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelBackend"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelBackend"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"validChannelTypes":{"type":"array","description":"Erlaubte typen","items":{"type":"string","description":"Erlaubte typen","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]}}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/sales-channels/backend/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/backend/{id}":{"delete":{"tags":["SalesChannel"],"summary":"Delete an existing Resource","operationId":"delete_87","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/sales-channels/{salesChannelId}/storage/assign-schema/{schemaId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/storage/assign-schema/{schemaId}":{"post":{"tags":["SalesChannel"],"operationId":"assignStorageSchema","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"schemaId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannel"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannel":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"ist dieser channel aktiv"},"channelType":{"type":"string","description":"typ/klassifizierung des sales channel","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]},"channelBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"discountFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"calculationMode":{"type":"string","description":"calculation mode of this sales channel","enum":["HORIZONTAL","VERTICAL"]},"roundingMode":{"type":"string","default":"NONE","description":"Endbetragsrundung","enum":["NONE","SWITZERLAND"]},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"defaultSalesChannel":{"type":"boolean","description":"Standard-Verkaufskanal"},"blockManualInvoiceTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Rechnung unterbinden"},"blockManualCreditNoteTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Gutschrift unterbinden"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessRelationType":{"type":"string","description":"Geschäftsbeziehungs-Typen für Geschäftspartner","enum":["B2B","B2C","B2G"]},"categoryTree":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalReferences":{"type":"string","description":"Externe Referenzen","readOnly":true},"tssExportState":{"type":"string","description":"TSS-Export-Zustand","enum":["PENDING","FINISHED"],"readOnly":true},"lastTssExportDate":{"type":"string","format":"date","description":"Letzter TSS-Export-Tag","readOnly":true},"pendingTssExportDateEnd":{"type":"string","format":"date","description":"Aktuell laufender TSS-Export bis","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/sales-channels/{salesChannelId}/storage > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/storage":{"post":{"tags":["SalesChannel"],"operationId":"createSalesChannelStorage","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` ## POST /erp/sales-channels/backend > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/backend":{"post":{"tags":["SalesChannel"],"summary":"Create new Resource","operationId":"create_89","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelBackend"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelBackend"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannelBackend":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":255,"minLength":0},"active":{"type":"boolean","default":true,"description":"Aktiv?","readOnly":true},"appId":{"type":"string","description":"App-ID","maxLength":255,"minLength":0},"type":{"type":"string","description":"Typ","enum":["SELF","APP"]},"validChannelTypes":{"type":"array","description":"Erlaubte typen","items":{"type":"string","description":"Erlaubte typen","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]}}},"required":["label","type"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/sales-channels > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels":{"post":{"tags":["SalesChannel"],"summary":"Create new Resource","operationId":"create_90","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannel"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannel"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-SalesChannel":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"ist dieser channel aktiv"},"channelType":{"type":"string","description":"typ/klassifizierung des sales channel","enum":["STORE","POS","ECOMMERCE","MARKETPLACE"]},"channelBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackend":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"priceFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"discountFromSalesChannel":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"calculationMode":{"type":"string","description":"calculation mode of this sales channel","enum":["HORIZONTAL","VERTICAL"]},"roundingMode":{"type":"string","default":"NONE","description":"Endbetragsrundung","enum":["NONE","SWITZERLAND"]},"salesChannelStorages":{"type":"array","description":"Lagerzuordnungen","items":{"$ref":"#/components/schemas/erp-sales_channel-SalesChannelStorage"}},"defaultSalesChannel":{"type":"boolean","description":"Standard-Verkaufskanal"},"blockManualInvoiceTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Rechnung unterbinden"},"blockManualCreditNoteTakeover":{"type":"boolean","default":false,"description":"Manuelle Übernahme in Gutschrift unterbinden"},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"businessRelationType":{"type":"string","description":"Geschäftsbeziehungs-Typen für Geschäftspartner","enum":["B2B","B2C","B2G"]},"categoryTree":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalReferences":{"type":"string","description":"Externe Referenzen","readOnly":true},"tssExportState":{"type":"string","description":"TSS-Export-Zustand","enum":["PENDING","FINISHED"],"readOnly":true},"lastTssExportDate":{"type":"string","format":"date","description":"Letzter TSS-Export-Tag","readOnly":true},"pendingTssExportDateEnd":{"type":"string","format":"date","description":"Aktuell laufender TSS-Export bis","readOnly":true},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-sales_channel-SalesChannelStorage":{"description":"Lagerzuordnungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"storageSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"availabilityPercent":{"type":"number","description":"Verfügbarkeit in Prozent","maximum":100},"defaultSalesStorage":{"type":"boolean","description":"Standard-Verkaufslager"},"defaultPurchaseStorage":{"type":"boolean","description":"Standard-Einkaufslager"},"modifiedByUser":{"type":"boolean","description":"Durch Benutzer bearbeitet","readOnly":true}},"required":["storageRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## GET /erp/sales-channels/{salesChannelId}/tss/state > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"SalesChannel","description":"Verkaufskanäle bearbeiten"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/sales-channels/{salesChannelId}/tss/state":{"get":{"tags":["SalesChannel"],"operationId":"retrieveTssState","parameters":[{"name":"salesChannelId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","enum":["CREATED","UNINITIALIZED","INITIALIZED","DISABLED","DELETED","DEFECTIVE","EVICTED"]}}}}}}}}} ``` # Eingeplante Importe zum Planen von periodisch auszuführenden Importen ## GET /cmn/data-import/scheduled-import/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"eingeplante Importe","description":"zum Planen von periodisch auszuführenden Importen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/data-import/scheduled-import/{id}":{"get":{"tags":["eingeplante Importe"],"summary":"Find an existing Resource by identifier","operationId":"getById_146","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-data_import-ScheduledImport"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-data_import-ScheduledImport":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label"},"responsibleTask":{"$ref":"#/components/schemas/common-task-Task"},"ruleSetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"queryPresetRequest":{"$ref":"#/components/schemas/common-cunit-QueryPresetRequest"},"exportMode":{"type":"string","description":"Nur für Exporte: Was wird erzeugt? Eigene Datei oder Revision?","enum":["ONE_FILE_PER_RUN","ONE_REVISION_PER_RUN"]},"inputType":{"type":"string","description":"Was ist die Datenquelle","enum":["FILE","QUERY"]}},"required":["inputType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-task-Task":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"label of this task"},"description":{"type":"string","description":"description of this task"},"cronExpression":{"type":"string","description":"valid cron expression (UNIX style)"},"lastExecutedAt":{"type":"string","format":"date-time","description":"last execution date-time","readOnly":true},"firstExecutionTime":{"type":"string","format":"date-time","description":"first execution date-time"},"nextExecutionAt":{"type":"string","format":"date-time","description":"next execution date-time","readOnly":true},"nextExecutionOverride":{"type":"string","format":"date-time","description":"Wann eine bevorzugte Abarbeitung angefragt wurde","readOnly":true},"lastStatus":{"type":"string","description":"lastStatus","enum":["CREATED","QUEUED","RUNNING","TERMINATED","SUCCESSFUL","ERRONEOUS","FATAL"],"readOnly":true},"jobBeanName":{"type":"string","description":"bean-name/class-name to execute"},"state":{"type":"string","default":"ACTIVE","description":"Status","enum":["ACTIVE","SUSPENDED","TO_REMOVE"]},"category":{"type":"string","default":"NORMAL","description":"Category","enum":["NORMAL","LONG_RUNNING"],"readOnly":true},"dataPayloadJson":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"runAsUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"singleton":{"type":"boolean","default":true,"description":"Is this task a singleton"},"repetitions":{"type":"integer","format":"int32","description":"How often will this task run? (null -> forever)"},"processId":{"type":"string","description":"process id"},"traceActive":{"type":"boolean","default":false,"description":"Aktiviert Call-Tracing fuer diesen Task"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["cronExpression","firstExecutionTime","jobBeanName","label","runAsUserRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-cunit-QueryPresetRequest":{"description":"CUnit-Vorlage zum erzeugen des Imports","properties":{"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"presetId":{"type":"string","description":"ID eines Presets"},"adhocPreset":{"$ref":"#/components/schemas/common-cunit-QueryPreset"},"overrideResults":{"type":"array","description":"ergebnisse (überschreiben QueryPreset#results)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"additionalPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetRequestPageable"},"variableSubstitutionList":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList"}}},"common-cunit-QueryPreset":{"description":"Adhoc Preset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"templateId":{"type":"string","description":"template dem dieser filter zugeordnet worden ist."},"templateGroupKey":{"type":"string","description":"templateGroupKey dem dieser filter zugeordnet worden ist."},"label":{"type":"string","description":"label für diesen filter"},"uiPayload":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variables":{"type":"array","description":"Variablen für dieses Preset","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"}},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"results":{"type":"array","description":"ergebnisse","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"sortAndOrders":{"type":"array","description":"sortierung","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetPageable"},"option":{"$ref":"#/components/schemas/common-cunit-QueryPresetOption"},"transformations":{"type":"array","description":"zusätzliche konfigurationen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetTransformation"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"definition":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]},"readOnly":true},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"},"forWorkflow":{"type":"boolean","default":false,"description":"für Workflows vorgesehen"},"outputReportGroupIdentifier":{"type":"string","description":"Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird"},"userOptions":{"$ref":"#/components/schemas/common-cunit-QueryPresetUserOptions"}},"required":["forWorkflow","label","mode","permissionAggregation","templateGroupKey","templateId"]},"common-cunit-QueryPresetVariable":{"description":"Die zu ersetzende Variable","properties":{"path":{"type":"string","description":"Der pfad, der dieses Attribut eindeutig beschreibt"},"definition":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}],"readOnly":true},"mandatory":{"type":"boolean","description":"Ob die Variable ein Pflichtfeld ist oder nicht"},"variableName":{"type":"string","description":"Name der Variablen"},"visible":{"type":"boolean","default":true,"description":"Handelt es sich um eine sichtbare Variable?"},"alignX":{"type":"integer","format":"int32","description":"Anordnung im UI - X-Koordinate"},"alignY":{"type":"integer","format":"int32","description":"Anordnung im UI - Y-Koordinate"},"alignWidth":{"type":"integer","format":"int32","description":"Anordnung im UI - Breite"},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Eindeutiger Schlüssel zur Identifikation des Attributs"},"attribute":{"type":"string","description":"name des attributes der das ergebnis enthält"},"path":{"type":"string","description":"der pfad, der dieses attribut eindeutig beschreibt"},"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"parentDisplayName":{"type":"string","description":"der Name des Referenzierenden Feldes"},"resultable":{"type":"boolean","default":true,"description":"kann dieses Feld ein Ergebnisfeld sein"},"filterable":{"type":"boolean","default":true,"description":"kann nach diesem feld gefiltert werden"},"sortable":{"type":"boolean","default":true,"description":"ist dieses Feld sortierbar"},"visible":{"type":"boolean","default":true,"description":"soll dieses Feld angezeigt werden"},"functions":{"type":"array","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)","items":{"type":"string","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)"}},"sortDirection":{"type":"string","description":"Info, wie diese spalte sortiert worden ist"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"modelType":{"type":"string","description":"Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')","readOnly":true},"headers":{"type":"array","description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-MetaContent":{"description":"Definition dieser Variable","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]}}}},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"}}}]},"core-cunit-CuAttributeConstraint":{"description":"constraints für dieses Attribut","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"minimaler Wert","readOnly":true},"includeMinValue":{"type":"boolean","description":"ist der minimale Wert inklusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"maximaler Wert","readOnly":true},"includeMaxValue":{"type":"boolean","description":"ist der maximale Wert inklusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"ist der Wert 'null' verboten?","readOnly":true},"notBlank":{"type":"boolean","description":"Bei Strings: ist ein String nur aus Whitespace verboten?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximale Anzahl Nachkommastellen","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"data-type für dieses Attribut (falls dataTypeIdentifier leer ist)","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"welcher Typ ist es","readOnly":true},"objectRefIdentifier":{"type":"string","description":"bei Object_Ref: welcher Typ ist es genau","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"welche Funktionen sind erlaubt?","items":{"type":"string","description":"welche Funktionen sind erlaubt?"},"readOnly":true},"predicateOperations":{"type":"array","description":"welche Operations sind erlaubt?","items":{"type":"string","description":"welche Operations sind erlaubt?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit Attribut Filter Optionen","properties":{"filterValues":{"type":"array","description":"Mögliche Filterwerte","items":{"type":"string","description":"Mögliche Filterwerte"}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute.HeaderGroup":{"description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","properties":{"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Bedingungen zur Selektion von Lagerplätzen","properties":{"type":{"type":"string","description":"die Operation für diesen Filter","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"(bei junction) child-definitionen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"filter werte","items":{"type":"string","description":"filter werte"}},"visible":{"type":"boolean","default":true,"description":"Sichtbarkeit bei Variablen"},"functions":{"type":"array","description":"Eine SQL-Funktion, die im Predicate angewendet wird","items":{"type":"string","description":"Eine SQL-Funktion, die im Predicate angewendet wird"}}},"required":["operator","type"]},"common-cunit-QueryPresetResult":{"description":"Ergebnisse","properties":{"property":{"type":"string","description":"property"},"displayName":{"type":"string","description":"title dieser spalte"},"functions":{"type":"array","description":"funktionen","items":{"type":"string","description":"funktionen"}},"visible":{"type":"boolean","default":true,"description":"sichtbare Ergebnisspalte"}},"required":["property"]},"common-cunit-QueryPresetSortOrder":{"description":"sort and order anweisungen","properties":{"property":{"type":"string","description":"property"},"functions":{"type":"array","description":"Functions","items":{"type":"string","description":"Functions"}},"direction":{"type":"string","description":"sort order","enum":["ASC","DESC"]}},"required":["direction","property"]},"common-cunit-QueryPresetPageable":{"description":"pageable","properties":{"limit":{"type":"integer","format":"int64","description":"das Limit (MaxRecordCount) für diesen Query"}}},"common-cunit-QueryPresetOption":{"description":"options","properties":{"distinctResult":{"type":"boolean","description":"soll der Query mit einem Distinct durchgeführt werden"}}},"common-cunit-QueryPresetTransformation":{"description":"zusätzliche konfigurationen","properties":{"crossTable":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation"}}},"common-cunit-QueryPresetCrossTableTransformation":{"description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","properties":{"rowSpecs":{"type":"array","description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"columnSpecs":{"type":"array","description":"enthält die felder, die in der cross-table als dynamische spalten erstellt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"results":{"type":"array","description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell"}}},"required":["columnSpecs","results","rowSpecs"]},"common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell":{"description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","properties":{"result":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"cellView":{"type":"string","description":"darstellung der werte","enum":["AS_IS","PERCENT_COL"]},"sumColumn":{"type":"boolean","default":false,"description":"soll eine spaltensumme erzeugt werden"},"rowMode":{"type":"string","description":"soll eine zeilensumme erzeugt werden","enum":["DATA","DATA_AND_TOTAL","TOTAL"]},"aggregateFunction":{"type":"string","description":"die funktion mit der die werte der Zelle aggregiert werden"}}},"common-cunit-ArithmeticQueryTerm":{"description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","properties":{"termName":{"type":"string","description":"Der Name des Terms für die Verarbeitung und Darstellung"},"terms":{"type":"array","description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermInner"}},"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-cunit-ArithmeticQueryTermInner":{"description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","properties":{"fragment":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermFragment"},"attribute":{"type":"string","description":"Ein echtes Attribut aus dem Template"},"fixedValue":{"type":"number","description":"Ein Fixwert"}}},"common-cunit-ArithmeticQueryTermFragment":{"description":"Das Termfragment - eine weitere Verschachtelung mit eigenen Operationen","properties":{"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-cunit-QueryPresetUserOptions":{"description":"nutzerbezogene Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"pinned":{"type":"boolean","default":false,"description":"angepinnt?"}},"required":["pinned"]},"common-cunit-QueryPresetRequestPageable":{"description":"Paging- und Sortierinformationen","properties":{"start":{"type":"integer","format":"int64","description":"Start-Offset"},"limit":{"type":"integer","format":"int32","description":"Ergebnis-Limit"},"sortOrders":{"type":"array","description":"sort and order anweisungen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}}}},"common-cunit-QueryPresetVariableSubstitutionList":{"description":"Werte von Variablen","properties":{"variableSubstitutions":{"type":"array","description":"Die Variablenbelegungen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitution"}}}},"common-cunit-QueryPresetVariableSubstitution":{"description":"Die Variablenbelegungen","properties":{"variable":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"},"values":{"type":"array","description":"Die einzusetzenden Werte","items":{"type":"string","description":"Die einzusetzenden Werte"}}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /cmn/data-import/scheduled-import/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"eingeplante Importe","description":"zum Planen von periodisch auszuführenden Importen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/data-import/scheduled-import/{id}":{"put":{"tags":["eingeplante Importe"],"summary":"Update existing Resource ","operationId":"update_136","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-data_import-ScheduledImport"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-data_import-ScheduledImport"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-data_import-ScheduledImport":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label"},"responsibleTask":{"$ref":"#/components/schemas/common-task-Task"},"ruleSetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"queryPresetRequest":{"$ref":"#/components/schemas/common-cunit-QueryPresetRequest"},"exportMode":{"type":"string","description":"Nur für Exporte: Was wird erzeugt? Eigene Datei oder Revision?","enum":["ONE_FILE_PER_RUN","ONE_REVISION_PER_RUN"]},"inputType":{"type":"string","description":"Was ist die Datenquelle","enum":["FILE","QUERY"]}},"required":["inputType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-task-Task":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"label of this task"},"description":{"type":"string","description":"description of this task"},"cronExpression":{"type":"string","description":"valid cron expression (UNIX style)"},"lastExecutedAt":{"type":"string","format":"date-time","description":"last execution date-time","readOnly":true},"firstExecutionTime":{"type":"string","format":"date-time","description":"first execution date-time"},"nextExecutionAt":{"type":"string","format":"date-time","description":"next execution date-time","readOnly":true},"nextExecutionOverride":{"type":"string","format":"date-time","description":"Wann eine bevorzugte Abarbeitung angefragt wurde","readOnly":true},"lastStatus":{"type":"string","description":"lastStatus","enum":["CREATED","QUEUED","RUNNING","TERMINATED","SUCCESSFUL","ERRONEOUS","FATAL"],"readOnly":true},"jobBeanName":{"type":"string","description":"bean-name/class-name to execute"},"state":{"type":"string","default":"ACTIVE","description":"Status","enum":["ACTIVE","SUSPENDED","TO_REMOVE"]},"category":{"type":"string","default":"NORMAL","description":"Category","enum":["NORMAL","LONG_RUNNING"],"readOnly":true},"dataPayloadJson":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"runAsUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"singleton":{"type":"boolean","default":true,"description":"Is this task a singleton"},"repetitions":{"type":"integer","format":"int32","description":"How often will this task run? (null -> forever)"},"processId":{"type":"string","description":"process id"},"traceActive":{"type":"boolean","default":false,"description":"Aktiviert Call-Tracing fuer diesen Task"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["cronExpression","firstExecutionTime","jobBeanName","label","runAsUserRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-cunit-QueryPresetRequest":{"description":"CUnit-Vorlage zum erzeugen des Imports","properties":{"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"presetId":{"type":"string","description":"ID eines Presets"},"adhocPreset":{"$ref":"#/components/schemas/common-cunit-QueryPreset"},"overrideResults":{"type":"array","description":"ergebnisse (überschreiben QueryPreset#results)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"additionalPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetRequestPageable"},"variableSubstitutionList":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList"}}},"common-cunit-QueryPreset":{"description":"Adhoc Preset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"templateId":{"type":"string","description":"template dem dieser filter zugeordnet worden ist."},"templateGroupKey":{"type":"string","description":"templateGroupKey dem dieser filter zugeordnet worden ist."},"label":{"type":"string","description":"label für diesen filter"},"uiPayload":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variables":{"type":"array","description":"Variablen für dieses Preset","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"}},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"results":{"type":"array","description":"ergebnisse","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"sortAndOrders":{"type":"array","description":"sortierung","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetPageable"},"option":{"$ref":"#/components/schemas/common-cunit-QueryPresetOption"},"transformations":{"type":"array","description":"zusätzliche konfigurationen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetTransformation"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"definition":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]},"readOnly":true},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"},"forWorkflow":{"type":"boolean","default":false,"description":"für Workflows vorgesehen"},"outputReportGroupIdentifier":{"type":"string","description":"Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird"},"userOptions":{"$ref":"#/components/schemas/common-cunit-QueryPresetUserOptions"}},"required":["forWorkflow","label","mode","permissionAggregation","templateGroupKey","templateId"]},"common-cunit-QueryPresetVariable":{"description":"Die zu ersetzende Variable","properties":{"path":{"type":"string","description":"Der pfad, der dieses Attribut eindeutig beschreibt"},"definition":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}],"readOnly":true},"mandatory":{"type":"boolean","description":"Ob die Variable ein Pflichtfeld ist oder nicht"},"variableName":{"type":"string","description":"Name der Variablen"},"visible":{"type":"boolean","default":true,"description":"Handelt es sich um eine sichtbare Variable?"},"alignX":{"type":"integer","format":"int32","description":"Anordnung im UI - X-Koordinate"},"alignY":{"type":"integer","format":"int32","description":"Anordnung im UI - Y-Koordinate"},"alignWidth":{"type":"integer","format":"int32","description":"Anordnung im UI - Breite"},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Eindeutiger Schlüssel zur Identifikation des Attributs"},"attribute":{"type":"string","description":"name des attributes der das ergebnis enthält"},"path":{"type":"string","description":"der pfad, der dieses attribut eindeutig beschreibt"},"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"parentDisplayName":{"type":"string","description":"der Name des Referenzierenden Feldes"},"resultable":{"type":"boolean","default":true,"description":"kann dieses Feld ein Ergebnisfeld sein"},"filterable":{"type":"boolean","default":true,"description":"kann nach diesem feld gefiltert werden"},"sortable":{"type":"boolean","default":true,"description":"ist dieses Feld sortierbar"},"visible":{"type":"boolean","default":true,"description":"soll dieses Feld angezeigt werden"},"functions":{"type":"array","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)","items":{"type":"string","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)"}},"sortDirection":{"type":"string","description":"Info, wie diese spalte sortiert worden ist"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"modelType":{"type":"string","description":"Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')","readOnly":true},"headers":{"type":"array","description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-MetaContent":{"description":"Definition dieser Variable","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]}}}},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"}}}]},"core-cunit-CuAttributeConstraint":{"description":"constraints für dieses Attribut","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"minimaler Wert","readOnly":true},"includeMinValue":{"type":"boolean","description":"ist der minimale Wert inklusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"maximaler Wert","readOnly":true},"includeMaxValue":{"type":"boolean","description":"ist der maximale Wert inklusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"ist der Wert 'null' verboten?","readOnly":true},"notBlank":{"type":"boolean","description":"Bei Strings: ist ein String nur aus Whitespace verboten?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximale Anzahl Nachkommastellen","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"data-type für dieses Attribut (falls dataTypeIdentifier leer ist)","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"welcher Typ ist es","readOnly":true},"objectRefIdentifier":{"type":"string","description":"bei Object_Ref: welcher Typ ist es genau","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"welche Funktionen sind erlaubt?","items":{"type":"string","description":"welche Funktionen sind erlaubt?"},"readOnly":true},"predicateOperations":{"type":"array","description":"welche Operations sind erlaubt?","items":{"type":"string","description":"welche Operations sind erlaubt?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit Attribut Filter Optionen","properties":{"filterValues":{"type":"array","description":"Mögliche Filterwerte","items":{"type":"string","description":"Mögliche Filterwerte"}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute.HeaderGroup":{"description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","properties":{"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Bedingungen zur Selektion von Lagerplätzen","properties":{"type":{"type":"string","description":"die Operation für diesen Filter","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"(bei junction) child-definitionen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"filter werte","items":{"type":"string","description":"filter werte"}},"visible":{"type":"boolean","default":true,"description":"Sichtbarkeit bei Variablen"},"functions":{"type":"array","description":"Eine SQL-Funktion, die im Predicate angewendet wird","items":{"type":"string","description":"Eine SQL-Funktion, die im Predicate angewendet wird"}}},"required":["operator","type"]},"common-cunit-QueryPresetResult":{"description":"Ergebnisse","properties":{"property":{"type":"string","description":"property"},"displayName":{"type":"string","description":"title dieser spalte"},"functions":{"type":"array","description":"funktionen","items":{"type":"string","description":"funktionen"}},"visible":{"type":"boolean","default":true,"description":"sichtbare Ergebnisspalte"}},"required":["property"]},"common-cunit-QueryPresetSortOrder":{"description":"sort and order anweisungen","properties":{"property":{"type":"string","description":"property"},"functions":{"type":"array","description":"Functions","items":{"type":"string","description":"Functions"}},"direction":{"type":"string","description":"sort order","enum":["ASC","DESC"]}},"required":["direction","property"]},"common-cunit-QueryPresetPageable":{"description":"pageable","properties":{"limit":{"type":"integer","format":"int64","description":"das Limit (MaxRecordCount) für diesen Query"}}},"common-cunit-QueryPresetOption":{"description":"options","properties":{"distinctResult":{"type":"boolean","description":"soll der Query mit einem Distinct durchgeführt werden"}}},"common-cunit-QueryPresetTransformation":{"description":"zusätzliche konfigurationen","properties":{"crossTable":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation"}}},"common-cunit-QueryPresetCrossTableTransformation":{"description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","properties":{"rowSpecs":{"type":"array","description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"columnSpecs":{"type":"array","description":"enthält die felder, die in der cross-table als dynamische spalten erstellt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"results":{"type":"array","description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell"}}},"required":["columnSpecs","results","rowSpecs"]},"common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell":{"description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","properties":{"result":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"cellView":{"type":"string","description":"darstellung der werte","enum":["AS_IS","PERCENT_COL"]},"sumColumn":{"type":"boolean","default":false,"description":"soll eine spaltensumme erzeugt werden"},"rowMode":{"type":"string","description":"soll eine zeilensumme erzeugt werden","enum":["DATA","DATA_AND_TOTAL","TOTAL"]},"aggregateFunction":{"type":"string","description":"die funktion mit der die werte der Zelle aggregiert werden"}}},"common-cunit-ArithmeticQueryTerm":{"description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","properties":{"termName":{"type":"string","description":"Der Name des Terms für die Verarbeitung und Darstellung"},"terms":{"type":"array","description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermInner"}},"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-cunit-ArithmeticQueryTermInner":{"description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","properties":{"fragment":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermFragment"},"attribute":{"type":"string","description":"Ein echtes Attribut aus dem Template"},"fixedValue":{"type":"number","description":"Ein Fixwert"}}},"common-cunit-ArithmeticQueryTermFragment":{"description":"Das Termfragment - eine weitere Verschachtelung mit eigenen Operationen","properties":{"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-cunit-QueryPresetUserOptions":{"description":"nutzerbezogene Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"pinned":{"type":"boolean","default":false,"description":"angepinnt?"}},"required":["pinned"]},"common-cunit-QueryPresetRequestPageable":{"description":"Paging- und Sortierinformationen","properties":{"start":{"type":"integer","format":"int64","description":"Start-Offset"},"limit":{"type":"integer","format":"int32","description":"Ergebnis-Limit"},"sortOrders":{"type":"array","description":"sort and order anweisungen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}}}},"common-cunit-QueryPresetVariableSubstitutionList":{"description":"Werte von Variablen","properties":{"variableSubstitutions":{"type":"array","description":"Die Variablenbelegungen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitution"}}}},"common-cunit-QueryPresetVariableSubstitution":{"description":"Die Variablenbelegungen","properties":{"variable":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"},"values":{"type":"array","description":"Die einzusetzenden Werte","items":{"type":"string","description":"Die einzusetzenden Werte"}}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /cmn/data-import/scheduled-import/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"eingeplante Importe","description":"zum Planen von periodisch auszuführenden Importen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/data-import/scheduled-import/{id}":{"delete":{"tags":["eingeplante Importe"],"summary":"Delete an existing Resource","operationId":"delete_123","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/data-import/scheduled-import > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"eingeplante Importe","description":"zum Planen von periodisch auszuführenden Importen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/data-import/scheduled-import":{"post":{"tags":["eingeplante Importe"],"summary":"Create new Resource","operationId":"create_124","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-data_import-ScheduledImport"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-data_import-ScheduledImport"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-data_import-ScheduledImport":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Label"},"responsibleTask":{"$ref":"#/components/schemas/common-task-Task"},"ruleSetRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"queryPresetRequest":{"$ref":"#/components/schemas/common-cunit-QueryPresetRequest"},"exportMode":{"type":"string","description":"Nur für Exporte: Was wird erzeugt? Eigene Datei oder Revision?","enum":["ONE_FILE_PER_RUN","ONE_REVISION_PER_RUN"]},"inputType":{"type":"string","description":"Was ist die Datenquelle","enum":["FILE","QUERY"]}},"required":["inputType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-task-Task":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"label of this task"},"description":{"type":"string","description":"description of this task"},"cronExpression":{"type":"string","description":"valid cron expression (UNIX style)"},"lastExecutedAt":{"type":"string","format":"date-time","description":"last execution date-time","readOnly":true},"firstExecutionTime":{"type":"string","format":"date-time","description":"first execution date-time"},"nextExecutionAt":{"type":"string","format":"date-time","description":"next execution date-time","readOnly":true},"nextExecutionOverride":{"type":"string","format":"date-time","description":"Wann eine bevorzugte Abarbeitung angefragt wurde","readOnly":true},"lastStatus":{"type":"string","description":"lastStatus","enum":["CREATED","QUEUED","RUNNING","TERMINATED","SUCCESSFUL","ERRONEOUS","FATAL"],"readOnly":true},"jobBeanName":{"type":"string","description":"bean-name/class-name to execute"},"state":{"type":"string","default":"ACTIVE","description":"Status","enum":["ACTIVE","SUSPENDED","TO_REMOVE"]},"category":{"type":"string","default":"NORMAL","description":"Category","enum":["NORMAL","LONG_RUNNING"],"readOnly":true},"dataPayloadJson":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"runAsUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"singleton":{"type":"boolean","default":true,"description":"Is this task a singleton"},"repetitions":{"type":"integer","format":"int32","description":"How often will this task run? (null -> forever)"},"processId":{"type":"string","description":"process id"},"traceActive":{"type":"boolean","default":false,"description":"Aktiviert Call-Tracing fuer diesen Task"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["cronExpression","firstExecutionTime","jobBeanName","label","runAsUserRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"common-cunit-QueryPresetRequest":{"description":"CUnit-Vorlage zum erzeugen des Imports","properties":{"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"presetId":{"type":"string","description":"ID eines Presets"},"adhocPreset":{"$ref":"#/components/schemas/common-cunit-QueryPreset"},"overrideResults":{"type":"array","description":"ergebnisse (überschreiben QueryPreset#results)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"additionalPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetRequestPageable"},"variableSubstitutionList":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList"}}},"common-cunit-QueryPreset":{"description":"Adhoc Preset","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"mode":{"type":"string","default":"QUERY","description":"Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT","enum":["QUERY","STATEMENT"]},"templateId":{"type":"string","description":"template dem dieser filter zugeordnet worden ist."},"templateGroupKey":{"type":"string","description":"templateGroupKey dem dieser filter zugeordnet worden ist."},"label":{"type":"string","description":"label für diesen filter"},"uiPayload":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variables":{"type":"array","description":"Variablen für dieses Preset","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"}},"queryStatement":{"type":"string","description":"bei mode == STATEMENT, das vql-query"},"queryPredicate":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"},"results":{"type":"array","description":"ergebnisse","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"sortAndOrders":{"type":"array","description":"sortierung","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}},"pageable":{"$ref":"#/components/schemas/common-cunit-QueryPresetPageable"},"option":{"$ref":"#/components/schemas/common-cunit-QueryPresetOption"},"transformations":{"type":"array","description":"zusätzliche konfigurationen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetTransformation"}},"arithmeticQueryTerms":{"type":"array","description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTerm"}},"definition":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]},"readOnly":true},"permissionAggregation":{"$ref":"#/components/schemas/common-user-ObjectSpecificPermissionAggregation"},"forWorkflow":{"type":"boolean","default":false,"description":"für Workflows vorgesehen"},"outputReportGroupIdentifier":{"type":"string","description":"Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird"},"userOptions":{"$ref":"#/components/schemas/common-cunit-QueryPresetUserOptions"}},"required":["forWorkflow","label","mode","permissionAggregation","templateGroupKey","templateId"]},"common-cunit-QueryPresetVariable":{"description":"Die zu ersetzende Variable","properties":{"path":{"type":"string","description":"Der pfad, der dieses Attribut eindeutig beschreibt"},"definition":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}],"readOnly":true},"mandatory":{"type":"boolean","description":"Ob die Variable ein Pflichtfeld ist oder nicht"},"variableName":{"type":"string","description":"Name der Variablen"},"visible":{"type":"boolean","default":true,"description":"Handelt es sich um eine sichtbare Variable?"},"alignX":{"type":"integer","format":"int32","description":"Anordnung im UI - X-Koordinate"},"alignY":{"type":"integer","format":"int32","description":"Anordnung im UI - Y-Koordinate"},"alignWidth":{"type":"integer","format":"int32","description":"Anordnung im UI - Breite"},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"allowDialogMultipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"key":{"type":"string","description":"Eindeutiger Schlüssel zur Identifikation des Attributs"},"attribute":{"type":"string","description":"name des attributes der das ergebnis enthält"},"path":{"type":"string","description":"der pfad, der dieses attribut eindeutig beschreibt"},"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"parentDisplayName":{"type":"string","description":"der Name des Referenzierenden Feldes"},"resultable":{"type":"boolean","default":true,"description":"kann dieses Feld ein Ergebnisfeld sein"},"filterable":{"type":"boolean","default":true,"description":"kann nach diesem feld gefiltert werden"},"sortable":{"type":"boolean","default":true,"description":"ist dieses Feld sortierbar"},"visible":{"type":"boolean","default":true,"description":"soll dieses Feld angezeigt werden"},"functions":{"type":"array","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)","items":{"type":"string","description":"angewendete funktionen (wenn das als Result MetaData verwendet wird)"}},"sortDirection":{"type":"string","description":"Info, wie diese spalte sortiert worden ist"},"constraint":{"$ref":"#/components/schemas/core-cunit-CuAttributeConstraint"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"modelType":{"type":"string","description":"Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'","enum":["STATIC","DYNAMIC"],"readOnly":true},"entityIdentifier":{"type":"string","description":"Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')","readOnly":true},"referencedEntityIdentifier":{"type":"string","description":"Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')","readOnly":true},"headers":{"type":"array","description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","items":{"$ref":"#/components/schemas/core-cunit-CuAttribute.HeaderGroup"},"readOnly":true}}}]},"core-cunit-MetaContent":{"description":"Definition dieser Variable","discriminator":{"propertyName":"_type"},"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuMeta"},{"$ref":"#/components/schemas/core-cunit-CuAttribute"}],"properties":{"_type":{"type":"string"}},"required":["_type"]},"core-cunit-CuMeta":{"allOf":[{"$ref":"#/components/schemas/core-cunit-MetaContent"},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"},"value":{"type":"array","description":"spaltenbeschreibung dieser zelle (bei verschachtelung)","items":{"oneOf":[{"$ref":"#/components/schemas/core-cunit-CuAttribute"},{"$ref":"#/components/schemas/core-cunit-CuMeta"}]}}}},{"type":"object","properties":{"definition":{"$ref":"#/components/schemas/core-cunit-CuAttribute"}}}]},"core-cunit-CuAttributeConstraint":{"description":"constraints für dieses Attribut","properties":{"minLength":{"type":"integer","format":"int32","description":"Minimal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"maxLength":{"type":"integer","format":"int32","description":"Maximal-Länge (von Zeichenketten oder Arrays)","readOnly":true},"minValue":{"type":"integer","format":"int64","description":"minimaler Wert","readOnly":true},"includeMinValue":{"type":"boolean","description":"ist der minimale Wert inklusive?","readOnly":true},"maxValue":{"type":"integer","format":"int64","description":"maximaler Wert","readOnly":true},"includeMaxValue":{"type":"boolean","description":"ist der maximale Wert inklusive?","readOnly":true},"notNull":{"type":"boolean","default":false,"description":"ist der Wert 'null' verboten?","readOnly":true},"notBlank":{"type":"boolean","description":"Bei Strings: ist ein String nur aus Whitespace verboten?","readOnly":true},"digitsFraction":{"type":"integer","format":"int32","description":"Maximale Anzahl Nachkommastellen","readOnly":true}}},"core-cunit-CuAttributeDataType":{"description":"data-type für dieses Attribut (falls dataTypeIdentifier leer ist)","properties":{"identifier":{"type":"string","description":"Datentyp-identifier","readOnly":true},"jsType":{"type":"string","description":"welcher Typ ist es","readOnly":true},"objectRefIdentifier":{"type":"string","description":"bei Object_Ref: welcher Typ ist es genau","readOnly":true},"filterOptions":{"$ref":"#/components/schemas/core-cunit-CuAttributeFilterOptions"},"functions":{"type":"array","description":"welche Funktionen sind erlaubt?","items":{"type":"string","description":"welche Funktionen sind erlaubt?"},"readOnly":true},"predicateOperations":{"type":"array","description":"welche Operations sind erlaubt?","items":{"type":"string","description":"welche Operations sind erlaubt?","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"readOnly":true}}},"core-cunit-CuAttributeFilterOptions":{"description":"CUnit Attribut Filter Optionen","properties":{"filterValues":{"type":"array","description":"Mögliche Filterwerte","items":{"type":"string","description":"Mögliche Filterwerte"}},"filterDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"multipleChoice":{"type":"boolean","default":false,"description":"Kann eine Mehrfachauswahl erfolgen?"}}},"core-cunit-CuAttribute.HeaderGroup":{"description":"bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben","properties":{"displayName":{"type":"string","description":"der Name dieses Feldes"},"displayNameOverride":{"type":"boolean","default":false,"description":"der Name dieses Feldes wurde überschrieben (alias oder funktion)"},"dataType":{"$ref":"#/components/schemas/core-cunit-CuAttributeDataType"},"dataTypeIdentifier":{"type":"string","description":"data-type-identifier für dieses Attribut (falls dataType leer ist)","readOnly":true},"groupDisplayName":{"type":"string","description":"der Name der Gruppe, dieses Feldes"},"data":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"common-cunit-QueryPresetPredicate":{"description":"Bedingungen zur Selektion von Lagerplätzen","properties":{"type":{"type":"string","description":"die Operation für diesen Filter","enum":["JUNCTION","FILTER"]},"operator":{"type":"string","description":"operator","enum":["AND","OR","EQUALS","NOT_EQUALS","LIKE","NOT_LIKE","STARTS_WITH","ENDS_WITH","CONTAINS","NOT_CONTAINS","GREATER_THAN","GREATER_THAN_EQUALS","LESS_THAN","LESS_THAN_EQUALS","IN","NOT_IN","RANGE","NOT_RANGE","IS_NULL","IS_NOT_NULL","IS_NULL_OR_EQUALS","EXISTS","NOT_EXISTS"]},"children":{"type":"array","description":"(bei junction) child-definitionen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetPredicate"}},"property":{"type":"string","description":"filter property"},"values":{"type":"array","description":"filter werte","items":{"type":"string","description":"filter werte"}},"visible":{"type":"boolean","default":true,"description":"Sichtbarkeit bei Variablen"},"functions":{"type":"array","description":"Eine SQL-Funktion, die im Predicate angewendet wird","items":{"type":"string","description":"Eine SQL-Funktion, die im Predicate angewendet wird"}}},"required":["operator","type"]},"common-cunit-QueryPresetResult":{"description":"Ergebnisse","properties":{"property":{"type":"string","description":"property"},"displayName":{"type":"string","description":"title dieser spalte"},"functions":{"type":"array","description":"funktionen","items":{"type":"string","description":"funktionen"}},"visible":{"type":"boolean","default":true,"description":"sichtbare Ergebnisspalte"}},"required":["property"]},"common-cunit-QueryPresetSortOrder":{"description":"sort and order anweisungen","properties":{"property":{"type":"string","description":"property"},"functions":{"type":"array","description":"Functions","items":{"type":"string","description":"Functions"}},"direction":{"type":"string","description":"sort order","enum":["ASC","DESC"]}},"required":["direction","property"]},"common-cunit-QueryPresetPageable":{"description":"pageable","properties":{"limit":{"type":"integer","format":"int64","description":"das Limit (MaxRecordCount) für diesen Query"}}},"common-cunit-QueryPresetOption":{"description":"options","properties":{"distinctResult":{"type":"boolean","description":"soll der Query mit einem Distinct durchgeführt werden"}}},"common-cunit-QueryPresetTransformation":{"description":"zusätzliche konfigurationen","properties":{"crossTable":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation"}}},"common-cunit-QueryPresetCrossTableTransformation":{"description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","properties":{"rowSpecs":{"type":"array","description":"enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"columnSpecs":{"type":"array","description":"enthält die felder, die in der cross-table als dynamische spalten erstellt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"}},"results":{"type":"array","description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell"}}},"required":["columnSpecs","results","rowSpecs"]},"common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell":{"description":"enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen","properties":{"result":{"$ref":"#/components/schemas/common-cunit-QueryPresetResult"},"cellView":{"type":"string","description":"darstellung der werte","enum":["AS_IS","PERCENT_COL"]},"sumColumn":{"type":"boolean","default":false,"description":"soll eine spaltensumme erzeugt werden"},"rowMode":{"type":"string","description":"soll eine zeilensumme erzeugt werden","enum":["DATA","DATA_AND_TOTAL","TOTAL"]},"aggregateFunction":{"type":"string","description":"die funktion mit der die werte der Zelle aggregiert werden"}}},"common-cunit-ArithmeticQueryTerm":{"description":"Arithmetische Terme - hier kommt die tatsächliche Berechnung rein","properties":{"termName":{"type":"string","description":"Der Name des Terms für die Verarbeitung und Darstellung"},"terms":{"type":"array","description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","items":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermInner"}},"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-cunit-ArithmeticQueryTermInner":{"description":"Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung","properties":{"fragment":{"$ref":"#/components/schemas/common-cunit-ArithmeticQueryTermFragment"},"attribute":{"type":"string","description":"Ein echtes Attribut aus dem Template"},"fixedValue":{"type":"number","description":"Ein Fixwert"}}},"common-cunit-ArithmeticQueryTermFragment":{"description":"Das Termfragment - eine weitere Verschachtelung mit eigenen Operationen","properties":{"operations":{"type":"array","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","items":{"type":"string","description":"Die Operationen, die ausgeführt werden sollen mit den Termen","enum":["PLUS","MINUS","MULTIPLY","DIVIDE"]}}}},"common-user-ObjectSpecificPermissionAggregation":{"description":"alle Nutzer-/Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userPermissions":{"type":"array","description":"Nutzer-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificUserPermission"}},"groupPermissions":{"type":"array","description":"Gruppen-Berechtigungen","items":{"$ref":"#/components/schemas/common-user-ObjectSpecificGroupPermission"}},"operationForAllUsers":{"type":"string","description":"Zugriffsrechte für alle Nutzer","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificUserPermission":{"description":"Nutzer-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"userRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-user-ObjectSpecificGroupPermission":{"description":"Gruppen-Berechtigungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"operation":{"type":"string","description":"Berechtigung","enum":["READ_ONLY","READ_AND_EDIT"]}}},"common-cunit-QueryPresetUserOptions":{"description":"nutzerbezogene Einstellungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"pinned":{"type":"boolean","default":false,"description":"angepinnt?"}},"required":["pinned"]},"common-cunit-QueryPresetRequestPageable":{"description":"Paging- und Sortierinformationen","properties":{"start":{"type":"integer","format":"int64","description":"Start-Offset"},"limit":{"type":"integer","format":"int32","description":"Ergebnis-Limit"},"sortOrders":{"type":"array","description":"sort and order anweisungen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetSortOrder"}}}},"common-cunit-QueryPresetVariableSubstitutionList":{"description":"Werte von Variablen","properties":{"variableSubstitutions":{"type":"array","description":"Die Variablenbelegungen","items":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariableSubstitution"}}}},"common-cunit-QueryPresetVariableSubstitution":{"description":"Die Variablenbelegungen","properties":{"variable":{"$ref":"#/components/schemas/common-cunit-QueryPresetVariable"},"values":{"type":"array","description":"Die einzusetzenden Werte","items":{"type":"string","description":"Die einzusetzenden Werte"}}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` # Status Zu Aufgaben CRM Aufgaben: Statusverwaltung ## PUT /erp/crm-tasks/states/{taskStateId}/move/{position} > moves a line to a new position ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Status zu Aufgaben","description":"CRM Aufgaben: Statusverwaltung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/states/{taskStateId}/move/{position}":{"put":{"tags":["Status zu Aufgaben"],"summary":"moves a line to a new position","operationId":"moveLine_2","parameters":[{"name":"taskStateId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"position","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmState"}}}}}}}},"components":{"schemas":{"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}}}}} ``` ## GET /erp/crm-tasks/states/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Status zu Aufgaben","description":"CRM Aufgaben: Statusverwaltung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/states/{id}":{"get":{"tags":["Status zu Aufgaben"],"summary":"Find an existing Resource by identifier","operationId":"getById_53","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmState"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-tasks/states/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Status zu Aufgaben","description":"CRM Aufgaben: Statusverwaltung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/states/{id}":{"put":{"tags":["Status zu Aufgaben"],"summary":"Update existing Resource ","operationId":"update_49","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmState"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmState"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/crm-tasks/states/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Status zu Aufgaben","description":"CRM Aufgaben: Statusverwaltung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/states/{id}":{"delete":{"tags":["Status zu Aufgaben"],"summary":"Delete an existing Resource","operationId":"delete_47","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-tasks/states/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Status zu Aufgaben","description":"CRM Aufgaben: Statusverwaltung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/states/{id}/deactivate":{"put":{"tags":["Status zu Aufgaben"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_21","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmState"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/crm-tasks/states/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Status zu Aufgaben","description":"CRM Aufgaben: Statusverwaltung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/states/{id}/activate":{"put":{"tags":["Status zu Aufgaben"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_21","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmState"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## GET /erp/crm-tasks/states > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Status zu Aufgaben","description":"CRM Aufgaben: Statusverwaltung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/states":{"get":{"tags":["Status zu Aufgaben"],"operationId":"getAll_1","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-crm-CrmState"}}}}}}}}},"components":{"schemas":{"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}}}}} ``` ## POST /erp/crm-tasks/states > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Status zu Aufgaben","description":"CRM Aufgaben: Statusverwaltung"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/crm-tasks/states":{"post":{"tags":["Status zu Aufgaben"],"summary":"Create new Resource","operationId":"create_45","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmState"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-crm-CrmState"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-crm-CrmState":{"description":"Status eines CRM-Objekts","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"crmSubTypes":{"type":"array","description":"Typ zu dem dieser Status gehört","items":{"$ref":"#/components/schemas/erp-crm-CrmSubType"}},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"startState":{"type":"boolean","default":false,"description":"Handelt es sich um einen Anfang-Status"},"finishState":{"type":"boolean","default":false,"description":"Handelt es sich um einen End-Status"},"readyToBill":{"type":"boolean","default":false,"description":"Handelt es sich um einen \"Bereit zur Abrechnung\"-Status"},"needsCommentOnPositiveFinish":{"type":"boolean","default":false,"description":"Kommentar bei positivem Abschluß erforderlich"},"needsCommentOnNegativeFinish":{"type":"boolean","default":false,"description":"Kommentar bei negativem Abschluß erforderlich"},"active":{"type":"boolean","description":"active","readOnly":true},"portalEnumRef":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["crmSubTypes","label","sortOrder"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-crm-CrmSubType":{"description":"Spezialisierter Typ einer CRM-Objekt-Implementierung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"sortOrder":{"type":"integer","format":"int32","description":"Sortierreihenfolge"},"active":{"type":"boolean","description":"aktiv","readOnly":true}},"required":["label","sortOrder"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Produktion Funktionen zur Verarbeitung von Produktionsbelegen ## GET /erp/fabrication/{fabricationOrderId}/revert/{lineId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/revert/{lineId}":{"get":{"tags":["Produktion"],"operationId":"getDetailsForProductionReversalOfDocumentLine","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID der zu produzierenden Position","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-fabrication-DetailsForProductionReversal"}}}}}}}},"components":{"schemas":{"erp-fabrication-DetailsForProductionReversal":{"description":"Details zur Stornierung einer Position","properties":{"documentId":{"type":"integer","format":"int64","description":"ID des Belegs"},"documentLineId":{"type":"integer","format":"int64","description":"ID der Belegposition"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"producedQuantity":{"type":"number","description":"Noch zu produzierende Menge"},"producedSerialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationProducedSerialNumber"}},"usedComponents":{"type":"array","description":"Verbaute Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationUsedComponent"}}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-fabrication-FabricationProducedSerialNumber":{"description":"Produzierte Seriennummer zu einer Position","properties":{"articleSerialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Menge"}}},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-FabricationUsedComponent":{"description":"Verbaute Komponenten","properties":{"documentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Verbaute Menge"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]}}}}}} ``` ## POST /erp/fabrication/{fabricationOrderId}/revert/{lineId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/revert/{lineId}":{"post":{"tags":["Produktion"],"operationId":"revertProducedArticle","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID der zu stornierenden Position","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-fabrication-FabricationRevertRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-Document"}}}}}}}},"components":{"schemas":{"erp-fabrication-FabricationRevertRequest":{"description":"Details zur Stornierung der Produktion einer Position","properties":{"documentLineId":{"type":"integer","format":"int64","description":"ID der zu stornierenden Position"},"quantity":{"type":"number","description":"Zu stornierende Menge"},"autoRevertComponents":{"type":"boolean","default":true,"description":"Material automatisch stornieren"},"serialNumbers":{"type":"array","description":"Zu stornierende Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}},"componentsToRevert":{"type":"array","description":"Zu stornierendes Material","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationComponentForProduction"}}},"required":["documentLineId","quantity"]},"erp-fabrication-FabricationSerialNumber":{"description":"Zu produzierende Seriennummer","properties":{"quantity":{"type":"number","description":"Abweichende Menge für Chargen"},"serialNumberId":{"type":"integer","format":"int64","description":"ID der zu produzierenden Seriennummer (nur zur gezielten Produktion von bereits definierten Seriennummern)"},"serialNumber1":{"type":"string","description":"Seriennummer 1"},"serialNumber2":{"type":"string","description":"Seriennummer 2"},"expiryDate":{"type":"string","format":"date","description":"MHD / Verfallsdatum"},"note":{"type":"string","description":"Bemerkung"}}},"erp-fabrication-FabricationComponentForProduction":{"description":"Für die Produktion zu verwendendes Material","properties":{"serialNumberId":{"type":"integer","format":"int64","description":"Zu produzierende Seriennummer, für die die Komponente verwendet werden"},"documentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente"},"articleSerialNumberId":{"type":"integer","format":"int64","description":"ID einer Seriennummer"},"quantity":{"type":"number","description":"Zu verwendende Menge"}},"required":["documentLineComponentId","quantity"]},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}}}}} ``` ## GET /erp/fabrication/{fabricationOrderId}/revert-all > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/revert-all":{"get":{"tags":["Produktion"],"operationId":"getDetailsForProductionReversalOfDocument","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-fabrication-DetailsForProductionReversal"}}}}}}}}},"components":{"schemas":{"erp-fabrication-DetailsForProductionReversal":{"description":"Details zur Stornierung einer Position","properties":{"documentId":{"type":"integer","format":"int64","description":"ID des Belegs"},"documentLineId":{"type":"integer","format":"int64","description":"ID der Belegposition"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"producedQuantity":{"type":"number","description":"Noch zu produzierende Menge"},"producedSerialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationProducedSerialNumber"}},"usedComponents":{"type":"array","description":"Verbaute Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationUsedComponent"}}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-fabrication-FabricationProducedSerialNumber":{"description":"Produzierte Seriennummer zu einer Position","properties":{"articleSerialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Menge"}}},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-FabricationUsedComponent":{"description":"Verbaute Komponenten","properties":{"documentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Verbaute Menge"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]}}}}}} ``` ## POST /erp/fabrication/{fabricationOrderId}/revert-all > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/revert-all":{"post":{"tags":["Produktion"],"operationId":"revertAll","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationRevertRequest"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-Document"}}}}}}}},"components":{"schemas":{"erp-fabrication-FabricationRevertRequest":{"description":"Details zur Stornierung der Produktion einer Position","properties":{"documentLineId":{"type":"integer","format":"int64","description":"ID der zu stornierenden Position"},"quantity":{"type":"number","description":"Zu stornierende Menge"},"autoRevertComponents":{"type":"boolean","default":true,"description":"Material automatisch stornieren"},"serialNumbers":{"type":"array","description":"Zu stornierende Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}},"componentsToRevert":{"type":"array","description":"Zu stornierendes Material","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationComponentForProduction"}}},"required":["documentLineId","quantity"]},"erp-fabrication-FabricationSerialNumber":{"description":"Zu produzierende Seriennummer","properties":{"quantity":{"type":"number","description":"Abweichende Menge für Chargen"},"serialNumberId":{"type":"integer","format":"int64","description":"ID der zu produzierenden Seriennummer (nur zur gezielten Produktion von bereits definierten Seriennummern)"},"serialNumber1":{"type":"string","description":"Seriennummer 1"},"serialNumber2":{"type":"string","description":"Seriennummer 2"},"expiryDate":{"type":"string","format":"date","description":"MHD / Verfallsdatum"},"note":{"type":"string","description":"Bemerkung"}}},"erp-fabrication-FabricationComponentForProduction":{"description":"Für die Produktion zu verwendendes Material","properties":{"serialNumberId":{"type":"integer","format":"int64","description":"Zu produzierende Seriennummer, für die die Komponente verwendet werden"},"documentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente"},"articleSerialNumberId":{"type":"integer","format":"int64","description":"ID einer Seriennummer"},"quantity":{"type":"number","description":"Zu verwendende Menge"}},"required":["documentLineComponentId","quantity"]},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}}}}} ``` ## GET /erp/fabrication/{fabricationOrderId}/produce/{lineId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/produce/{lineId}":{"get":{"tags":["Produktion"],"operationId":"getDetailsForProductionOfDocumentLine","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID der zu produzierenden Position","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-fabrication-DetailsForProduction"}}}}}}}},"components":{"schemas":{"erp-fabrication-DetailsForProduction":{"description":"Details zur Produktion einer Position","properties":{"documentId":{"type":"integer","format":"int64","description":"ID des Belegs"},"documentLineId":{"type":"integer","format":"int64","description":"ID der Belegposition"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"serialNumbersToProduce":{"type":"array","description":"Zu produzierende Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-SerialNumberWithQuantityApi"}},"serialNumbersRequired":{"type":"boolean","default":false,"description":"Müssen noch Seriennummern erfasst werden?"},"remainingQuantity":{"type":"number","description":"Noch zu produzierende Menge"},"remainingComponents":{"type":"array","description":"Offene zu verbauende Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationRemainingComponent"}}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-fabrication-SerialNumberWithQuantityApi":{"description":"Seriennummer mit Menge","properties":{"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Menge"}}},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-FabricationRemainingComponent":{"description":"Noch offenes zu verbauendes Material","properties":{"lineSerialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"documentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Offene Menge"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]}}}}}} ``` ## POST /erp/fabrication/{fabricationOrderId}/produce/{lineId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/produce/{lineId}":{"post":{"tags":["Produktion"],"operationId":"produceArticle","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID der zu produzierenden Position","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-fabrication-FabricationProduceRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-Document"}}}}}}}},"components":{"schemas":{"erp-fabrication-FabricationProduceRequest":{"description":"Details zur Produktion einer Position","properties":{"documentLineId":{"type":"integer","format":"int64","description":"ID der zu produzierenden Position"},"quantity":{"type":"number","description":"Zu produzierende Menge"},"autoCommitComponents":{"type":"boolean","default":true,"description":"Material automatisch bestätigen"},"serialNumbers":{"type":"array","description":"Zu produzierende Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}},"componentsForProduction":{"type":"array","description":"Für die Produktion zu verwendendes Material","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationComponentForProduction"}}},"required":["documentLineId","quantity"]},"erp-fabrication-FabricationSerialNumber":{"description":"Zu produzierende Seriennummer","properties":{"quantity":{"type":"number","description":"Abweichende Menge für Chargen"},"serialNumberId":{"type":"integer","format":"int64","description":"ID der zu produzierenden Seriennummer (nur zur gezielten Produktion von bereits definierten Seriennummern)"},"serialNumber1":{"type":"string","description":"Seriennummer 1"},"serialNumber2":{"type":"string","description":"Seriennummer 2"},"expiryDate":{"type":"string","format":"date","description":"MHD / Verfallsdatum"},"note":{"type":"string","description":"Bemerkung"}}},"erp-fabrication-FabricationComponentForProduction":{"description":"Für die Produktion zu verwendendes Material","properties":{"serialNumberId":{"type":"integer","format":"int64","description":"Zu produzierende Seriennummer, für die die Komponente verwendet werden"},"documentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente"},"articleSerialNumberId":{"type":"integer","format":"int64","description":"ID einer Seriennummer"},"quantity":{"type":"number","description":"Zu verwendende Menge"}},"required":["documentLineComponentId","quantity"]},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}}}}} ``` ## GET /erp/fabrication/{fabricationOrderId}/produce-all > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/produce-all":{"get":{"tags":["Produktion"],"operationId":"getDetailsForProductionOfDocument","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-fabrication-DetailsForProduction"}}}}}}}}},"components":{"schemas":{"erp-fabrication-DetailsForProduction":{"description":"Details zur Produktion einer Position","properties":{"documentId":{"type":"integer","format":"int64","description":"ID des Belegs"},"documentLineId":{"type":"integer","format":"int64","description":"ID der Belegposition"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"serialNumbersToProduce":{"type":"array","description":"Zu produzierende Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-SerialNumberWithQuantityApi"}},"serialNumbersRequired":{"type":"boolean","default":false,"description":"Müssen noch Seriennummern erfasst werden?"},"remainingQuantity":{"type":"number","description":"Noch zu produzierende Menge"},"remainingComponents":{"type":"array","description":"Offene zu verbauende Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationRemainingComponent"}}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-fabrication-SerialNumberWithQuantityApi":{"description":"Seriennummer mit Menge","properties":{"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Menge"}}},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-FabricationRemainingComponent":{"description":"Noch offenes zu verbauendes Material","properties":{"lineSerialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"documentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Offene Menge"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]}}}}}} ``` ## POST /erp/fabrication/{fabricationOrderId}/produce-all > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/produce-all":{"post":{"tags":["Produktion"],"operationId":"produceAll","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationProduceRequest"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-Document"}}}}}}}},"components":{"schemas":{"erp-fabrication-FabricationProduceRequest":{"description":"Details zur Produktion einer Position","properties":{"documentLineId":{"type":"integer","format":"int64","description":"ID der zu produzierenden Position"},"quantity":{"type":"number","description":"Zu produzierende Menge"},"autoCommitComponents":{"type":"boolean","default":true,"description":"Material automatisch bestätigen"},"serialNumbers":{"type":"array","description":"Zu produzierende Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationSerialNumber"}},"componentsForProduction":{"type":"array","description":"Für die Produktion zu verwendendes Material","items":{"$ref":"#/components/schemas/erp-fabrication-FabricationComponentForProduction"}}},"required":["documentLineId","quantity"]},"erp-fabrication-FabricationSerialNumber":{"description":"Zu produzierende Seriennummer","properties":{"quantity":{"type":"number","description":"Abweichende Menge für Chargen"},"serialNumberId":{"type":"integer","format":"int64","description":"ID der zu produzierenden Seriennummer (nur zur gezielten Produktion von bereits definierten Seriennummern)"},"serialNumber1":{"type":"string","description":"Seriennummer 1"},"serialNumber2":{"type":"string","description":"Seriennummer 2"},"expiryDate":{"type":"string","format":"date","description":"MHD / Verfallsdatum"},"note":{"type":"string","description":"Bemerkung"}}},"erp-fabrication-FabricationComponentForProduction":{"description":"Für die Produktion zu verwendendes Material","properties":{"serialNumberId":{"type":"integer","format":"int64","description":"Zu produzierende Seriennummer, für die die Komponente verwendet werden"},"documentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente"},"articleSerialNumberId":{"type":"integer","format":"int64","description":"ID einer Seriennummer"},"quantity":{"type":"number","description":"Zu verwendende Menge"}},"required":["documentLineComponentId","quantity"]},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}}}}} ``` ## POST /erp/fabrication/{fabricationOrderId}/mark-as-not-defective/{lineId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/mark-as-not-defective/{lineId}":{"post":{"tags":["Produktion"],"operationId":"markAsNotDefective","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID der als nicht mehr fehlerhaft zu markierenden Position","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-fabrication-FabricationDefectiveRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-Document"}}}}}}}},"components":{"schemas":{"erp-fabrication-FabricationDefectiveRequest":{"description":"Details zur Markierung einer Position als (nicht mehr) defekt","properties":{"quantity":{"type":"number","default":1,"description":"(Nicht mehr) defekte Menge"},"serialNumberIdsWithQuantity":{"type":"array","description":"(Nicht mehr) defekte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-SerialNumberWithQuantityApi"}},"createLineForReproduction":{"type":"boolean","default":false,"description":"Soll eine neue Position zur Nachproduktion der defekten Artikel erstellt werden?"}}},"erp-fabrication-SerialNumberWithQuantityApi":{"description":"Seriennummer mit Menge","properties":{"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Menge"}}},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}}}}} ``` ## GET /erp/fabrication/{fabricationOrderId}/mark-as-defective/{lineId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/mark-as-defective/{lineId}":{"get":{"tags":["Produktion"],"operationId":"getDetailsForDefectiveMarking","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID der als fehlerhaft zu markierenden Position","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-fabrication-DetailsForDefectiveMarking"}}}}}}}},"components":{"schemas":{"erp-fabrication-DetailsForDefectiveMarking":{"description":"Details zur Markierung von fehlerhaften Positionen","properties":{"documentId":{"type":"integer","format":"int64","description":"ID des Belegs"},"documentLineId":{"type":"integer","format":"int64","description":"ID der Belegposition"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantityInQA":{"type":"number","description":"Noch zu prüfende Menge"},"quantityDefective":{"type":"number","description":"Bereits als defekt markierte Menge"},"requiredSerialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"serialNumbersInQA":{"type":"array","description":"Seriennummern in QS","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"defectiveSerialNumbers":{"type":"array","description":"Defekte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}}}}} ``` ## POST /erp/fabrication/{fabricationOrderId}/mark-as-defective/{lineId} > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/mark-as-defective/{lineId}":{"post":{"tags":["Produktion"],"operationId":"markAsDefective","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"lineId","in":"path","description":"ID der als fehlerhaft zu markierenden Position","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-fabrication-FabricationDefectiveRequest"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-document-Document"}}}}}}}},"components":{"schemas":{"erp-fabrication-FabricationDefectiveRequest":{"description":"Details zur Markierung einer Position als (nicht mehr) defekt","properties":{"quantity":{"type":"number","default":1,"description":"(Nicht mehr) defekte Menge"},"serialNumberIdsWithQuantity":{"type":"array","description":"(Nicht mehr) defekte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-SerialNumberWithQuantityApi"}},"createLineForReproduction":{"type":"boolean","default":false,"description":"Soll eine neue Position zur Nachproduktion der defekten Artikel erstellt werden?"}}},"erp-fabrication-SerialNumberWithQuantityApi":{"description":"Seriennummer mit Menge","properties":{"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Menge"}}},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-document-Document":{"description":"document to update","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Belegnummer","maxLength":255,"minLength":0},"accountNumber":{"type":"string","description":"Kontonummer der zugehörigen Organisationseinheit","maxLength":255,"minLength":0,"readOnly":true},"customerNumber":{"type":"string","description":"Kundennummer","maxLength":255,"minLength":0,"readOnly":true},"ourCustomerNumber":{"type":"string","description":"Kundennummer beim Lieferanten","maxLength":255,"minLength":0,"readOnly":true},"supplierNumber":{"type":"string","description":"Lieferantennummer","maxLength":255,"minLength":0,"readOnly":true},"salesAgentNumber":{"type":"string","description":"Vertreternummer","maxLength":255,"minLength":0,"readOnly":true},"externalIdentifier":{"type":"string","description":"Externe Kennung","maxLength":255,"minLength":0},"externalNumber":{"type":"string","description":"Externe Belegnummer","maxLength":255,"minLength":0},"published":{"type":"boolean","default":false,"description":"Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?","readOnly":true},"frozen":{"type":"boolean","default":false,"description":"Ist der Beleg festgeschrieben?","readOnly":true},"qualifier":{"type":"string","description":"Art des Belegs","enum":["SALE","PURCHASE","COMMISSION","SALES_CONTRACT","PURCHASE_CONTRACT","POINT_OF_SALE","FABRICATION","RMA"],"readOnly":true},"accountId":{"type":"string","description":"ID der Organisationseinheit"},"billingAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"documentDate":{"type":"string","format":"date","description":"Belegdatum"},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"valueDate":{"type":"string","format":"date","description":"Valutadatum"},"taxable":{"type":"boolean","default":true,"description":"Steuerpflichtig oder steuerfrei"},"taxIdentificationNumber":{"type":"string","description":"Umsatzsteuer-Identifikationsnummer","maxLength":255,"minLength":0},"taxIdVerificationState":{"type":"string","description":"Überprüfungsstatus der Steueridentifikationsnummer","enum":["NOT_YET_VERIFIED","VALID","VALID_WITH_INVALID_ADDRESS","INVALID","NOT_NEEDED"],"readOnly":true},"valitoolValidationState":{"type":"string","description":"Validierungsstatus bei elektronischen Rechnungen","enum":["NOT_VALIDATED","VALID","NOT_VALID"],"readOnly":true},"billingType":{"type":"string","description":"Abrechnungstyp","enum":["GROSS","NET"]},"documentType":{"type":"string","description":"Belegtyp (intern)","readOnly":true},"documentTypeId":{"type":"integer","format":"int64","description":"ID des Belegtyps","readOnly":true},"documentTypeCategory":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"],"readOnly":true},"documentState":{"$ref":"#/components/schemas/erp-document-DocumentTypeState"},"currencyCode":{"type":"string","description":"Währung (ISO-Code, Alpha-3)"},"exchangeRate":{"type":"number","description":"Wechselkurs"},"exchangeRateOrigin":{"type":"string","default":"AUTOMATIC","description":"Ursprung für Währungskursermittlung","enum":["AUTOMATIC","AUTOMATIC_FOR_CURRENT_DATE","USER_DEFINED"]},"responsibleUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"totalBeforeModifier":{"type":"number","description":"Gesamtpreis vor Rabatt [BRUTTO, NETTO]","readOnly":true},"totalPriceModifier":{"type":"number","description":"Rabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalLinePriceModifier":{"type":"number","description":"Positionsrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Belegrabatt gesamt [BRUTTO, NETTO]","readOnly":true},"totalNetPrice":{"type":"number","description":"Gesamtpreis netto","readOnly":true},"totalVat":{"type":"number","description":"Gesamte Mehrwertsteuer","readOnly":true},"totalGrossPrice":{"type":"number","description":"Gesamtpreis brutto","readOnly":true},"roundingAmount":{"type":"number","description":"Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)","readOnly":true},"paymentTermRef":{"$ref":"#/components/schemas/erp-document-PaymentTermRef"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"depositPaymentAmount":{"type":"number","description":"Vereinbarter Anzahlungsbetrag"},"depositPaymentDate":{"type":"string","format":"date","description":"Vereinbartes Anzahlungsdatum","readOnly":true},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryDate":{"type":"string","format":"date","description":"Voraussichtliches Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"Bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryQuantityPackages":{"type":"integer","format":"int32","description":"Voraussichtliche Paketanzahl (nur Info)"},"deliveryText":{"type":"string","description":"Zusätzlicher Liefertext","maxLength":255,"minLength":0},"deliveryApproved":{"type":"boolean","default":true,"description":"Ist der Beleg zur Lieferung freigegeben?"},"dropShippingInvoiceApproved":{"type":"boolean","description":"Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?","readOnly":true},"orderedOn":{"type":"string","format":"date","description":"Bestelldatum"},"orderedByPersonRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderedBy":{"type":"string","description":"Name der bestellenden Person","maxLength":255,"minLength":0},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"Reverse-Charge-Verfahren nach §13b UStG?"},"collectiveInvoice":{"type":"boolean","default":false,"description":"Sammelrechnung?"},"texts":{"type":"array","description":"Liste der Belegtexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"lines":{"type":"array","description":"Liste der Belegpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLine"}},"shippingCosts":{"type":"array","description":"Versandkostenpositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentShippingCost"}},"posPayments":{"type":"array","description":"Kassen-Zahlungspositionen","items":{"$ref":"#/components/schemas/erp-document-DocumentPosPayment"}},"shippingCostSum":{"type":"number","description":"Summe der Versandkosten (netto/brutto)","readOnly":true},"priceModifiers":{"type":"array","description":"Preisänderungen (z.B. Rabatte)","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"taxes":{"type":"array","description":"Steuerzusammenfassung für diesen Beleg","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"},"readOnly":true},"defaultAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"billingAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"deliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"returnDeliveryAddress":{"$ref":"#/components/schemas/erp-document-DocumentAddress"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"stackProcessingType":{"type":"string","description":"Stapelverarbeitungsinformationen für Aufträge","enum":["NO_PICKING","ACCORDING_TO_CRITERIA","ONLY_FULL_ORDER","ONLY_FULL_ORDER_LINES","AVAILABLE_QUANTITIES","NO_PROCESSING","FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES","FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES","AVAILABLE_QUANTITIES_FINISH_ORDER"]},"stackProcessingPriority":{"type":"integer","format":"int32","description":"Priorität in der Stapelverarbeitung"},"maxDeliveries":{"type":"integer","format":"int32","description":"Maximal mögliche Lieferungen"},"taxPerformanceLocation":{"type":"string","description":"Ort der steuerlichen Leistungserbringung","enum":["DOMESTIC","EUROPEAN_COMMUNITY","INTERNATIONAL"]},"performanceCountryCode":{"type":"string","description":"Länderkennzeichen Leistungsland (ISO Alpha-3)"},"sourceCountryCode":{"type":"string","description":"Länderkennzeichen Ursprungsland (ISO Alpha-3)"},"afterPickingTargetDocumentTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"grossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"userDefinedWeight":{"type":"boolean","default":false,"description":"Gesamtgewicht wurde manuell gesetzt"},"tags":{"type":"array","description":"Tags für diesen Beleg","items":{"$ref":"#/components/schemas/common-tag-TagDto"}},"reportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defaultStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDiscountableTotalGrossPrice":{"type":"number","description":"Skontofähiger Bruttogesamtbetrag","readOnly":true},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentPosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentFabricationDetail"},"buyerReference":{"type":"string","description":"Leitweg-ID","maxLength":255,"minLength":0},"en16931Profile":{"type":"string","description":"EN16931-Profil für elektronische Rechnungen","enum":["ZUGFERD","XRECHNUNG","NO_EN_PROFILE"]},"importType":{"type":"string","description":"Importmodus des Belegs","enum":["NOT_IMPORTED","TRANSFERABLE","TRANSFERABLE_AND_EDITABLE","HISTORICAL_DATA","E_INVOICE","EXTERNALLY_CREATED"],"readOnly":true},"paymentPlan":{"type":"boolean","default":false,"description":"Zahlungsplan vorhanden?"},"calculationMode":{"type":"string","description":"Berechnungsmodus","enum":["HORIZONTAL","VERTICAL"]},"processedByWorkflow":{"type":"boolean","description":"Wird vom Workflow verarbeitet?","readOnly":true},"referencedOrderNumber":{"type":"string","description":"Bestellnummer aus Vorbeleg","readOnly":true},"additionalInfo":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo"},"languageCode":{"type":"string","description":"Sprache"},"baseCurrencyCode":{"type":"string","description":"Basiswährung des Belegs"},"baseTotalNetPrice":{"type":"number","description":"Gesamtpreis - Netto Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Belegpositionssumme Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - Beleg Basiswährung"},"baseTotalGrossPrice":{"type":"number","description":"Gesamtpreis - Brutto Basiswährung"},"baseDepositPaymentAmount":{"type":"number","description":"Vorkassebetrag Basiswährung"},"baseCashDiscountableTotalGrossPrice":{"type":"number","description":"skontierbarer Rechnungsbetrag Basiswährung"},"forwardEmailToShipper":{"type":"boolean","default":false,"description":"E-Mail an Versender übergeben"},"forwardPhoneToShipper":{"type":"boolean","default":false,"description":"Telefon an Versender übergeben"},"posReceiptPaymentSum":{"type":"number","description":"Quittung: Summe Zahlbetrag"},"posReceiptBalance":{"type":"number","description":"Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n"},"posReceiptChangeAmount":{"type":"number","description":"Rückgeld"},"posReceiptBalanced":{"type":"boolean","default":false,"description":"Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n"},"posReceiptPayed":{"type":"boolean","default":false,"description":"Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n"},"dropShipping":{"type":"boolean","description":"Streckengeschäft","readOnly":true},"totalGrossVolumeInCubicMeters":{"type":"number","description":"total gross Volume in cubic meters","readOnly":true}},"required":["accountId","billingType","calculationMode","currencyCode","defaultAddress","deliveryApproved","documentDate","number"]},"erp-document-DocumentTypeState":{"description":"Statusinstanz des Belegs","properties":{"label":{"type":"string","description":"label/name of this state"},"key":{"type":"string","description":"unique key for this state"},"definition":{"type":"string","description":"additional state information","enum":["SELECTABLE_TYPES","EDITABLE","DELETED"]}},"required":["key","label"]},"erp-document-PaymentTermRef":{"description":"Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true},"paymentType":{"type":"string","description":"payment type","enum":["PREPAYMENT","PAYMENT","DEPOSIT"]}},"required":["id","paymentType"]},"erp-document-DocumentText":{"description":"Texte","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"textPosition":{"type":"string","default":"HEADER_TEXT","description":"position relative to the product line OR Document. For usage within text-line, this position is irrelevant","enum":["HEADER_TEXT","FOOTER_TEXT"]},"content":{"type":"string","description":"if this attribute is used, the text is used as free-text"},"textTemplateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"transferableIntoSubsequentDocuments":{"type":"boolean","default":true,"description":"Does this text remain after transfer into a subsequent document"},"deleted":{"type":"boolean","default":false,"description":"Wurde entfernt und soll deshalb nicht mehr angezeigt werden."},"initialized":{"type":"boolean","description":"ist der content befüllt?","readOnly":true}},"required":["deleted"]},"erp-document-DocumentLine":{"description":"Liste der Belegpositionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer","readOnly":true},"positionOfArticleLine":{"type":"integer","format":"int32","description":"Positionsnummer über alle Artikelpositionen hinweg","readOnly":true},"articleId":{"type":"string","description":"Artikel"},"lineType":{"type":"string","description":"Positionstyp","enum":["ARTICLE_LINE","ALTERNATIVE_POSITION","LINK_POSITION","OPTIONAL_POSITION","TEXT_LINE","SHIPPING_COST_LINE","SUBTOTAL","POS","ROUNDING_LINE","OPEN_ITEM_SETTLEMENT","ON_ACCOUNT_PAYMENT"]},"productType":{"type":"string","description":"Artikelarten","enum":["WITH_STOCK","WITHOUT_STOCK","SERVICE_ARTICLE","SERVICE_CONTINGENT","ASSEMBLY_GROUP","JUMBO","SHIPPING_COSTS","VARIANT_MAIN_ARTICLE"]},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"number":{"type":"string","description":"Artikelnummer","maxLength":255,"minLength":0},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2147483647,"minLength":0},"unitType":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"price":{"type":"number","description":"Preis pro Menge [Brutto, Netto]"},"priceUnit":{"type":"number","description":"Preiseinheit"},"priceOrigin":{"type":"string","description":"Preisherkunft","enum":["USER_DEFINED","PRODUCT","PREDECESSOR_DOCUMENT","PICKLIST"],"readOnly":true},"priceSelectionCriteria":{"$ref":"#/components/schemas/erp-product-PriceSelectionCriteria"},"quantity":{"type":"number","description":"Menge"},"quantityCommitted":{"type":"number","description":"verarbeitete Menge","readOnly":true},"pickingQuantity":{"type":"number","description":"Menge in Pick-Vorgang","readOnly":true},"preOrderPickedQuantity":{"type":"number","description":"vorgeorderte Menge in Pickvorgang","readOnly":true},"complete":{"type":"boolean","default":false,"description":"ist diese Position komplett verarbeitet?","readOnly":true},"taxSchemaRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"totalLinePriceModifier":{"type":"number","description":"Summe Positionspreisänderungen [Brutto, Netto]","readOnly":true},"totalDocumentPriceModifier":{"type":"number","description":"Summe Dokumentpreisänderungen [Brutto, Netto]","readOnly":true},"priceModifiers":{"type":"array","description":"angewendete Preisänderungen","items":{"$ref":"#/components/schemas/erp-document-DocumentPriceModifier"}},"salesValueNet":{"type":"number","description":"Netto-Gesamtpreis (nach Preisänderungen)","readOnly":true},"vat":{"type":"number","description":"Steuerbetrag","readOnly":true},"totalLinePrice":{"type":"number","description":"Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte","readOnly":true},"texts":{"type":"array","description":"Positionstexte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"shippingCostDetail":{"$ref":"#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"country":{"$ref":"#/components/schemas/common-masterdata-CountryReference"},"countryRegion":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customsTariffNumber":{"type":"string","description":"Zolltarifnummer","maxLength":15,"minLength":0},"deliveryDate":{"type":"string","format":"date","description":"Lieferdatum"},"deliveryDateEnd":{"type":"string","format":"date","description":"vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)"},"confirmedDeliveryDate":{"type":"string","format":"date","description":"bestätigtes Lieferdatum"},"confirmedDeliveryDateEnd":{"type":"string","format":"date","description":"bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)"},"shippingDate":{"type":"string","format":"date","description":"Versanddatum"},"deliveryText":{"type":"string","description":"Liefertext","maxLength":255,"minLength":0},"packageOptions":{"type":"string","description":"Versenderspezifische Informationen"},"externalReferenceVds":{"type":"string","description":"Externe Referenz zum VDS-Paket","maxLength":255,"minLength":0},"netWeight":{"type":"number","description":"Nettogewicht"},"totalNetWeight":{"type":"number","description":"Gesamtnettogewicht"},"netWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"grossWeight":{"type":"number","description":"Bruttogewicht"},"totalGrossWeight":{"type":"number","description":"Gesamtbruttogewicht"},"grossWeightUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"capacity":{"type":"number","description":"Inhalt der Maßeinheit"},"capacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"baseCapacity":{"type":"number","description":"Inhalt der Grundeinheit"},"baseCapacityUnit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"sourceLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"baseLineId":{"type":"integer","format":"int64","description":"Referenz zur Basiszeile"},"mainArticleLineRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"settledOpenItemBalance":{"type":"number","description":"Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemPaymentDueDate":{"type":"string","format":"date","description":"Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemDiscountAmount":{"type":"number","description":"Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)"},"settledOpenItemComment":{"type":"string","description":"Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen"},"customerOrderLineRef":{"$ref":"#/components/schemas/erp-document-DocumentLineRef"},"supplierOrderLineIds":{"type":"array","description":"Referenz zur Lieferantenbestellungszeile","items":{"type":"integer","format":"int64","description":"Referenz zur Lieferantenbestellungszeile"}},"storage":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"components":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-document-DocumentLineComponent"}},"fabricationComponents":{"type":"array","description":"Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationComponent"}},"bookings":{"type":"array","description":"Buchungen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"commissions":{"type":"array","description":"Provisionen","items":{"$ref":"#/components/schemas/erp-document-DocumentLineCommission"}},"previousDecisions":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"articleTaxLiabilityReversed":{"type":"boolean","default":false,"description":"Vorgabe §13b UStG Artikel","readOnly":true},"taxLiabilityReversed":{"type":"boolean","default":false,"description":"wird §13b UStG angewendet?","readOnly":true},"presetPrice":{"type":"number","description":"Vorgabewert für die Preiskalkulation","readOnly":true},"calculationData":{"type":"string","description":"Kalkulationsstruktur"},"revenueCalculation":{"$ref":"#/components/schemas/erp-document-RevenueCalculation"},"commissionOrigin":{"type":"string","description":"Provisionsursprung","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"cashDiscountable":{"type":"boolean","default":true,"description":"skontierbare Position?"},"discountable":{"type":"boolean","default":true,"description":"rabattierbare Position?"},"commissionable":{"type":"boolean","default":false,"description":"provisionierbare Position?"},"warrantyInMonths":{"type":"integer","format":"int32","description":"Garantie in Monaten"},"contractDetail":{"$ref":"#/components/schemas/erp-document-DocumentContractDetail"},"posDetail":{"$ref":"#/components/schemas/erp-document-DocumentLinePosDetail"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetail"},"returnDetail":{"$ref":"#/components/schemas/erp-document-DocumentLineReturnDetail"},"financeBooking":{"$ref":"#/components/schemas/erp-document-DocumentFinanceBooking"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"variantValues":{"type":"array","description":"Produktvariantenwerte","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"performanceDate":{"type":"string","format":"date","description":"Leistungsdatum"},"basePrice":{"type":"number","description":"Preis pro Einheit in Basiswährung"},"baseTotalLinePriceModifier":{"type":"number","description":"Preisanpassungen - Position Basiswährung"},"baseTotalDocumentPriceModifier":{"type":"number","description":"Preisanpassungen - anteilig durch Beleg Basiswährung"},"baseTotalLinePrice":{"type":"number","description":"Gesamtpreis Position in Basiswährung"},"baseSalesValueNet":{"type":"number","description":"Nettoverkaufswert der Position in Basiswährung"},"progressInvoice":{"type":"boolean","default":false,"description":"Abschlagsposition?"},"dropShippingPolicy":{"type":"string","description":"Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf","enum":["ANY","DROP_SHIPPING","STORAGE","STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING"]},"unitGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters"},"totalGrossVolumeInCubicMeters":{"type":"number","description":"unit gross Volume in cubic meters","readOnly":true},"convertedIntoBundleArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"insertTerm":{"type":"string","description":"Zubehör Einfügeart","enum":["MANUAL","AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED","AUTOMATIC_PROPORTIONAL_QUANTITY","AUTOMATIC_FIXED_QUANTITY"]},"hasAccessories":{"type":"boolean","default":false,"description":"Hat der Artikel Zubehör?"},"recalcLinePriceViaComponents":{"type":"boolean","default":false,"description":"Soll die DocumentLine über die Komponenten neu berechnet werden?"},"doPrintLabel":{"type":"boolean","description":"Soll zu der Position Etiketten gedruckt werden."}},"required":["lineType"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-product-PriceSelectionCriteria":{"description":"Preisermittlungskriterien","properties":{"qualifier":{"type":"string","description":"ein qualifier","enum":["SALES","PURCHASE"]},"articleIds":{"type":"array","description":"Liste von Artikel-IDs","items":{"type":"integer","format":"int64","description":"Liste von Artikel-IDs"}},"selectOnlyDefaultPrice":{"type":"boolean","default":false,"description":"soll nur der Standardpreis selektiert werden?"},"accountIds":{"type":"array","description":"Liste von Account-IDs","items":{"type":"integer","format":"int64","description":"Liste von Account-IDs"}},"productGroupId":{"type":"integer","format":"int64","description":"Die Warengruppe"},"priceGroupId":{"type":"integer","format":"int64","description":"Die Preisgruppe"},"date":{"type":"string","format":"date","description":"Ein Datum"},"quantity":{"type":"number","description":"Eine Menge"},"noteSpecialOfferPrice":{"type":"boolean","description":"Aktionspreis beachten?"}}},"erp-document-DocumentTax":{"description":"Steuerzusammenfassung für diesen Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"taxRateRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"taxableAmount":{"type":"number","description":"taxable amount"},"taxValue":{"type":"number","description":"tax value"},"grossAmount":{"type":"number","description":"gross amount"},"taxType":{"type":"string","description":"Steuer-Typ","enum":["VAT"]},"taxFree":{"type":"boolean","default":false,"description":"Steuerfrei?"},"baseTaxableAmount":{"type":"number","description":"Besteuerbarer Betrag in Basiswährung"},"baseTaxValue":{"type":"number","description":"Steuerbetrag in Basiswährung"},"baseGrossAmount":{"type":"number","description":"Bruttobetrag in Basiswährung"}}},"erp-document-DocumentPriceModifier":{"description":"Preisänderungen (z.B. Rabatte)","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"name":{"type":"string","description":"Name of modifier"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Value"},"calculatedValue":{"type":"number","description":"calculated discount/surcharge"},"sourceType":{"type":"string","description":"Source of price modifier","enum":["CUSTOM","PRODUCT","DISCOUNT_GROUP"]},"sourceId":{"type":"integer","format":"int64","description":"ID of Source entity of price modifier"},"modifierType":{"type":"string","description":"modifierType","enum":["DISCOUNT","SURCHARGE"]},"baseValue":{"type":"number","description":"Wert des Modifiers in Basiswährung"},"baseCalculatedValue":{"type":"number","description":"Berechneter Wert des Modifiers in Basiswährung"}},"required":["modifierType","value","valueType"]},"erp-document-RequestDocumentLineShippingCostDetail":{"description":"Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)","properties":{"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"purchasePrice":{"type":"number","description":"Einkaufspreis in Basiswährung"}}},"common-masterdata-CountryReference":{"description":"Land (Iso-A-2)","properties":{"id":{"type":"integer","format":"int64","description":"ID des Landes"},"isoAlpha2":{"type":"string","description":"IsoAlpha2-Code des Landes"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code des Landes"},"label":{"type":"string","description":"Bezeichnung des Landes","readOnly":true}}},"erp-document-DocumentLineRef":{"description":"Referenz auf eine Documentline","properties":{"id":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"documentId":{"type":"integer","format":"int64","description":"Id des Dokuments"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"},"articleNumber":{"type":"string","description":"Artikelnummer"},"position":{"type":"integer","format":"int32","description":"Positions-Nummer"},"name":{"type":"string","description":"Artikelbezeichnung","maxLength":2147483647,"minLength":0},"quantity":{"type":"number","description":"quantity"},"price":{"type":"number","description":"price per quantity [GROSS, NET]"},"displayName":{"type":"string","description":"Kurzbezeichnung des Kunden"}},"required":["id"]},"erp-document-DocumentLineComponent":{"description":"Komponenten","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleId":{"type":"string","description":"Referenz auf den Artikel der Komponente"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"],"readOnly":true},"quantity":{"type":"number","description":"Menge"},"price":{"type":"number","description":"Einzelpreis"},"quantityCommitted":{"type":"number","description":"Gelieferte Menge"},"pickingQuantity":{"type":"number","description":"Menge in Kommissionierung"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe"},"name":{"type":"string","description":"Name des Artikels","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung des Artikels","maxLength":2048,"minLength":0},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"Referenz auf die Komponente im Quell-Document"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentLineBooking"}},"texts":{"type":"array","description":"Texte zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"fabricationDetail":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail"}},"required":["quantity"]},"erp-document-DocumentLineBooking":{"description":"Buchungen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"storageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Gebuchte Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["quantity","storageBinRef"]},"erp-fabrication-DocumentLineComponentFabricationDetail":{"description":"Produktionsdetails zu einer Komponente","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialInheritanceComponent":{"type":"boolean","default":false,"description":"Für S/N-Vererbung verwenden"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"erp-fabrication-DocumentLineFabricationComponent":{"description":"Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"position":{"type":"integer","format":"int32","description":"Position"},"componentArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"sourceBundleArticleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"quantity":{"type":"number","description":"Menge"},"deviatingUnitRef":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"},"deviatingUnitPrice":{"type":"number","description":"Abweichende Herstellungskosten"},"forSerialInheritance":{"type":"boolean","default":false,"description":"Basis für die Vererbung der Seriennummer"},"name":{"type":"string","description":"Bezeichnung","maxLength":255,"minLength":0},"description":{"type":"string","description":"Beschreibung","maxLength":2147483647,"minLength":0}},"required":["componentArticleRef","quantity"]},"erp-document-DocumentLineCommission":{"description":"Provisionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"salesAgentAccountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"description":{"type":"string","description":"Beschreibung"},"comment":{"type":"string","description":"Kommentar"},"valueType":{"type":"string","description":"Typ von Werten","enum":["PERCENT","FIX"]},"value":{"type":"number","description":"Provision Prozent/Wert"},"origin":{"type":"string","description":"Herkunft","enum":["NOT_COMMISSIONABLE","USER_DEFINED","AUTOMATIC","PREDECESSOR","RECALCULATE"]},"valueCurrencyCode":{"type":"string","description":"the currency-code IsoAlpha3"}},"required":["origin","salesAgentAccountRef","value","valueType"]},"erp-document-RevenueCalculation":{"description":"Rohertragsermittlung","properties":{"productPurchasePrice":{"type":"number","description":"Einkaufspreis","readOnly":true},"salesValue":{"type":"number","description":"Netto Umsatz","readOnly":true},"revenue":{"type":"number","description":"Deckungsbeitrag (absolut)","readOnly":true},"revenueInPercent":{"type":"number","description":"Deckungsbeitrag (Prozent)","readOnly":true}}},"erp-document-DocumentContractDetail":{"description":"Vertragsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Vertragsstart (nur Kopf)"},"endDate":{"type":"string","format":"date","description":"Vertragsende (nur Kopf)"},"runtimeFromDate":{"type":"string","format":"date","description":"Laufzeit von"},"runtimeToDate":{"type":"string","format":"date","description":"Laufzeit bis"},"lastCustomerCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Kunden"},"lastProviderCancellationDate":{"type":"string","format":"date","description":"Letztmöglicher kündigungstermin des Anbieters"},"dueDateCalculation":{"type":"string","description":"Cron-Ausdruck zur Berechnung der Fälligkeit"},"dueDate":{"type":"string","format":"date","description":"Fälligkeit"},"nextDueDate":{"type":"string","format":"date","description":"Nächste Fälligkeit"},"calculateDirectly":{"type":"boolean","description":"Direkt abrechnen?"},"active":{"type":"boolean","default":true,"description":"Vertrag aktiv?"},"publishInPortal":{"type":"boolean","default":false,"description":"Portal anzeigen?"}},"required":["dueDateCalculation"]},"erp-document-DocumentLinePosDetail":{"description":"Kasseninformationen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeId":{"type":"integer","format":"int64","description":"Typ der Einlage/Ausgabe"},"paymentMethodId":{"type":"integer","format":"int64","description":"Zahlungsart"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend"},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"]},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)"},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"]},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)"},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"],"readOnly":true},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag (Modus MANUAL)","readOnly":true},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt","readOnly":true}}},"erp-fabrication-DocumentLineFabricationDetail":{"description":"Produktionsdetails zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumbers":{"type":"array","description":"Produzierte Seriennummern","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber"}},"quantityCommitted":{"type":"number","description":"Menge produziert"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-fabrication-DocumentLineFabricationDetailSerialNumber":{"description":"Produzierte Seriennummern zu einer Position","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"},"quantity":{"type":"number","description":"Produzierte/geplante Menge"},"quantityCommitted":{"type":"number","description":"Tatsächlich produzierte Menge"},"quantityInQA":{"type":"number","description":"Menge in QS"},"quantityDefective":{"type":"number","description":"Menge defekt"},"quantityFinished":{"type":"number","description":"Menge abgeschlossen"},"bookedComponents":{"type":"array","description":"Gebuchte Komponenten","items":{"$ref":"#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent"}}},"required":["quantity","quantityCommitted","serialNumber"]},"erp-fabrication-DocumentLineFabricationBookedComponent":{"description":"Gebuchte Komponenten zu einer produzierten Seriennummer","properties":{"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"number":{"type":"string","description":"Nummer des Artikels"},"name":{"type":"string","description":"Name des Artikels"},"description":{"type":"string","description":"Beschreibung des Artikels"},"quantity":{"type":"number","description":"Verwendete Menge"},"serialNumberRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"erp-document-DocumentLineReturnDetail":{"description":"Retouren-Details für eine Belegposition","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"returnCategory":{"type":"string","description":"Retouren-Kategorie","enum":["MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER","MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK","GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER","GOODS_EXCHANGE_ITEM_GETS_SEND_BACK","UNDECIDED"]},"goodsExchangeArticleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"waitForReturnBeforeExchange":{"type":"boolean","description":"Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"repairRequested":{"type":"boolean","description":"Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)"},"warrantyExchange":{"type":"boolean","description":"Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"replacementDeliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"returnCauseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"customerShareOnSurcharge":{"type":"number","description":"Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?"},"customerShareOnReduction":{"type":"number","description":"Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?"}}},"erp-document-DocumentFinanceBooking":{"description":"FiBu-Buchung","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"documentLineId":{"type":"integer","format":"int64","description":"Id der Dokumentzeile"},"ledgerNumber":{"type":"string","description":"FiBu-Kontonummer"},"transactionKey":{"type":"string","description":"Buchungsschlüssel"},"costCenter1":{"type":"string","description":"Kostenstelle"},"comment":{"type":"string","description":"Kommentar"},"description":{"type":"string","description":"Buchungstext"}}},"erp-document-DocumentShippingCost":{"description":"Versandkosten im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"costs":{"type":"number","description":"Die Versandkosten"},"manualCosts":{"type":"boolean","default":false,"description":"Wurden die Versandkosten manuell eingetragen?"},"freeShipping":{"type":"boolean","default":false,"description":"Keine Versandkosten (freier Versand)"},"name":{"type":"string","description":"Artikelname"},"description":{"type":"string","description":"Artikelbeschreibung"},"texts":{"type":"array","description":"Texte","items":{"$ref":"#/components/schemas/erp-document-DocumentText"}},"taxes":{"type":"array","description":"Steuern","items":{"$ref":"#/components/schemas/erp-document-DocumentTax"}},"purchasePrice":{"type":"number","description":"Einkaufspreis"},"discountable":{"type":"boolean","description":"rabattierbar"},"cashDiscountable":{"type":"boolean","description":"skontierbar"}}},"erp-document-DocumentPosPayment":{"description":"Kassen-Zahlung im Beleg","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"amount":{"type":"number","description":"Betrag"},"posLineType":{"type":"string","description":"Typ der Position","enum":["CASH_PAYMENT","CASH_CHANGE","CARD_PAYMENT","CASH_START_BALANCE","CASH_FINAL_BALANCE","CASH_DEPOSIT","CASH_EXPENSE","CASH_WITHDRAWAL"]},"depositExpenseTypeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"posPaymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"externalPaymentId":{"type":"string","description":"Externe Payment-ID für Verbindung zum Payment-Backend","readOnly":true},"externalPaymentStatus":{"type":"string","description":"Status der externen Zahlung","enum":["PENDING","PROCESSING","SUCCESSFUL","CANCELLED","REJECTED"],"readOnly":true},"externalPaymentErrorMessage":{"type":"string","description":"Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)","readOnly":true},"paymentOperation":{"type":"string","description":"Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)","enum":["PAYMENT","CANCEL","REFUND"],"readOnly":true},"cancelledExternalPaymentId":{"type":"string","description":"Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)","readOnly":true},"withdrawalMode":{"type":"string","description":"Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss","enum":["FULL","BALANCE","MANUAL","NONE"]},"balanceBeforeWithdrawal":{"type":"number","description":"Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)","readOnly":true},"withdrawalAmount":{"type":"number","description":"Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet"},"withdrawToBalance":{"type":"number","description":"Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt"}},"required":["amount","posLineType"]},"erp-document-DocumentAddress":{"description":"Retoure-Lieferadresse","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"accountRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salutation":{"type":"string","description":"salutation for this address"},"title":{"type":"string","description":"Titel"},"name1":{"type":"string","description":"address line 1"},"name2":{"type":"string","description":"address line 2"},"name3":{"type":"string","description":"address line 3"},"globalLocationNumber":{"type":"string","description":"GLN"},"street":{"type":"string","description":"Street"},"streetAddressNumber":{"type":"string","description":"Street address number"},"additionalAddressLine1":{"type":"string","description":"Additional address line1"},"additionalAddressLine2":{"type":"string","description":"Additional address line2"},"city":{"type":"string","description":"city"},"regionRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"postcode":{"type":"string","description":"Postcode"},"postOfficeBox":{"type":"string","description":"Post office box"},"countryCode":{"type":"string","description":"country code IsoAlpha3"},"phoneContact":{"type":"string","description":"Phone contact"},"mailContact":{"type":"string","description":"Mail contact"},"languageCode":{"type":"string","description":"Language Code"},"paymentTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"paymentMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryTermRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"deliveryMethodRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}}},"common-tag-TagDto":{"description":"List of tags","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"type":{"type":"string","description":"Tag-Typen","enum":["COMMON","ACCOUNT","PRODUCT","DOCUMENT","OPEN_ITEM","CRM_COMMON","CRM_TASK","CRM_DEAL","CRM_PROJECT","DMS_SHELF_DOCUMENT"]},"label":{"type":"string","description":"Beschriftung des Tags"},"color":{"type":"string","description":"Farbe für die Anzeige des Tags"},"editColor":{"type":"string","description":"Farbe in Verwaltungs-GUI"},"searchColor":{"type":"string","description":"Farbe in Such-GUI"},"tagGroup":{"$ref":"#/components/schemas/core-api-ApiCreatableReference"}},"required":["label","type"]},"core-api-ApiCreatableReference":{"description":"Relation type","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label"},"description":{"type":"string","description":"a short description","readOnly":true}}},"erp-document-DocumentPosDetail":{"description":"Quittungsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"posRegisterRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashDrawerRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"cashJournalRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"fiscalizationBackendRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"tssSignature":{"$ref":"#/components/schemas/erp-pos-TssSignature"},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"timeStart":{"type":"integer","format":"int64","description":"Transaktion Startzeit"},"timeEnd":{"type":"integer","format":"int64","description":"Transaktion Endzeit"},"clientSerialNumber":{"type":"string","description":"Client Seriennummer"},"tssSerialNumber":{"type":"string","description":"TSS Seriennummer"},"transactionNumber":{"type":"integer","format":"int64","description":"Transaktionsnummer"},"revision":{"type":"integer","format":"int32","description":"Revision"},"signatureCounter":{"type":"integer","format":"int64","description":"Signaturzähler"},"signature":{"type":"string","description":"Signatur"}}},"erp-pos-TssSignature":{"description":"TSS Signatur","properties":{"status":{"type":"string","description":"Status der Signierung","enum":["FINISHED","ACTIVE","CANCELLED","ERROR"],"readOnly":true},"responseData":{"type":"string","description":"Antwortdaten der TSS","readOnly":true},"externalReference":{"type":"string","description":"Externe Referenz","readOnly":true},"revision":{"type":"integer","format":"int32","description":"Revision","readOnly":true}}},"erp-fabrication-DocumentFabricationDetail":{"description":"Produktionsdetails","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"startDate":{"type":"string","format":"date","description":"Startdatum"},"minimumDegreeOfFulfillment":{"type":"integer","format":"int32","description":"Minimaler Erfüllungsgrad","maximum":100,"minimum":0},"note":{"type":"string","description":"Notiz","maxLength":2147483647,"minLength":0},"componentsStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"workbenchStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"qualityAssuranceStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"defectiveStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"targetStorageBinRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"erp-document-DocumentAdditionalInfo":{"description":"Zusätzliche Infos zu Entscheidungen im Belegkontext","properties":{"calculationModeOrigin":{"type":"string","description":"Herkunft des Berechnungsmodus","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT","FROM_SALES_CHANNEL","FROM_DOCUMENT_PARAMS","USER_DEFINED"],"readOnly":true},"roundingMode":{"type":"string","description":"Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)","enum":["NONE","SWITZERLAND"],"readOnly":true},"en16931Origin":{"type":"string","description":"Herkunft des E-Rechnungs-Profils","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_ACCOUNT_PARAMS","USER_DEFINED"],"readOnly":true},"buyerReferenceOrigin":{"type":"string","description":"Herkunft der Käufer-Referenz","enum":["FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","USER_DEFINED"],"readOnly":true},"previousDecisions":{"type":"string","description":"Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document","readOnly":true},"taxSituationOrigin":{"type":"string","description":"Steuersachverhalt Herkunft","enum":["UNDEFINED","USER_DEFINED","FROM_CUSTOMER","FROM_SUPPLIER","FROM_SALES_AGENT","FROM_DELIVERY_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_OWN_ADDRESS","FROM_TAX_ID"]},"languageCodeOrigin":{"type":"string","description":"Herkunft der Sprache","enum":["FROM_DELIVERY_ADDRESS","FROM_BILLING_ADDRESS","FROM_DEFAULT_ADDRESS","FROM_RETURN_DELIVERY_ADDRESS","FROM_MY_COMPANY"]},"contextParameters":{"type":"array","description":"Parameter, welche im {@link DocumentContext} verwendet wurden","items":{"$ref":"#/components/schemas/common-api-AdditionalParameter"}},"incomingGoodsTarget":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget"},"translations":{"type":"array","description":"Übersetzungen","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField"}},"incomingGoodsTargetsPerLine":{"type":"array","description":"Ziele für den Wareneingang je Belegposition","items":{"$ref":"#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine"}}}},"common-api-AdditionalParameter":{"description":"Zusätzliche Parameter","properties":{"key":{"type":"string","description":"key for this parameter"},"value":{"type":"object","description":"value for this parameter"}},"required":["key"]},"erp-document-DocumentAdditionalInfo.IncomingGoodsTarget":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"}}},"erp-document-DocumentAdditionalInfo.PrintedTranslatedField":{"description":"Übersetzungen","properties":{"entityName":{"type":"string","description":"zur welcher Entity?"},"fieldName":{"type":"string","description":"name des Feldes"},"content":{"type":"string","description":"Übersetzung"}}},"erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine":{"description":"Ziele für den Wareneingang","properties":{"storageBinId":{"type":"integer","format":"int64","description":"Lagerplatz für den Wareneingang"},"pickTrolleyId":{"type":"integer","format":"int64","description":"Pickwagen für den Wareneingang"},"lineId":{"type":"integer","format":"int64","description":"ID einer Belegposition"},"sourceLineId":{"type":"integer","format":"int64","description":"ID einer Vorbelegposition"}}}}}} ``` ## POST /erp/fabrication/{fabricationOrderId}/create-picklist-to-restock-components > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/{fabricationOrderId}/create-picklist-to-restock-components":{"post":{"tags":["Produktion"],"operationId":"createPicklistToRestockComponents","parameters":[{"name":"fabricationOrderId","in":"path","description":"ID des Produktionsbelegs","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-wms-Picklist"}}}}}}}},"components":{"schemas":{"erp-wms-PicklistTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"picklistCreationOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistCreationOptions"},"orderSelectionOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.OrderSelectionOptions"},"picklistProcessingOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistProcessingOptions"},"label":{"type":"string","description":"Name der Vorlage"},"description":{"type":"string","description":"Beschreibung der Vorlage"},"pickingType":{"type":"string","description":"Art der Kommissionierung","enum":["FAST_ORDER_PICKING","SINGLE_ORDER_PICKING","COLLECTIVE_ORDER_PICKING","ROLLING_ORDER_PICKING","CONSOLIDATION","REPLENISHMENT","FABRICATION","MISSING_GOODS_PICKING","INCORRECTLY_PICKED_GOODS"]},"defaultTemplate":{"type":"boolean","default":false,"description":"Handelt es sich um eine Standard-Vorlage?"},"active":{"type":"boolean","default":true,"description":"Is Template active?","readOnly":true},"picklistScripts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistScript"},"description":"Skripte für die Erstellung und Verarbeitung von Picklisten"}},"required":["label","pickingType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-wms-PicklistTemplate.PicklistCreationOptions":{"description":"Optionen zur Erstellung von Picklisten","properties":{"sortByRoutePosition":{"type":"boolean","default":true,"description":"Positionen der Pickliste nach Laufwegposition sortieren"},"maxPicklistLineCount":{"type":"integer","format":"int64","description":"Maximale Anzahl an Positionen einer Pickliste"},"maxQuantityOfOrderLineForFastOrderPicking":{"type":"integer","format":"int64","default":1,"description":"Maximale Menge einer Auftragsposition für Schnellkommissionierungs-Picklisten"},"orderPickingTrolleyRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderPickingTrolleyGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"useAllAvailOrderPickingTrolleys":{"type":"boolean","default":false,"description":"Sollen alle verfügbaren Pickwagen verwendet werden?"},"cycleToCreatePicklistsCronExpression":{"type":"string","description":"Zyklus zur Erstellung von Picklisten (für Background-Jobs, als Quartz-Cron-Expression) (https://www.freeformatter.com/cron-expression-generator-quartz.html)"},"specifyStorageBins":{"type":"boolean","default":true,"description":"Lagerplätze vorgeben"},"specifySerialWithOldestExpiryDate":{"type":"boolean","default":false,"description":"Für Serien-Artikel mit Verfallsdatum/MHD: älteste Serie in Pickliste vorgeben"},"firstCreateFastOrderPickingPicklists":{"type":"boolean","default":false,"description":"Sollen zuerst noch Picklisten für die Schnellkommissionierung erzeugt werden?"},"fastOrderPickingTemplateToUseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printPicklist":{"type":"boolean","default":false,"description":"Soll die Pickliste gedruckt werden?"},"picklistOutputReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printLabelsOnCreation":{"type":"boolean","default":false,"description":"Soll nach der Erstellung automatisch die Etiketten gedruckt werden?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-wms-PicklistTemplate.OrderSelectionOptions":{"description":"Optionen zur Selektion von Aufträgen","properties":{"maxOrderCount":{"type":"integer","format":"int64","description":"Nur für Einzelkommissionierung und Konsolidierung: maximale Anzahl zu übernehmender Aufträge"},"alternativeSelectionInVql":{"type":"string","description":"Alternative Selektion in VQL"},"additionalExistsStatementsInVql":{"type":"array","description":"Zusätzliche Exists-Statements in VQL","items":{"type":"string","description":"Zusätzliche Exists-Statements in VQL"}},"deliveryMethodRefs":{"type":"array","description":"Liste der gültigen Lieferarten","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentTypeRefs":{"type":"array","description":"Liste der Belegarten vom Belegtyp \"Auftrag\"","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"deliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"confirmedDeliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"onlyFullDeliverableOrders":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Aufträge"},"onlyFullDeliverableOrderLines":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Positionen"},"storageAreaRefs":{"type":"array","description":"Liste von gültigen Lagerbereichen","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelId":{"type":"integer","format":"int64","description":"Id des salesChannels der bei der Selektion berücksichtigt wird"},"minArticleCountPerOrder":{"type":"integer","format":"int32","description":"Minimale Anzahl Artikel pro Auftrag"},"maxArticleCountPerOrder":{"type":"integer","format":"int32","description":"Maximale Anzahl Artikel pro Auftrag"},"maxShippingWeightPerOrder":{"type":"number","description":"Maximales Versandgewicht pro Auftrag"},"maxTotalVolumePerOrderInCCM":{"type":"number","description":"Maximales Gesamtvolumen pro Auftrag (in ccm)"},"maxOrderValue":{"type":"number","description":"Maximaler Auftragswert"}}},"erp-wms-PicklistTemplate.DateRange":{"description":"Selektion über einen Datumsbereich","properties":{"from":{"type":"string","description":"Datum von (ggf. als relatives Datum)"},"to":{"type":"string","description":"Datum bis (ggf. als relatives Datum)"},"allowEmpty":{"type":"boolean","default":true,"description":"Datumsbereich darf leer sein"}}},"erp-wms-PicklistTemplate.PicklistProcessingOptions":{"description":"Optionen für die Verarbeitung von Picklisten","properties":{"autoPrintDeliveryDocument":{"type":"boolean","default":false,"description":"Soll die Lieferbelege automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"autoPrintShippingLabel":{"type":"boolean","default":false,"description":"Sollen die Paketlabel automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"allowOnlyScanOfArticles":{"type":"boolean","default":false,"description":"Dürfen Artikel nur per Scan (oder z.B. auch Eingabe der Artikelnummer) erfasst werden"},"autoDeterminationOfLots":{"type":"boolean","default":false,"description":"Chargen automatisch bestätigen, wenn sie vorgegeben oder bereits beim Picken erfasst wurden"},"hideTargetQuantityInViews":{"type":"boolean","default":false,"description":"Zielmengen in Masken verstecken?"},"allowPickingOfServiceArticles":{"type":"boolean","default":false,"description":"Sollen Dienstleistungen kommissioniert werden?"},"allowPickingOfNonInventoryManagedArticles":{"type":"boolean","default":false,"description":"Sollen nicht-bestandsgeführte Artikel kommissioniert werden?"},"allowFullConfirmation":{"type":"boolean","default":false,"description":"Sammelbestätigung erlauben"},"deviatingQuantity":{"type":"string","description":"Kommissionierung von abweichenden Mengen","enum":["ALLOW_ONLY_ORDERED_QUANTITY","ALLOW_MINOR_QUANTITY","ALLOW_OVER_DELIVERY","ALLOW_DEVIATING_QUANTITY"]},"assemblyGroupAtOnce":{"type":"boolean","default":false,"description":"Baugruppen als Ganzes kommissionieren"},"alwaysShowDeliveryMethod":{"type":"boolean","default":true,"description":"Immer die Lieferbedingung in Masken zeigen"},"showShippingFormOnPickingFinish":{"type":"boolean","default":false,"description":"Versand-Dialog beim Abschluss zeigen"},"autoPickingFinishAfterLastArticleInOrder":{"type":"boolean","default":false,"description":"Automatischer Abschluss nach letztem Artikel vom aktuellen Auftrag"},"useDigitalPicklist":{"type":"boolean","default":false,"description":"Digitale Pickliste verwenden: dabei werden nur die Positionen im Frontend gezeigt und durch Tippen oder Wischen bestätigt"},"usePickNPack":{"type":"boolean","default":false,"description":"Pick'n'Pack verwenden"},"scanDeliveryDocumentAndShippingLabelOnFinish":{"type":"boolean","default":false,"description":"Nur für Konsolidierung: Lieferbeleg und Versandlabel zum Abschluss scannen"},"scanPickTrolleyBoxToConfirmPickedArticle":{"type":"boolean","default":false,"description":"Rollende Kommissionierung/Konsolidierung: beim Sammeln muss die Box nach dem Scan eines Artikels per Scan bestätigt werden"},"blockIfMaximumPackageWeightIsExceeded":{"type":"boolean","default":true,"description":"Überschreitung vom maximalen Paketgewicht blockieren?"},"useSalesUnit":{"type":"boolean","default":false,"description":"Verwende die Verkaufseinheit als Standardmenge"},"printLabelOnScan":{"type":"boolean","default":false,"description":"Sollen bei der Erfassung automatisch die Etiketten gedruckt werden?"},"printLabelOnCompleteOrder":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des Auftrages automatisch die Etiketten gedruckt werden?"},"printLabelAfterPicking":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des des Pickens automatisch die Etiketten gedruckt werden?"}}},"erp-wms-PicklistTemplate.PicklistScript":{"description":"Ein Picklisten-Skript","properties":{"source":{"type":"string","description":"Der Quelltext vom Skript"},"active":{"type":"boolean","default":false,"description":"Ist das Skript aktiv?"}}},"erp-wms-Picklist":{"description":"Pickliste","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Nummer der Pickliste"},"state":{"type":"string","description":"Status der Pickliste","enum":["IN_CREATION","CREATED","PAUSED_IN_PICKING","IN_PICKING","PICKED","PAUSED_IN_PACKING","IN_PACKING","CANCELLED","FINISHED"]},"pickingUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"pickingStartedAt":{"type":"string","format":"date-time","description":"Zeitpunkt, zu dem der Pickvorgang gestartet wurde"},"pickingFinishedAt":{"type":"string","format":"date-time","description":"Zeitpunkt, zu dem der Pickvorgang beendet wurde"},"lines":{"type":"array","description":"Positionen der Pickliste ","items":{"$ref":"#/components/schemas/erp-wms-PicklistLine"}},"usedTemplate":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["lines","number","state"]},"erp-wms-PicklistLine":{"description":"Positionen einer Pickliste","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Status der Position einer Pickliste","enum":["IN_CREATION","CREATED","NEWLY_ADDED","PICKED","NEWLY_ADDED_AND_PICKED","WAITING_FOR_SHIPPING_DOCUMENTS","CANCELLED","FINISHED"]},"lineType":{"type":"string","description":"Arten von Picklistenpositionen","enum":["ARTICLE","ASSEMBLY_GROUP"]},"sourceDocumentId":{"type":"integer","format":"int64","description":"ID des Quell-Dokuments"},"sourceDocumentLineId":{"type":"integer","format":"int64","description":"ID der Quell-Dokumentposition"},"articleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Menge der Position"},"quantityCollected":{"type":"number","description":"Gesammelte Menge der Position"},"quantityPacked":{"type":"number","description":"Verpackte Menge der Position"},"targetDocumentId":{"type":"integer","format":"int64","description":"ID des Ziel-Dokuments"},"targetDocumentLineId":{"type":"integer","format":"int64","description":"ID der Ziel-Dokumentposition"},"pickTrolleyBoxRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bookings":{"type":"array","description":"Buchungen zu dieser Position","items":{"$ref":"#/components/schemas/erp-wms-PicklistLineBooking"}},"components":{"type":"array","description":"Komponenten dieser Position, falls es sich bei dieser Position um eine Baugruppe handelt","items":{"$ref":"#/components/schemas/erp-wms-PicklistLineComponent"}}},"required":["articleRef","lineType","quantity","sourceDocumentId","sourceDocumentLineId","state","storageRef"]},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-wms-PicklistLineBooking":{"description":"Buchungen zu Positionen einer Pickliste","properties":{"state":{"type":"string","description":"Status der Buchung einer Position einer Pickliste","enum":["PRESETTING","PROCESSED"]},"quantity":{"type":"number","description":"Zu buchende Menge (gesammelt)"},"quantityPacked":{"type":"number","description":"Zu buchende Menge (verpackt)"},"storageBinId":{"type":"integer","format":"int64","description":"ID vom bebuchten Lagerplatz"},"storageBinDisplayName":{"type":"string","description":"Anzeigename vom Lagerplatz","readOnly":true},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"}},"required":["quantity","quantityPacked","state","storageBinId"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-wms-PicklistLineComponent":{"description":"Komponenten einer Position einer Pickliste","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"picklistLineId":{"type":"integer","format":"int64","description":"ID einer Position einer Pickliste"},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente der Quell-Dokumentposition"},"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"articleDescription":{"type":"string","description":"Artikelbeschreibung","readOnly":true},"articleName":{"type":"string","description":"Artikelbezeichnung","readOnly":true},"articleAlternativeName":{"type":"string","description":"abweichende Artikelbezeichnung","readOnly":true},"quantity":{"type":"number","description":"Menge der Position"},"quantityCollected":{"type":"number","description":"Gesammelte Menge der Position"},"quantityPacked":{"type":"number","description":"Verpackte Menge der Position"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe (falls die Picklist-Line eine Baugruppe ist)"},"targetDocumentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente der Ziel-Dokumentposition"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-wms-PicklistLineBooking"}}},"required":["articleId","picklistLineId","position","quantity","sourceDocumentLineComponentId"]}}}} ``` ## POST /erp/fabrication/create-picklist-to-restock-components > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Produktion","description":"Funktionen zur Verarbeitung von Produktionsbelegen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/fabrication/create-picklist-to-restock-components":{"post":{"tags":["Produktion"],"operationId":"createPicklistToRestockComponents_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-wms-Picklist"}}}}}}}},"components":{"schemas":{"erp-wms-PicklistTemplate":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"picklistCreationOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistCreationOptions"},"orderSelectionOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.OrderSelectionOptions"},"picklistProcessingOptions":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistProcessingOptions"},"label":{"type":"string","description":"Name der Vorlage"},"description":{"type":"string","description":"Beschreibung der Vorlage"},"pickingType":{"type":"string","description":"Art der Kommissionierung","enum":["FAST_ORDER_PICKING","SINGLE_ORDER_PICKING","COLLECTIVE_ORDER_PICKING","ROLLING_ORDER_PICKING","CONSOLIDATION","REPLENISHMENT","FABRICATION","MISSING_GOODS_PICKING","INCORRECTLY_PICKED_GOODS"]},"defaultTemplate":{"type":"boolean","default":false,"description":"Handelt es sich um eine Standard-Vorlage?"},"active":{"type":"boolean","default":true,"description":"Is Template active?","readOnly":true},"picklistScripts":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.PicklistScript"},"description":"Skripte für die Erstellung und Verarbeitung von Picklisten"}},"required":["label","pickingType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"erp-wms-PicklistTemplate.PicklistCreationOptions":{"description":"Optionen zur Erstellung von Picklisten","properties":{"sortByRoutePosition":{"type":"boolean","default":true,"description":"Positionen der Pickliste nach Laufwegposition sortieren"},"maxPicklistLineCount":{"type":"integer","format":"int64","description":"Maximale Anzahl an Positionen einer Pickliste"},"maxQuantityOfOrderLineForFastOrderPicking":{"type":"integer","format":"int64","default":1,"description":"Maximale Menge einer Auftragsposition für Schnellkommissionierungs-Picklisten"},"orderPickingTrolleyRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"orderPickingTrolleyGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"useAllAvailOrderPickingTrolleys":{"type":"boolean","default":false,"description":"Sollen alle verfügbaren Pickwagen verwendet werden?"},"cycleToCreatePicklistsCronExpression":{"type":"string","description":"Zyklus zur Erstellung von Picklisten (für Background-Jobs, als Quartz-Cron-Expression) (https://www.freeformatter.com/cron-expression-generator-quartz.html)"},"specifyStorageBins":{"type":"boolean","default":true,"description":"Lagerplätze vorgeben"},"specifySerialWithOldestExpiryDate":{"type":"boolean","default":false,"description":"Für Serien-Artikel mit Verfallsdatum/MHD: älteste Serie in Pickliste vorgeben"},"firstCreateFastOrderPickingPicklists":{"type":"boolean","default":false,"description":"Sollen zuerst noch Picklisten für die Schnellkommissionierung erzeugt werden?"},"fastOrderPickingTemplateToUseRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printPicklist":{"type":"boolean","default":false,"description":"Soll die Pickliste gedruckt werden?"},"picklistOutputReportGroupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"printLabelsOnCreation":{"type":"boolean","default":false,"description":"Soll nach der Erstellung automatisch die Etiketten gedruckt werden?"}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"erp-wms-PicklistTemplate.OrderSelectionOptions":{"description":"Optionen zur Selektion von Aufträgen","properties":{"maxOrderCount":{"type":"integer","format":"int64","description":"Nur für Einzelkommissionierung und Konsolidierung: maximale Anzahl zu übernehmender Aufträge"},"alternativeSelectionInVql":{"type":"string","description":"Alternative Selektion in VQL"},"additionalExistsStatementsInVql":{"type":"array","description":"Zusätzliche Exists-Statements in VQL","items":{"type":"string","description":"Zusätzliche Exists-Statements in VQL"}},"deliveryMethodRefs":{"type":"array","description":"Liste der gültigen Lieferarten","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentTypeRefs":{"type":"array","description":"Liste der Belegarten vom Belegtyp \"Auftrag\"","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"documentDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"deliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"confirmedDeliveryDateRange":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate.DateRange"},"onlyFullDeliverableOrders":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Aufträge"},"onlyFullDeliverableOrderLines":{"type":"boolean","default":false,"description":"Nur vollständig lieferbare Positionen"},"storageAreaRefs":{"type":"array","description":"Liste von gültigen Lagerbereichen","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"salesChannelId":{"type":"integer","format":"int64","description":"Id des salesChannels der bei der Selektion berücksichtigt wird"},"minArticleCountPerOrder":{"type":"integer","format":"int32","description":"Minimale Anzahl Artikel pro Auftrag"},"maxArticleCountPerOrder":{"type":"integer","format":"int32","description":"Maximale Anzahl Artikel pro Auftrag"},"maxShippingWeightPerOrder":{"type":"number","description":"Maximales Versandgewicht pro Auftrag"},"maxTotalVolumePerOrderInCCM":{"type":"number","description":"Maximales Gesamtvolumen pro Auftrag (in ccm)"},"maxOrderValue":{"type":"number","description":"Maximaler Auftragswert"}}},"erp-wms-PicklistTemplate.DateRange":{"description":"Selektion über einen Datumsbereich","properties":{"from":{"type":"string","description":"Datum von (ggf. als relatives Datum)"},"to":{"type":"string","description":"Datum bis (ggf. als relatives Datum)"},"allowEmpty":{"type":"boolean","default":true,"description":"Datumsbereich darf leer sein"}}},"erp-wms-PicklistTemplate.PicklistProcessingOptions":{"description":"Optionen für die Verarbeitung von Picklisten","properties":{"autoPrintDeliveryDocument":{"type":"boolean","default":false,"description":"Soll die Lieferbelege automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"autoPrintShippingLabel":{"type":"boolean","default":false,"description":"Sollen die Paketlabel automatisch nach Abschluss der Kommissionierung gedruckt werden?"},"allowOnlyScanOfArticles":{"type":"boolean","default":false,"description":"Dürfen Artikel nur per Scan (oder z.B. auch Eingabe der Artikelnummer) erfasst werden"},"autoDeterminationOfLots":{"type":"boolean","default":false,"description":"Chargen automatisch bestätigen, wenn sie vorgegeben oder bereits beim Picken erfasst wurden"},"hideTargetQuantityInViews":{"type":"boolean","default":false,"description":"Zielmengen in Masken verstecken?"},"allowPickingOfServiceArticles":{"type":"boolean","default":false,"description":"Sollen Dienstleistungen kommissioniert werden?"},"allowPickingOfNonInventoryManagedArticles":{"type":"boolean","default":false,"description":"Sollen nicht-bestandsgeführte Artikel kommissioniert werden?"},"allowFullConfirmation":{"type":"boolean","default":false,"description":"Sammelbestätigung erlauben"},"deviatingQuantity":{"type":"string","description":"Kommissionierung von abweichenden Mengen","enum":["ALLOW_ONLY_ORDERED_QUANTITY","ALLOW_MINOR_QUANTITY","ALLOW_OVER_DELIVERY","ALLOW_DEVIATING_QUANTITY"]},"assemblyGroupAtOnce":{"type":"boolean","default":false,"description":"Baugruppen als Ganzes kommissionieren"},"alwaysShowDeliveryMethod":{"type":"boolean","default":true,"description":"Immer die Lieferbedingung in Masken zeigen"},"showShippingFormOnPickingFinish":{"type":"boolean","default":false,"description":"Versand-Dialog beim Abschluss zeigen"},"autoPickingFinishAfterLastArticleInOrder":{"type":"boolean","default":false,"description":"Automatischer Abschluss nach letztem Artikel vom aktuellen Auftrag"},"useDigitalPicklist":{"type":"boolean","default":false,"description":"Digitale Pickliste verwenden: dabei werden nur die Positionen im Frontend gezeigt und durch Tippen oder Wischen bestätigt"},"usePickNPack":{"type":"boolean","default":false,"description":"Pick'n'Pack verwenden"},"scanDeliveryDocumentAndShippingLabelOnFinish":{"type":"boolean","default":false,"description":"Nur für Konsolidierung: Lieferbeleg und Versandlabel zum Abschluss scannen"},"scanPickTrolleyBoxToConfirmPickedArticle":{"type":"boolean","default":false,"description":"Rollende Kommissionierung/Konsolidierung: beim Sammeln muss die Box nach dem Scan eines Artikels per Scan bestätigt werden"},"blockIfMaximumPackageWeightIsExceeded":{"type":"boolean","default":true,"description":"Überschreitung vom maximalen Paketgewicht blockieren?"},"useSalesUnit":{"type":"boolean","default":false,"description":"Verwende die Verkaufseinheit als Standardmenge"},"printLabelOnScan":{"type":"boolean","default":false,"description":"Sollen bei der Erfassung automatisch die Etiketten gedruckt werden?"},"printLabelOnCompleteOrder":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des Auftrages automatisch die Etiketten gedruckt werden?"},"printLabelAfterPicking":{"type":"boolean","default":false,"description":"Sollen bei Abschluss des des Pickens automatisch die Etiketten gedruckt werden?"}}},"erp-wms-PicklistTemplate.PicklistScript":{"description":"Ein Picklisten-Skript","properties":{"source":{"type":"string","description":"Der Quelltext vom Skript"},"active":{"type":"boolean","default":false,"description":"Ist das Skript aktiv?"}}},"erp-wms-Picklist":{"description":"Pickliste","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"number":{"type":"string","description":"Nummer der Pickliste"},"state":{"type":"string","description":"Status der Pickliste","enum":["IN_CREATION","CREATED","PAUSED_IN_PICKING","IN_PICKING","PICKED","PAUSED_IN_PACKING","IN_PACKING","CANCELLED","FINISHED"]},"pickingUserRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"pickingStartedAt":{"type":"string","format":"date-time","description":"Zeitpunkt, zu dem der Pickvorgang gestartet wurde"},"pickingFinishedAt":{"type":"string","format":"date-time","description":"Zeitpunkt, zu dem der Pickvorgang beendet wurde"},"lines":{"type":"array","description":"Positionen der Pickliste ","items":{"$ref":"#/components/schemas/erp-wms-PicklistLine"}},"usedTemplate":{"$ref":"#/components/schemas/erp-wms-PicklistTemplate"},"targetStorageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["lines","number","state"]},"erp-wms-PicklistLine":{"description":"Positionen einer Pickliste","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"state":{"type":"string","description":"Status der Position einer Pickliste","enum":["IN_CREATION","CREATED","NEWLY_ADDED","PICKED","NEWLY_ADDED_AND_PICKED","WAITING_FOR_SHIPPING_DOCUMENTS","CANCELLED","FINISHED"]},"lineType":{"type":"string","description":"Arten von Picklistenpositionen","enum":["ARTICLE","ASSEMBLY_GROUP"]},"sourceDocumentId":{"type":"integer","format":"int64","description":"ID des Quell-Dokuments"},"sourceDocumentLineId":{"type":"integer","format":"int64","description":"ID der Quell-Dokumentposition"},"articleRef":{"$ref":"#/components/schemas/erp-product-ProductArticleRef"},"storageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"quantity":{"type":"number","description":"Menge der Position"},"quantityCollected":{"type":"number","description":"Gesammelte Menge der Position"},"quantityPacked":{"type":"number","description":"Verpackte Menge der Position"},"targetDocumentId":{"type":"integer","format":"int64","description":"ID des Ziel-Dokuments"},"targetDocumentLineId":{"type":"integer","format":"int64","description":"ID der Ziel-Dokumentposition"},"pickTrolleyBoxRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"bookings":{"type":"array","description":"Buchungen zu dieser Position","items":{"$ref":"#/components/schemas/erp-wms-PicklistLineBooking"}},"components":{"type":"array","description":"Komponenten dieser Position, falls es sich bei dieser Position um eine Baugruppe handelt","items":{"$ref":"#/components/schemas/erp-wms-PicklistLineComponent"}}},"required":["articleRef","lineType","quantity","sourceDocumentId","sourceDocumentLineId","state","storageRef"]},"erp-product-ProductArticleRef":{"description":"alle artikel, die zu diesem Produkt gehören","properties":{"id":{"type":"integer","format":"int64","description":"Article ID"},"number":{"type":"string","description":"Article number"},"name":{"type":"string","description":"Bezeichnung"},"description":{"type":"string","description":"Beschreibung"},"serialType":{"type":"string","description":"Serientyp eines Artikels","enum":["NONE","SERIAL_NUMBER","LOT","BEST_BEFORE","DOUBLE_SERIAL_NUMBER"]},"unit":{"$ref":"#/components/schemas/common-masterdata-UnitTypeReference"}},"required":["unit"]},"common-masterdata-UnitTypeReference":{"description":"net weight unit","properties":{"id":{"type":"integer","format":"int64","description":"unit type id"},"name":{"type":"string","description":"descriptive name","maxLength":255,"minLength":0},"abbreviation":{"type":"string","description":"unique abbreviation","maxLength":255,"minLength":0}},"required":["abbreviation"]},"erp-wms-PicklistLineBooking":{"description":"Buchungen zu Positionen einer Pickliste","properties":{"state":{"type":"string","description":"Status der Buchung einer Position einer Pickliste","enum":["PRESETTING","PROCESSED"]},"quantity":{"type":"number","description":"Zu buchende Menge (gesammelt)"},"quantityPacked":{"type":"number","description":"Zu buchende Menge (verpackt)"},"storageBinId":{"type":"integer","format":"int64","description":"ID vom bebuchten Lagerplatz"},"storageBinDisplayName":{"type":"string","description":"Anzeigename vom Lagerplatz","readOnly":true},"serialNumber":{"$ref":"#/components/schemas/erp-product-ArticleSerialNumber"}},"required":["quantity","quantityPacked","state","storageBinId"]},"erp-product-ArticleSerialNumber":{"description":"Seriennummer","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"articleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"serialNumber1":{"type":"string","description":"Seriennummer 1","maxLength":255,"minLength":0},"serialNumber2":{"type":"string","description":"Seriennummer 2","maxLength":255,"minLength":0},"expiryDate":{"type":"string","format":"date","description":"Haltbarkeitsdatum"},"note":{"type":"string","description":"Notiz"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"udi":{"type":"string","description":"Unique Device Identifier (UDI)"}},"required":["articleRef","serialNumber1"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-wms-PicklistLineComponent":{"description":"Komponenten einer Position einer Pickliste","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"picklistLineId":{"type":"integer","format":"int64","description":"ID einer Position einer Pickliste"},"position":{"type":"integer","format":"int32","description":"Position der Komponente in der Baugruppe"},"sourceDocumentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente der Quell-Dokumentposition"},"articleId":{"type":"integer","format":"int64","description":"ID des Artikels"},"articleNumber":{"type":"string","description":"Artikelnummer","readOnly":true},"articleDescription":{"type":"string","description":"Artikelbeschreibung","readOnly":true},"articleName":{"type":"string","description":"Artikelbezeichnung","readOnly":true},"articleAlternativeName":{"type":"string","description":"abweichende Artikelbezeichnung","readOnly":true},"quantity":{"type":"number","description":"Menge der Position"},"quantityCollected":{"type":"number","description":"Gesammelte Menge der Position"},"quantityPacked":{"type":"number","description":"Verpackte Menge der Position"},"quantityPerAssemblyGroup":{"type":"number","description":"Menge pro Baugruppe (falls die Picklist-Line eine Baugruppe ist)"},"targetDocumentLineComponentId":{"type":"integer","format":"int64","description":"ID der Komponente der Ziel-Dokumentposition"},"bookings":{"type":"array","description":"Buchungen zu dieser Komponente","items":{"$ref":"#/components/schemas/erp-wms-PicklistLineBooking"}}},"required":["articleId","picklistLineId","position","quantity","sourceDocumentLineComponentId"]}}}} ``` # Cash Drawer Kassenschubladen ## GET /erp/pos/cash-drawer/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CashDrawer","description":"Kassenschubladen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/cash-drawer/{id}":{"get":{"tags":["CashDrawer"],"summary":"Find an existing Resource by identifier","operationId":"getById_31","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-CashDrawer"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-CashDrawer":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Kassenschublade"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"drawerState":{"type":"string","description":"Schubladenstatus","enum":["OPEN","CLOSED"],"readOnly":true}},"required":["description","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/pos/cash-drawer/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CashDrawer","description":"Kassenschubladen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/cash-drawer/{id}":{"put":{"tags":["CashDrawer"],"summary":"Update existing Resource ","operationId":"update_31","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-CashDrawer"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-CashDrawer"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-CashDrawer":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Kassenschublade"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"drawerState":{"type":"string","description":"Schubladenstatus","enum":["OPEN","CLOSED"],"readOnly":true}},"required":["description","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /erp/pos/cash-drawer/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CashDrawer","description":"Kassenschubladen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/cash-drawer/{id}":{"delete":{"tags":["CashDrawer"],"summary":"Delete an existing Resource","operationId":"delete_30","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/pos/cash-drawer/{id}/deactivate > deaktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CashDrawer","description":"Kassenschubladen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/cash-drawer/{id}/deactivate":{"put":{"tags":["CashDrawer"],"summary":"deaktiviert eine bestehende Resource","operationId":"deactivate_15","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-CashDrawer"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-CashDrawer":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Kassenschublade"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"drawerState":{"type":"string","description":"Schubladenstatus","enum":["OPEN","CLOSED"],"readOnly":true}},"required":["description","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /erp/pos/cash-drawer/{id}/activate > aktiviert eine bestehende Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CashDrawer","description":"Kassenschubladen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/cash-drawer/{id}/activate":{"put":{"tags":["CashDrawer"],"summary":"aktiviert eine bestehende Resource","operationId":"activate_15","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-CashDrawer"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-CashDrawer":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Kassenschublade"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"drawerState":{"type":"string","description":"Schubladenstatus","enum":["OPEN","CLOSED"],"readOnly":true}},"required":["description","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/pos/cash-drawer > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CashDrawer","description":"Kassenschubladen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/cash-drawer":{"post":{"tags":["CashDrawer"],"summary":"Create new Resource","operationId":"create_29","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-CashDrawer"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-pos-CashDrawer"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-pos-CashDrawer":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Kassenschublade"},"description":{"type":"string","description":"Beschreibung"},"active":{"type":"boolean","default":true,"description":"Aktiv?"},"drawerState":{"type":"string","description":"Schubladenstatus","enum":["OPEN","CLOSED"],"readOnly":true}},"required":["description","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/pos/cash-drawer/{cashDrawerId}/unlock-for-cash-journal-run > Entsperrt eine Kassenschublade von einem Kassenabrechnungslauf ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CashDrawer","description":"Kassenschubladen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/cash-drawer/{cashDrawerId}/unlock-for-cash-journal-run":{"post":{"tags":["CashDrawer"],"summary":"Entsperrt eine Kassenschublade von einem Kassenabrechnungslauf","operationId":"unlockForCashJournalRun","parameters":[{"name":"cashDrawerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}} ``` ## POST /erp/pos/cash-drawer/{cashDrawerId}/lock-for-cash-journal-run > Sperrt eine Kassenschublade für einen Kassenabrechnungslauf ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CashDrawer","description":"Kassenschubladen"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/pos/cash-drawer/{cashDrawerId}/lock-for-cash-journal-run":{"post":{"tags":["CashDrawer"],"summary":"Sperrt eine Kassenschublade für einen Kassenabrechnungslauf","operationId":"lockForCashJournalRun","parameters":[{"name":"cashDrawerId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-unknownmodule-LeasableLock"}}}}}}}},"components":{"schemas":{"core-unknownmodule-LeasableLock":{"properties":{"key":{"type":"string"},"token":{"type":"integer","format":"int64"},"userId":{"type":"integer","format":"int64"},"lockedBySystem":{"type":"boolean"},"validUntil":{"type":"string","format":"date-time"},"id":{"type":"string","description":"Unique identifier of the Object","readOnly":true}},"required":["key","token"]}}}} ``` # Bestellvorschlag Zu Bestellungen Lauf Bestellvorschlag-zu-Bestellungen-Lauf ## GET /erp/order-proposal-to-orders-run/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"Bestellvorschlag-zu-Bestellungen-Lauf","description":"Bestellvorschlag-zu-Bestellungen-Lauf"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/order-proposal-to-orders-run/{id}":{"get":{"tags":["Bestellvorschlag-zu-Bestellungen-Lauf"],"summary":"Find an existing Resource by identifier","operationId":"getById_36","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-stock-OrderProposalToOrdersRun"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-stock-OrderProposalToOrdersRun":{"description":"Bestellerstellungslauf entsprechend einem Bestellvorschlag","properties":{"number":{"type":"integer","format":"int64","description":"Nummer","readOnly":true},"successful":{"type":"boolean","description":"Erfolgreich?","readOnly":true},"logLines":{"type":"array","description":"Logeinträge","items":{"$ref":"#/components/schemas/common-task-TaskLogLine"},"readOnly":true},"orderProposalId":{"type":"string","description":"Bestellvorschlag","readOnly":true},"orderDocuments":{"type":"array","description":"Preisanfragen/Bestellungen","items":{"$ref":"#/components/schemas/erp-document-DocumentRef"},"readOnly":true}}},"common-task-TaskLogLine":{"description":"Abschluss-Protokoll","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"logTime":{"type":"string","format":"date-time","description":"logTime","readOnly":true},"origin":{"type":"string","description":"log level","enum":["DEBUG","INFO","WARNING","ERROR","CONSOLE","STACKTRACE"],"readOnly":true},"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"erp-document-DocumentRef":{"description":"Referenz auf ein Document","properties":{"id":{"type":"integer","format":"int64","description":"ID"},"category":{"type":"string","description":"Dokumenttypen","enum":["CUSTOMER_OFFER","CUSTOMER_ORDER","CUSTOMER_DELIVERY_DOCUMENT","CUSTOMER_INVOICE","CUSTOMER_PROFORMA_INVOICE","CUSTOMER_DELIVERY_INVOICE","CUSTOMER_PROGRESS_INVOICE","CUSTOMER_FINAL_INVOICE","CUSTOMER_PARTIAL_INVOICE","CUSTOMER_INVOICE_CANCELLATION","CUSTOMER_DELIVERY_INVOICE_CANCELLATION","CUSTOMER_PROGRESS_INVOICE_CANCELLATION","CUSTOMER_FINAL_INVOICE_CANCELLATION","CUSTOMER_PARTIAL_INVOICE_CANCELLATION","CUSTOMER_DEPOSIT_INVOICE","CUSTOMER_DEPOSIT_INVOICE_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK","CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION","CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION","CUSTOMER_RETURN_ANNOUNCEMENT","CUSTOMER_GOODS_RETURN","SUPPLIER_PRICE_REQUEST","SUPPLIER_ORDER","SUPPLIER_DELIVERY_DOCUMENT","SUPPLIER_INVOICE","SUPPLIER_DELIVERY_INVOICE","SUPPLIER_CREDIT_NOTE_WITH_STOCK","SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK","SUPPLIER_DEPOSIT_INVOICE","SUPPLIER_PROGRESS_INVOICE","SUPPLIER_PARTIAL_INVOICE","SUPPLIER_FINAL_INVOICE","COMMISSION_SETTLEMENT","COMMISSION_SETTLEMENT_CANCELLATION","SUPPLIER_COMMISSION_CREDIT_NOTE","SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION","CUSTOMER_SUBSCRIPTION_CONTRACT","POS_CASH_JOURNAL_OPENING","POS_CASH_RECEIPT","POS_RETURN_CASH_RECEIPT","POS_CASH_JOURNAL_DEPOSIT","POS_CASH_JOURNAL_EXPENSE","POS_CASH_JOURNAL_WITHDRAWAL","POS_CASH_JOURNAL_CLOSING","FABRICATION_ORDER"]},"documentType":{"type":"string","description":"Belegart"},"documentState":{"type":"string","description":"Belegstatus"},"number":{"type":"string","description":"Belegnummer"}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Variant Attribute Listing Listings für Variantenattribute ## GET /erp/variant/attribute-listing/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantAttributeListing","description":"Listings für Variantenattribute"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/attribute-listing/{id}":{"get":{"tags":["VariantAttributeListing"],"summary":"Find an existing Resource by identifier","operationId":"getById_9","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantAttributeListing"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-VariantAttributeListing":{"description":"Variantenattribut-Listing","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"variantAttributeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["salesChannelRef","variantAttributeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PUT /erp/variant/attribute-listing/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantAttributeListing","description":"Listings für Variantenattribute"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/attribute-listing/{id}":{"put":{"tags":["VariantAttributeListing"],"summary":"Update existing Resource ","operationId":"update_8","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantAttributeListing"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantAttributeListing"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-VariantAttributeListing":{"description":"Variantenattribut-Listing","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"variantAttributeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["salesChannelRef","variantAttributeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## DELETE /erp/variant/attribute-listing/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantAttributeListing","description":"Listings für Variantenattribute"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/attribute-listing/{id}":{"delete":{"tags":["VariantAttributeListing"],"summary":"Delete an existing Resource","operationId":"delete_7","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /erp/variant/attribute-listing > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantAttributeListing","description":"Listings für Variantenattribute"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/attribute-listing":{"post":{"tags":["VariantAttributeListing"],"summary":"Create new Resource","operationId":"create_7","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantAttributeListing"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantAttributeListing"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"erp-sales_channel-VariantAttributeListing":{"description":"Variantenattribut-Listing","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"variantAttributeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["salesChannelRef","variantAttributeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}}}}} ``` ## PATCH /erp/variant/attribute-listing/{listingId} > Partial update existing listing ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"VariantAttributeListing","description":"Listings für Variantenattribute"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/erp/variant/attribute-listing/{listingId}":{"patch":{"tags":["VariantAttributeListing"],"summary":"Partial update existing listing","operationId":"partialUpdateListing_1","parameters":[{"name":"listingId","in":"path","description":"Listing-ID","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/erp-sales_channel-VariantAttributeListing"}}}}}}}},"components":{"schemas":{"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"},"erp-sales_channel-VariantAttributeListing":{"description":"Variantenattribut-Listing","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"variantAttributeRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"salesChannelRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"custom":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["salesChannelRef","variantAttributeRef"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Übergeordnete Kategorie","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Activ","readOnly":true}},"required":["id"]}}}} ``` # Currency Exchange Rate the exchange rates for currencies ## GET /cmn/currency-codes/rates/{id} > Find an existing Resource by identifier ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyExchangeRate","description":"the exchange rates for currencies"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes/rates/{id}":{"get":{"tags":["CurrencyExchangeRate"],"summary":"Find an existing Resource by identifier","operationId":"getById_152","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyExchangeRate"}}}},"404":{"description":"Resource with given ID was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CurrencyExchangeRate":{"description":"currency exchange rates","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"fromCurrency":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"toCurrency":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"exchangeRate":{"type":"number","description":"exchange rate"},"validFrom":{"type":"string","format":"date","description":"valid from"},"comment":{"type":"string","description":"Kommentar"},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true}},"required":["exchangeRate","fromCurrency","toCurrency","validFrom"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## PUT /cmn/currency-codes/rates/{id} > Update existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyExchangeRate","description":"the exchange rates for currencies"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes/rates/{id}":{"put":{"tags":["CurrencyExchangeRate"],"summary":"Update existing Resource ","operationId":"update_141","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyExchangeRate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyExchangeRate"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CurrencyExchangeRate":{"description":"currency exchange rates","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"fromCurrency":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"toCurrency":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"exchangeRate":{"type":"number","description":"exchange rate"},"validFrom":{"type":"string","format":"date","description":"valid from"},"comment":{"type":"string","description":"Kommentar"},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true}},"required":["exchangeRate","fromCurrency","toCurrency","validFrom"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## DELETE /cmn/currency-codes/rates/{id} > Delete an existing Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyExchangeRate","description":"the exchange rates for currencies"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes/rates/{id}":{"delete":{"tags":["CurrencyExchangeRate"],"summary":"Delete an existing Resource","operationId":"delete_128","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` ## POST /cmn/currency-codes/rates > Create new Resource ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"CurrencyExchangeRate","description":"the exchange rates for currencies"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/currency-codes/rates":{"post":{"tags":["CurrencyExchangeRate"],"summary":"Create new Resource","operationId":"create_129","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyExchangeRate"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"*/*":{"schema":{"$ref":"#/components/schemas/common-masterdata-CurrencyExchangeRate"}}}},"422":{"description":"Resource was not valid to process","content":{"*/*":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-masterdata-CurrencyExchangeRate":{"description":"currency exchange rates","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"fromCurrency":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"toCurrency":{"$ref":"#/components/schemas/common-masterdata-CurrencyReference"},"exchangeRate":{"type":"number","description":"exchange rate"},"validFrom":{"type":"string","format":"date","description":"valid from"},"comment":{"type":"string","description":"Kommentar"},"active":{"type":"boolean","default":true,"description":"is active","readOnly":true}},"required":["exchangeRate","fromCurrency","toCurrency","validFrom"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-masterdata-CurrencyReference":{"description":"Währung","properties":{"id":{"type":"integer","format":"int64","description":"ID der Währung"},"isoAlpha3":{"type":"string","description":"IsoAlpha3-Code der Währung"},"label":{"type":"string","description":"Bezeichnung der Währung","readOnly":true},"symbol":{"type":"string","description":"Symbol der Währung","readOnly":true}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Zu verwendende Search-Dialogs","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Zu verwendende Search-Dialogs","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Schlüssel für das Ergebnis vom Search-Dialog","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search-Dialog"}}}} ``` # Work Item for user interaction with workflows ## PUT /cmn/work-items/{id}/unassign > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkItem","description":"for user interaction with workflows"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/work-items/{id}/unassign":{"put":{"tags":["WorkItem"],"operationId":"unassignMe","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation"},"404":{"description":"work item not found"},"422":{"description":"work item not assigned to current user"}}}}}} ``` ## PUT /cmn/work-items/{id}/input > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkItem","description":"for user interaction with workflows"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/work-items/{id}/input":{"put":{"tags":["WorkItem"],"operationId":"processUserDecisionInput","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"required":true},"responses":{"200":{"description":"successful operation"},"404":{"description":"work item not found"},"422":{"description":"work item assigned to other user"}}}}}} ``` ## PUT /cmn/work-items/{id}/assign-to-me > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkItem","description":"for user interaction with workflows"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/work-items/{id}/assign-to-me":{"put":{"tags":["WorkItem"],"operationId":"assignToMe","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation"},"404":{"description":"work item not found"},"422":{"description":"work item already assigned"}}}}}} ``` ## GET /cmn/work-items/open-user-decisions > ```json {"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.32.3"},"tags":[{"name":"WorkItem","description":"for user interaction with workflows"}],"servers":[{"url":"http://10.102.24.197:32795/api","description":"Generated server url"}],"paths":{"/cmn/work-items/open-user-decisions":{"get":{"tags":["WorkItem"],"operationId":"getMyUnprocessedUserDecisions","parameters":[{"name":"userId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"workItemId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"synchronous","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-workflow-UserDecision"}}}}}}}}},"components":{"schemas":{"common-workflow-UserDecision":{"description":"Listen für Auswahloptionen","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"workItemId":{"type":"integer","format":"int64","description":"ID des Work-Items, zu dem die Benutzerentscheidung gehört","readOnly":true},"resultName":{"type":"string","description":"Name unter dem das Ergebnis abgerufen werden kann"},"prompt":{"type":"string","description":"Textbeschreibung der Auswahl-Liste / Eingabeaufforderung"},"valueType":{"type":"string","description":"Typ der Listen-Elemente"},"choiceOptions":{"type":"array","description":"Vorgegebene Antwortmöglichkeiten, oder leer, falls offene Frage","items":{"$ref":"#/components/schemas/common-workflow-ChoiceOption"}},"searchDialog":{"type":"string","description":"Suchdialog zur Suche des Werts (statt den Auswahlmöglichkeiten)"},"trySynchronous":{"type":"boolean","default":false,"description":"Soll versucht werden, die Benutzerentscheidung synchron abzufragen?"},"multipleChoiceAllowed":{"type":"boolean"}},"required":["prompt","resultName","valueType"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-workflow-ChoiceOption":{"description":"Vorgegebene Antwortmöglichkeiten, oder leer, falls offene Frage","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"label":{"type":"string","description":"Bezeichnung der Auswahl"},"value":{"type":"string","description":"Wert für die Auswahloption (Text)"},"followUpUserDecision":{"$ref":"#/components/schemas/common-workflow-UserDecision"},"defaultValue":{"type":"boolean"}},"required":["value"]}}}} ``` --- [Next Page](/llms-full.txt/1)