{ "openapi": "3.0.1", "info": { "title": "OpenAPI definition", "version": "2026.06.0" }, "servers": [ { "url": "http://localhost:53907/api", "description": "Generated server url" } ], "tags": [ { "name": "MainProductGroups", "description": "the IdentifierType API" }, { "name": "Storage", "description": "Lager" }, { "name": "Picklisten-Vorlagen", "description": "Picklisten-Vorlagen" }, { "name": "ProductPrices", "description": "The Product Price API" }, { "name": "Document Types", "description": "Resource managing the document types in our DMS(Shelf)" }, { "name": "DeliveryTerm", "description": "Lieferbedingungen" }, { "name": "CommissionAssignment", "description": "Provisionszuordnung" }, { "name": "OpenItemSynch", "description": "Umsatzabgleich" }, { "name": "PosPaymentMethod", "description": "Kassenzahlungsarten bearbeiten" }, { "name": "Product-Variant-Attribute", "description": "the Product-Variant-Attribute API" }, { "name": "Pickwagengruppen", "description": "Pickwagengruppen" }, { "name": "bundle schema", "description": "the bundle schema API" }, { "name": "Bank", "description": "Banks and accounts" }, { "name": "Document", "description": "the Document API" }, { "name": "PaymentPlan", "description": "Offene Posten - Zahlungspl\u00e4ne" }, { "name": "FiscalizationBackend", "description": "Fiskalisierungs-Schnittstellen" }, { "name": "Ui-Einstellungen", "description": "Verwaltung von UI-Einstellungen" }, { "name": "BankTransactions", "description": "Transaktionen" }, { "name": "Priorit\u00e4t zu Projekten", "description": "CRM Projekte: Priorit\u00e4tsverwaltung" }, { "name": "ArticleSupplier", "description": "the Article Supplier API" }, { "name": "LanguageCode", "description": "The language code according to ISO-639-1" }, { "name": "StorageArea", "description": "Lagerbereiche" }, { "name": "AccountType", "description": "the available Account Types" }, { "name": "ManualEntry", "description": "Manual Booking Entries" }, { "name": "TextTemplate", "description": "Textbausteine" }, { "name": "SerialNumber", "description": "Serial numbers of articles" }, { "name": "DeliveryMethod", "description": "Liefermethoden" }, { "name": "CountryRegion", "description": "the Region inside a Country e.g. Bundesl\u00e4nder" }, { "name": "Aufgaben", "description": "CRM Aufgaben" }, { "name": "MultiPartImport", "description": "mehrstufige Importvorg\u00e4nge" }, { "name": "DunningRun", "description": "Mahnlauf" }, { "name": "TaxRates", "description": "the tax rate of a country" }, { "name": "BusinessTransaction", "description": "the BusinessTransaction API" }, { "name": "User Message", "description": "the user message API" }, { "name": "Payments", "description": "Zahlungen erfassen" }, { "name": "Status zu Deals", "description": "CRM Deals: Statusverwaltung" }, { "name": "SupplierGroup", "description": "the SupplierGroup API" }, { "name": "BankPayment", "description": "Zahlungen" }, { "name": "BankingBackend", "description": "Bankschnittstellen" }, { "name": "Typen von Projekten", "description": "CRM Projekte: Verwaltung von Typen" }, { "name": "CRM Abrechnungslauf", "description": "CRM Abrechnungslauf" }, { "name": "PosPaymentBackend", "description": "Kassenzahlungs-Backends bearbeiten" }, { "name": "Product", "description": "Artikel kopieren" }, { "name": "CurrencyCode", "description": "the CurrencyCode according to ISO-4217" }, { "name": "Parameter", "description": "manage unbound parameters" }, { "name": "Aktivit\u00e4tstypen pro Benutzer", "description": "CRM Aktivit\u00e4tstypen pro Benutzer" }, { "name": "FulltextSearch", "description": "Interface to our embedded Fulltext Search" }, { "name": "BankInitializer", "description": "Bank-Initialisierung" }, { "name": "Shipment", "description": "the shipment API" }, { "name": "PriceModifierTypes", "description": "..." }, { "name": "Umlagerung", "description": "Umlagerung" }, { "name": "ProductPriceGroups", "description": "The ProductPriceGroup API" }, { "name": "Status zu Projekten", "description": "CRM Projekte: Statusverwaltung" }, { "name": "dataseries", "description": "request resource to our datamarts" }, { "name": "Skript-Modul-Gruppe", "description": "Skript-Modul-Gruppe" }, { "name": "Projekte", "description": "CRM Projekte" }, { "name": "FreeSequencer", "description": "Create and Manage Free to use Sequences" }, { "name": "MatchingRules", "description": "The rules for matching openitems with transactions" }, { "name": "Attributions", "description": "Verwaltet Verkn\u00fcpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP" }, { "name": "Product-Variant", "description": "the Product-Variant API" }, { "name": "BankingWebform", "description": "Bankautorisierungen" }, { "name": "Picklisten", "description": "Picklisten" }, { "name": "Themen zu Deals", "description": "CRM Deals: Themen" }, { "name": "Cost Center", "description": "Kostenstellen FiBu" }, { "name": "PaymentMethods", "description": "Zahlungsmethoden" }, { "name": "Image Transformations", "description": "Manage transformations for image resource" }, { "name": "DocumentAdditionalFunctions", "description": "Additional Document Functions" }, { "name": "Nachschub", "description": "Nachschubvorschl\u00e4ge" }, { "name": "Lagerbereiche", "description": "Lagerbereiche zu Artikeln" }, { "name": "Aktivit\u00e4tsarten", "description": "CRM Aktivit\u00e4tsarten" }, { "name": "Deals", "description": "CRM Deals" }, { "name": "Logs", "description": "Log Resource" }, { "name": "Tags", "description": "Tags" }, { "name": "ArticleCustomer", "description": "the Article Costumer API" }, { "name": "OpenItem", "description": "the Finance OpenItem API" }, { "name": "OpenItemClosure", "description": "Offene Posten - Manueller Abschluss" }, { "name": "Sequencer", "description": "Monitoring and configuration of sequencers and sequence pools" }, { "name": "Typen von Aufgaben", "description": "CRM Aufgaben: Verwaltung von Typen" }, { "name": "CommissionRun", "description": "Provisionslauf" }, { "name": "UnitType", "description": "the UnitType API" }, { "name": "CreateTemplateGroups", "description": "Vorlagengruppen" }, { "name": "Output-Rule", "description": "Ausgabe-Regeln" }, { "name": "computed-queries", "description": "request to our CUnitTemplates" }, { "name": "Output-Consumer", "description": "Ausgabe-Systeme" }, { "name": "PaymentTemplates", "description": "Zahlungsvorlagen" }, { "name": "Role", "description": "Benutzerrollen" }, { "name": "CreateTemplates", "description": "Vorlagen" }, { "name": "ContactType", "description": "the ContactType API" }, { "name": "Output-Module", "description": "Ausgabe Module" }, { "name": "OrderProposals", "description": "Bestellvorschl\u00e4ge" }, { "name": "WorkflowInstance", "description": "the workflow instance API" }, { "name": "Group", "description": "Benutzergruppen" }, { "name": "Verkaufskanal-Lagerzuordnung", "description": "Vorlagen f\u00fcr Verkaufskanal-Lagerzuordnung" }, { "name": "salutation", "description": "the salutation API" }, { "name": "ImportRun", "description": "einzelne Importvorg\u00e4nge" }, { "name": "System", "description": "System Resource" }, { "name": "Skript-Modul", "description": "Skript-Modul" }, { "name": "Nachschub", "description": "Vorlagen zu Nachschubvorschl\u00e4ge" }, { "name": "LeasableLock", "description": "(Zeitlich begrenzbare) Sperren f\u00fcr Entit\u00e4ten/Vorg\u00e4nge" }, { "name": "Abschlu\u00dfgr\u00fcnde zu Deals", "description": "CRM Deals: Abschlu\u00dfgr\u00fcnde" }, { "name": "EavGroup", "description": "Management of individual Fields" }, { "name": "SalesChannel", "description": "Verkaufskan\u00e4le bearbeiten" }, { "name": "Typen von Deals", "description": "CRM Deals: Verwaltung von Typen" }, { "name": "eingeplante Importe", "description": "zum Planen von periodisch auszuf\u00fchrenden Importen" }, { "name": "PosDepositExpenseType", "description": "Einlagen-/Ausgabenarten" }, { "name": "DocumentType", "description": "Document-Types" }, { "name": "Status zu Aufgaben", "description": "CRM Aufgaben: Statusverwaltung" }, { "name": "PaymentRun", "description": "Zahllauf" }, { "name": "CountryCode", "description": "the CountryCodes according to ISO-3166-1" }, { "name": "CashDrawer", "description": "Kassenschubladen" }, { "name": "Bestellvorschlag-zu-Bestellungen-Lauf", "description": "Bestellvorschlag-zu-Bestellungen-Lauf" }, { "name": "Task", "description": "Task for Batch Processing" }, { "name": "Text", "description": "Text-Parameter Resource" }, { "name": "CurrencyExchangeRate", "description": "the exchange rates for currencies" }, { "name": "WorkItem", "description": "for user interaction with workflows" }, { "name": "Priorit\u00e4ten zu Aufgaben", "description": "CRM Aufgaben: Priorit\u00e4tsverwaltung" }, { "name": "Product-Variant-Values", "description": "the Product-Variant-Values API" }, { "name": "Priorit\u00e4ten zu Deals", "description": "CRM Deals: Priorit\u00e4tsverwaltung" }, { "name": "DocumentTypeChain", "description": "the Document API" }, { "name": "IdentifierType", "description": "the IdentifierType API" }, { "name": "OpenItemPayment", "description": "Offene Posten - Zahlungen" }, { "name": "OpenItem", "description": "Finance OpentItem Additional Functions" }, { "name": "Product-Manufacturers", "description": "the Product API" }, { "name": "PurgeMovementData", "description": "Purges all movement data in the application" }, { "name": "ATM", "description": "Aktionen nach den Tenant-Migrationen" }, { "name": "TaxSchemas", "description": "definies a mapping between a key/label an country dependent tax-rates" }, { "name": "Ledger", "description": "Fibukonten" }, { "name": "Dunning", "description": "Mahnungen" }, { "name": "TaxSelect", "description": "A tax rate by selection" }, { "name": "PaymentTerms", "description": "Zahlungsbedingungen" }, { "name": "Sichtbarkeit von CRM-Deals", "description": "CRM Deals: Sichtbarkeit" }, { "name": "Abrechnungsregeln zu Aktivit\u00e4ten", "description": "Abrechnungsregeln zu CRM Aktivit\u00e4ten" }, { "name": "Versandkosten", "description": "Versandkosten" }, { "name": "Scanbare-Code-Erkennung", "description": "Erkennung von scanbaren Codes (z.B. nach GS1-, HIBC- und anderen Standards" }, { "name": "User", "description": "Benutzer" }, { "name": "Projekt-Phasen", "description": "CRM Projekt-Phasen" }, { "name": "Article", "description": "the Article API" }, { "name": "Aktivit\u00e4ten", "description": "CRM Aktivit\u00e4ten" }, { "name": "DunningLevel", "description": "Mahnstufe" }, { "name": "ImportRuleSet", "description": "Import-Regelwerke" }, { "name": "PosRegister", "description": "Kassen" }, { "name": "Pickwagen", "description": "Pickwagen & Co." }, { "name": "ArticleStorage", "description": "Stock & Storage information of product" }, { "name": "Documents", "description": "Resource managing the Documents in our DMS(Shelf)" }, { "name": "CustomerGroup", "description": "the CustomerGroup API" }, { "name": "ProductGroups", "description": "the IdentifierType API" }, { "name": "TaxEwuDeliveryLimits", "description": "this resource manage the EWU delivery limits" }, { "name": "FinanceBookingBackend", "description": "Finanzbuchhaltungen bearbeiten" }, { "name": "BankingProvider", "description": "Bankdienstleister" }, { "name": "ContractAdditionalFunctions", "description": "Additional Contract Functions" }, { "name": "UnitTypeRatio", "description": "the UnitTypeRatio API" }, { "name": "Inventory", "description": "Alles rund um die Inventur" }, { "name": "BankingUser", "description": "Verwaltung der Bankbenutzer" }, { "name": "CustomAccountRelationType", "description": "the CustomAccountRelationType API" }, { "name": "datamarts", "description": "request to our datamarts" }, { "name": "discount group", "description": "the Discount Group API" }, { "name": "account", "description": "the Account API" }, { "name": "LedgerAssignment", "description": "Fibukontenzuordnung" }, { "name": "Workflow", "description": "the workflow API" }, { "name": "UserDescription", "description": "the UserDescription API" }, { "name": "Stocks", "description": "Lagerbuchungen" }, { "name": "Output-Queue", "description": "Ausgabe-Warteschlange" }, { "name": "FinanceBooking", "description": "the FinanceAccount API" }, { "name": "\u00c4nderungsprotokoll", "description": "API f\u00fcr den Zugriff auf's \u00c4nderungsprotokoll" } ], "paths": { "/wms/replenishment-proposal/{id}": { "get": { "tags": [ "Nachschub" ], "summary": "Find an existing Resource by identifier", "operationId": "getById", "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-ReplenishmentProposal" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Nachschub" ], "summary": "Update existing Resource ", "operationId": "update", "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-ReplenishmentProposal" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposal" } } } }, "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" } } } } } } }, "/wms/replenishment-proposal/{id}/line/{lineId}": { "put": { "tags": [ "Nachschub" ], "operationId": "updateProposalLine", "parameters": [ { "name": "id", "in": "path", "description": "ID des Nachschubvorschlags", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lineId", "in": "path", "description": "ID der zu aktualisierenden Position", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalLine" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalLine" } } } } } } }, "/wms/replenishment-proposal/{id}/finish": { "put": { "tags": [ "Nachschub" ], "operationId": "finishProposal", "parameters": [ { "name": "id", "in": "path", "description": "ID des Nachschubvorschlags", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/wms/replenishment-proposal/{id}/cancel": { "put": { "tags": [ "Nachschub" ], "operationId": "cancelProposal", "parameters": [ { "name": "id", "in": "path", "description": "ID des Nachschubvorschlags", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/wms/replenishment-proposal/template/{id}": { "get": { "tags": [ "Nachschub" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_1", "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-ReplenishmentProposalTemplate" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Nachschub" ], "summary": "Update existing Resource ", "operationId": "update_1", "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-ReplenishmentProposalTemplate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalTemplate" } } } }, "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" } } } } } }, "delete": { "tags": [ "Nachschub" ], "summary": "Delete an existing Resource", "operationId": "delete", "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" } } } } } } }, "/wms/replenishment-proposal/template/{id}/deactivate": { "put": { "tags": [ "Nachschub" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate", "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-ReplenishmentProposalTemplate" } } } }, "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" } } } } } } }, "/wms/replenishment-proposal/template/{id}/activate": { "put": { "tags": [ "Nachschub" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate", "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-ReplenishmentProposalTemplate" } } } }, "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" } } } } } } }, "/wms/picktrolleys/{id}": { "get": { "tags": [ "Pickwagen" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_2", "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-PickTrolley" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Pickwagen" ], "summary": "Update existing Resource ", "operationId": "update_2", "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-PickTrolley" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolley" } } } }, "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" } } } } } }, "delete": { "tags": [ "Pickwagen" ], "summary": "Delete an existing Resource", "operationId": "delete_1", "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" } } } } } } }, "/wms/picktrolleys/{id}/free": { "put": { "tags": [ "Pickwagen" ], "operationId": "freePickTrolley", "parameters": [ { "name": "id", "in": "path", "description": "ID des Pickwagen", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolley" } } } } } } }, "/wms/picktrolleys/{id}/boxes/{boxId}": { "get": { "tags": [ "Pickwagen" ], "operationId": "getPickTrolleyBox", "parameters": [ { "name": "id", "in": "path", "description": "ID des Pickwagen", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "boxId", "in": "path", "description": "ID der Pickbox", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBox" } } } } } }, "put": { "tags": [ "Pickwagen" ], "operationId": "updatePickTrolleyBox", "parameters": [ { "name": "id", "in": "path", "description": "ID des Pickwagen", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "boxId", "in": "path", "description": "ID der Pickbox", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBox" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBox" } } } } } }, "delete": { "tags": [ "Pickwagen" ], "operationId": "deletePickTrolleyBox", "parameters": [ { "name": "id", "in": "path", "description": "ID des Pickwagen", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "boxId", "in": "path", "description": "ID der Pickbox", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/wms/picktrolleys/groups/{id}": { "get": { "tags": [ "Pickwagengruppen" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_3", "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-PickTrolleyGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Pickwagengruppen" ], "summary": "Update existing Resource ", "operationId": "update_3", "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-PickTrolleyGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyGroup" } } } }, "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" } } } } } }, "delete": { "tags": [ "Pickwagengruppen" ], "summary": "Delete an existing Resource", "operationId": "delete_2", "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" } } } } } } }, "/wms/picklists/{id}/print": { "put": { "tags": [ "Picklisten" ], "operationId": "printPicklist", "parameters": [ { "name": "id", "in": "path", "description": "ID einer Pickliste", "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": { "type": "object" } }, "application/json": { "schema": { "type": "object" } } } } } } }, "/wms/picklists/cancel": { "put": { "tags": [ "Picklisten" ], "operationId": "cancelPicklists", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "ID der zu stornierenden Pickliste", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistCancellationResult" } } } } } } }, "/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" } } } } } }, "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" } } } } } }, "delete": { "tags": [ "Picklisten-Vorlagen" ], "summary": "Delete an existing Resource", "operationId": "delete_3", "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/wms/inventories/{id}": { "get": { "tags": [ "Inventory" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_6", "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-Inventory" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Inventory" ], "summary": "Update existing Resource ", "operationId": "update_5", "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-Inventory" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-Inventory" } } } }, "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" } } } } } } }, "/wms/inventories/{id}/states": { "get": { "tags": [ "Inventory" ], "operationId": "getInventoryTransitions", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-wms-InventoryTransition" } } } } } } }, "put": { "tags": [ "Inventory" ], "operationId": "transferToState", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-InventoryStateTransitionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-Inventory" } } } } } } }, "/wms/inventories/{id}/products-without-purchase-price": { "get": { "tags": [ "Inventory" ], "operationId": "getProductsWithoutPurchasePrice", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-wms-ArticleWithPurchasePrice" } } } } } } }, "put": { "tags": [ "Inventory" ], "operationId": "updateProductsWithPurchasePrice", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-wms-ArticleWithPurchasePrice" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/wms/inventories/{id}/countings/{inventoryCountingId}": { "put": { "tags": [ "Inventory" ], "operationId": "updateInventoryCounting", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "inventoryCountingId", "in": "path", "description": "ID der InventoryCounting", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-InventoryCounting" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-InventoryCounting" } } } } } }, "delete": { "tags": [ "Inventory" ], "operationId": "deleteInventoryCounting", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "inventoryCountingId", "in": "path", "description": "ID der InventoryCounting", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/vds/shipment/{id}": { "get": { "tags": [ "Shipment" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/vds-shipment-Shipment" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Shipment" ], "summary": "Update existing Resource ", "operationId": "update_6", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-shipment-Shipment" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-shipment-Shipment" } } } }, "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" } } } } } }, "delete": { "tags": [ "Shipment" ], "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": { "*/*": { "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" } } } } } } }, "/vds/shipment/{id}/validate": { "put": { "tags": [ "Shipment" ], "operationId": "validate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-shipment-Shipment" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-shipment-Shipment" } } } } } } }, "/vds/shipment/{id}/updateWithRequestLabel": { "put": { "tags": [ "Shipment" ], "operationId": "updateWithRequestLabel", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-shipment-Shipment" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-shipment-Shipment" } } } } } } }, "/vds/shipment/{id}/request-label": { "put": { "tags": [ "Shipment" ], "summary": "requests a label from carrier", "operationId": "requestLabel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-shipment-PrintLabelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-shipment-Shipment" } } } } } } }, "/vds/shipment/{id}/parcels/{parcelId}": { "put": { "tags": [ "Shipment" ], "summary": "Update existing Resource", "operationId": "updateParcel", "parameters": [ { "name": "id", "in": "path", "description": "Shipment-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "parcelId", "in": "path", "description": "Parcel-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-shipment-Parcel" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-shipment-Parcel" } } } } } } }, "/vds/shipment/{id}/parcels/{parcelId}/print": { "put": { "tags": [ "Shipment" ], "summary": "Print parcel label", "operationId": "printParcel", "parameters": [ { "name": "id", "in": "path", "description": "shipment id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "parcelId", "in": "path", "description": "parcelId", "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": { "type": "object" } } } } } } }, "/public/dms-presigned/{id}/upload/{uploadToken}/part/{partNumber}/file": { "put": { "tags": [ "local-storage-file-resource" ], "operationId": "uploadFileTransferPart", "parameters": [ { "name": "id", "in": "path", "description": "shelf-document-id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "uploadToken", "in": "path", "description": "uploadToken", "required": true, "schema": { "type": "string" } }, { "name": "partNumber", "in": "path", "description": "unique part number", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "token", "in": "query", "description": "token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/*": { "schema": { "type": "object" } } } } } } }, "/erp/user-details/{id}": { "get": { "tags": [ "UserDescription" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-user-ErpUserDetail" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "UserDescription" ], "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-user-ErpUserDetail" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-user-ErpUserDetail" } } } }, "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" } } } } } }, "delete": { "tags": [ "UserDescription" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/text-templates/{id}": { "get": { "tags": [ "TextTemplate" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-texttemplates-TextTemplate" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "TextTemplate" ], "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-texttemplates-TextTemplate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-texttemplates-TextTemplate" } } } }, "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" } } } } } }, "delete": { "tags": [ "TextTemplate" ], "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": { "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" } } } } } } }, "/erp/text-templates/{id}/deactivate": { "put": { "tags": [ "TextTemplate" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_2", "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-texttemplates-TextTemplate" } } } }, "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" } } } } } } }, "/erp/text-templates/{id}/activate": { "put": { "tags": [ "TextTemplate" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_2", "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-texttemplates-TextTemplate" } } } }, "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" } } } } } } }, "/erp/taxes/tax-schemas/{id}": { "get": { "tags": [ "TaxSchemas" ], "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-tax-TaxSchema" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "TaxSchemas" ], "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-tax-TaxSchema" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxSchema" } } } }, "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" } } } } } }, "delete": { "tags": [ "TaxSchemas" ], "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": { "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" } } } } } } }, "/erp/taxes/tax-schemas/{id}/deactivate": { "put": { "tags": [ "TaxSchemas" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_3", "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-tax-TaxSchema" } } } }, "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" } } } } } } }, "/erp/taxes/tax-schemas/{id}/activate": { "put": { "tags": [ "TaxSchemas" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_3", "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-tax-TaxSchema" } } } }, "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" } } } } } } }, "/erp/taxes/tax-rates/{id}": { "get": { "tags": [ "TaxRates" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_11", "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-tax-TaxRate" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "TaxRates" ], "summary": "Update existing Resource ", "operationId": "update_10", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxRate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxRate" } } } }, "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" } } } } } }, "delete": { "tags": [ "TaxRates" ], "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" } } } } } } }, "/erp/taxes/tax-rates/{id}/deactivate": { "put": { "tags": [ "TaxRates" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_4", "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-tax-TaxRate" } } } }, "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" } } } } } } }, "/erp/taxes/tax-rates/{id}/activate": { "put": { "tags": [ "TaxRates" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_4", "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-tax-TaxRate" } } } }, "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" } } } } } } }, "/erp/taxes/tax-ewu-delivery-limits/{id}": { "get": { "tags": [ "TaxEwuDeliveryLimits" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_12", "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-tax-TaxEwuDeliveryLimit" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "TaxEwuDeliveryLimits" ], "summary": "Update existing Resource ", "operationId": "update_11", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxEwuDeliveryLimit" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxEwuDeliveryLimit" } } } }, "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" } } } } } }, "delete": { "tags": [ "TaxEwuDeliveryLimits" ], "summary": "Delete an existing Resource", "operationId": "delete_9", "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" } } } } } } }, "/erp/storages/{id}": { "get": { "tags": [ "Storage" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_13", "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" } } } } } }, "put": { "tags": [ "Storage" ], "summary": "Update existing Resource ", "operationId": "update_12", "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" } } } } } }, "delete": { "tags": [ "Storage" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/storages/bins/print-labels": { "put": { "tags": [ "Storage" ], "summary": "F\u00fchrt dem Etikettendruck zu gegebenen Lagerpl\u00e4tzen durch", "operationId": "printLabels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-StorageBinLabelPrintRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/erp/storage-areas/{id}": { "get": { "tags": [ "StorageArea" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-stock-StorageArea" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "StorageArea" ], "summary": "Update existing Resource ", "operationId": "update_13", "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" } } } } } }, "delete": { "tags": [ "StorageArea" ], "summary": "Delete an existing Resource", "operationId": "delete_11", "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" } } } } } } }, "/erp/stocks/book-last-purchase-price-correction": { "put": { "tags": [ "Stocks" ], "operationId": "bookLastPurchasePriceCorrection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-BookLastPurchasePriceCorrectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/erp/stocks/book-average-purchase-price-correction": { "put": { "tags": [ "Stocks" ], "operationId": "bookAveragePurchasePriceCorrection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-BookAveragePurchasePriceCorrectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/erp/sales-channels/storage-schema/{id}": { "get": { "tags": [ "Verkaufskanal-Lagerzuordnung" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_15", "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" } } } } } }, "put": { "tags": [ "Verkaufskanal-Lagerzuordnung" ], "summary": "Update existing Resource ", "operationId": "update_14", "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" } } } } } }, "delete": { "tags": [ "Verkaufskanal-Lagerzuordnung" ], "summary": "Delete an existing Resource", "operationId": "delete_12", "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/products/{id}": { "put": { "tags": [ "Product" ], "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-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" } } } } } } }, "/erp/products/sales-prices/{priceId}": { "put": { "tags": [ "ProductPrices" ], "operationId": "putProductSalesPrice", "parameters": [ { "name": "priceId", "in": "path", "description": "ID des Preises", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } } } } }, "delete": { "tags": [ "ProductPrices" ], "operationId": "deleteProductSalesPrice", "parameters": [ { "name": "priceId", "in": "path", "description": "ID des Preises", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/products/sales-discounts/{discountId}": { "put": { "tags": [ "ProductPrices" ], "operationId": "putProductSalesDiscount", "parameters": [ { "name": "discountId", "in": "path", "description": "ID des Rabatts", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } } } } } }, "/erp/products/purchase-prices/{priceId}": { "put": { "tags": [ "ProductPrices" ], "operationId": "putProductPurchasePrice", "parameters": [ { "name": "priceId", "in": "path", "description": "ID des Preises", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } } } } }, "delete": { "tags": [ "ProductPrices" ], "operationId": "deleteProductPurchasePrice", "parameters": [ { "name": "priceId", "in": "path", "description": "ID des Preises", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/products/purchase-discounts/{discountId}": { "put": { "tags": [ "ProductPrices" ], "operationId": "putProductPurchaseDiscount", "parameters": [ { "name": "discountId", "in": "path", "description": "ID des Rabatts", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } } } } } }, "/erp/products/manufacturers/{id}": { "get": { "tags": [ "Product-Manufacturers" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Manufacturer" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Product-Manufacturers" ], "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-product-Manufacturer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Manufacturer" } } } }, "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" } } } } } }, "delete": { "tags": [ "Product-Manufacturers" ], "summary": "Delete an existing Resource", "operationId": "delete_13", "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" } } } } } } }, "/erp/products/manufacturers/{id}/deactivate": { "put": { "tags": [ "Product-Manufacturers" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Manufacturer" } } } }, "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" } } } } } } }, "/erp/products/manufacturers/{id}/activate": { "put": { "tags": [ "Product-Manufacturers" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Manufacturer" } } } }, "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" } } } } } } }, "/erp/product-variants/{id}": { "get": { "tags": [ "Product-Variant" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariant" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Product-Variant" ], "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-product-ProductVariant" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariant" } } } }, "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" } } } } } }, "delete": { "tags": [ "Product-Variant" ], "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": { "*/*": { "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" } } } } } } }, "/erp/product-variants/{id}/deactivate": { "put": { "tags": [ "Product-Variant" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariant" } } } }, "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" } } } } } } }, "/erp/product-variants/{id}/activate": { "put": { "tags": [ "Product-Variant" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariant" } } } }, "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" } } } } } } }, "/erp/product-variant-attributes/{id}": { "get": { "tags": [ "Product-Variant-Attribute" ], "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-product-ProductVariantAttribute" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Product-Variant-Attribute" ], "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-product-ProductVariantAttribute" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttribute" } } } }, "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" } } } } } }, "delete": { "tags": [ "Product-Variant-Attribute" ], "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": { "*/*": { "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" } } } } } } }, "/erp/product-variant-attributes/{id}/deactivate": { "put": { "tags": [ "Product-Variant-Attribute" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_9", "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-ProductVariantAttribute" } } } }, "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" } } } } } } }, "/erp/product-variant-attributes/{id}/activate": { "put": { "tags": [ "Product-Variant-Attribute" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_9", "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-ProductVariantAttribute" } } } }, "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" } } } } } } }, "/erp/product-variant-attributes/{attributeId}/value/{valueId}": { "put": { "tags": [ "Product-Variant-Values" ], "operationId": "update_19", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } } } } } }, "delete": { "tags": [ "Product-Variant-Values" ], "operationId": "delete_16", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/product-variant-attributes/{attributeId}/value/{valueId}/listings/{listingId}": { "get": { "tags": [ "Product-Variant-Values" ], "summary": "Find an existing listing by identifier", "operationId": "getListingById", "parameters": [ { "name": "attributeId", "in": "path", "description": "Attribute-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valueId", "in": "path", "description": "Value-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingId", "in": "path", "description": "Listing-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValueListing" } } } } } }, "put": { "tags": [ "Product-Variant-Values" ], "summary": "Update existing listing", "operationId": "updateListing", "parameters": [ { "name": "attributeId", "in": "path", "description": "Attribute-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valueId", "in": "path", "description": "Value-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingId", "in": "path", "description": "Listing-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValueListing" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValueListing" } } } } } }, "patch": { "tags": [ "Product-Variant-Values" ], "summary": "Partial update existing listing", "operationId": "partialUpdateListing", "parameters": [ { "name": "attributeId", "in": "path", "description": "Attribute-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valueId", "in": "path", "description": "Value-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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-product-ProductVariantAttributeValueListing" } } } } } } }, "/erp/product-variant-attributes/{attributeId}/value/{valueId}/deactivate": { "put": { "tags": [ "Product-Variant-Values" ], "operationId": "deactivate_10", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } } } } } } }, "/erp/product-variant-attributes/{attributeId}/value/{valueId}/activate": { "put": { "tags": [ "Product-Variant-Values" ], "operationId": "activate_10", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } } } } } } }, "/erp/product-variant-attributes/{attributeId}/listings/{listingId}": { "get": { "tags": [ "Product-Variant-Attribute" ], "summary": "Find an existing listing by identifier", "operationId": "getListingById_1", "parameters": [ { "name": "attributeId", "in": "path", "description": "Attribute-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingId", "in": "path", "description": "Listing-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeListing" } } } } } }, "put": { "tags": [ "Product-Variant-Attribute" ], "summary": "Update existing listing", "operationId": "updateListing_1", "parameters": [ { "name": "attributeId", "in": "path", "description": "Attribute-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingId", "in": "path", "description": "Listing-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeListing" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeListing" } } } } } }, "patch": { "tags": [ "Product-Variant-Attribute" ], "summary": "Partial update existing listing", "operationId": "partialUpdateListing_1", "parameters": [ { "name": "attributeId", "in": "path", "description": "Attribute-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "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-product-ProductVariantAttributeListing" } } } } } } }, "/erp/product-types/product-price-groups/{id}": { "get": { "tags": [ "ProductPriceGroups" ], "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-product-ProductPriceGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "ProductPriceGroups" ], "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-ProductPriceGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPriceGroup" } } } }, "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" } } } } } }, "delete": { "tags": [ "ProductPriceGroups" ], "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" } } } } } } }, "/erp/product-types/product-groups/{id}": { "get": { "tags": [ "ProductGroups" ], "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-product-ProductGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "ProductGroups" ], "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-ProductGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductGroup" } } } }, "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" } } } } } }, "delete": { "tags": [ "ProductGroups" ], "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" } } } } } } }, "/erp/product-types/product-groups/{id}/deactivate": { "put": { "tags": [ "ProductGroups" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_11", "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-ProductGroup" } } } }, "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" } } } } } } }, "/erp/product-types/product-groups/{id}/activate": { "put": { "tags": [ "ProductGroups" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_11", "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-ProductGroup" } } } }, "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" } } } } } } }, "/erp/product-types/main-product-groups/{id}": { "get": { "tags": [ "MainProductGroups" ], "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": { "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" } } } } } }, "put": { "tags": [ "MainProductGroups" ], "summary": "Update existing Resource ", "operationId": "update_22", "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" } } } } } }, "delete": { "tags": [ "MainProductGroups" ], "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": { "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" } } } } } } }, "/erp/product-types/main-product-groups/{id}/deactivate": { "put": { "tags": [ "MainProductGroups" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_12", "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" } } } } } } }, "/erp/product-types/main-product-groups/{id}/activate": { "put": { "tags": [ "MainProductGroups" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_12", "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" } } } } } } }, "/erp/product-types/identifier-types/{id}": { "get": { "tags": [ "IdentifierType" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_22", "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-IdentifierType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "IdentifierType" ], "summary": "Update existing Resource ", "operationId": "update_23", "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-IdentifierType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-IdentifierType" } } } }, "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" } } } } } }, "delete": { "tags": [ "IdentifierType" ], "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": { "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" } } } } } } }, "/erp/product-types/identifier-types/{id}/deactivate": { "put": { "tags": [ "IdentifierType" ], "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-product-IdentifierType" } } } }, "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" } } } } } } }, "/erp/product-types/identifier-types/{id}/activate": { "put": { "tags": [ "IdentifierType" ], "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-product-IdentifierType" } } } }, "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" } } } } } } }, "/erp/product-types/discount-groups/{id}": { "get": { "tags": [ "discount group" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-product-DiscountGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "discount group" ], "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-DiscountGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-DiscountGroup" } } } }, "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" } } } } } }, "delete": { "tags": [ "discount group" ], "summary": "Delete an existing Resource", "operationId": "delete_21", "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" } } } } } } }, "/erp/product-types/discount-groups/{id}/rules/{ruleId}": { "get": { "tags": [ "discount group" ], "operationId": "getDiscountGroupRule", "parameters": [ { "name": "id", "in": "path", "description": "ID der Rabattgruppe", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ruleId", "in": "path", "description": "ID der Rabattgruppenregel", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-DiscountGroupRule" } } } } } }, "put": { "tags": [ "discount group" ], "operationId": "updateDiscountGroupRule", "parameters": [ { "name": "id", "in": "path", "description": "ID der Rabattgruppe", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ruleId", "in": "path", "description": "ID der Rabattgruppenregel", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-DiscountGroupRule" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-DiscountGroupRule" } } } } } }, "delete": { "tags": [ "discount group" ], "operationId": "deleteDiscountGroupRule", "parameters": [ { "name": "id", "in": "path", "description": "ID der Rabattgruppe", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ruleId", "in": "path", "description": "ID der Rabattgruppenregel", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/price-modifier-types/{id}": { "get": { "tags": [ "PriceModifierTypes" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-PriceModifierTemplate" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "PriceModifierTypes" ], "summary": "Update existing Resource ", "operationId": "update_25", "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" } } } } } }, "delete": { "tags": [ "PriceModifierTypes" ], "summary": "Delete an existing Resource", "operationId": "delete_22", "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" } } } } } } }, "/erp/pos/register/{posRegisterId}/tss/register": { "put": { "tags": [ "PosRegister" ], "operationId": "register", "parameters": [ { "name": "posRegisterId", "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": [ "REGISTERED", "DEREGISTERED" ] } } } } } } }, "/erp/pos/register/{posRegisterId}/tss/deregister": { "put": { "tags": [ "PosRegister" ], "operationId": "deregister", "parameters": [ { "name": "posRegisterId", "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": [ "REGISTERED", "DEREGISTERED" ] } } } } } } }, "/erp/pos/register/{id}": { "get": { "tags": [ "PosRegister" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_25", "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-PosRegister" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "PosRegister" ], "summary": "Update existing Resource ", "operationId": "update_26", "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-PosRegister" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosRegister" } } } }, "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" } } } } } }, "delete": { "tags": [ "PosRegister" ], "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" } } } } } } }, "/erp/pos/register/{id}/deactivate": { "put": { "tags": [ "PosRegister" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_14", "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-PosRegister" } } } }, "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" } } } } } } }, "/erp/pos/register/{id}/activate": { "put": { "tags": [ "PosRegister" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_14", "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-PosRegister" } } } }, "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" } } } } } } }, "/erp/pos/fiscalization/backend/{id}": { "get": { "tags": [ "FiscalizationBackend" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_26", "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" } } } } } }, "put": { "tags": [ "FiscalizationBackend" ], "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-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" } } } } } }, "delete": { "tags": [ "FiscalizationBackend" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/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" } } } }, "/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" } } } }, "/erp/pos/fiscalization/backend/{id}/deactivate": { "put": { "tags": [ "FiscalizationBackend" ], "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-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" } } } } } } }, "/erp/pos/fiscalization/backend/{id}/activate": { "put": { "tags": [ "FiscalizationBackend" ], "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-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" } } } } } } }, "/erp/pos/depositExpenseType/{id}": { "get": { "tags": [ "PosDepositExpenseType" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosDepositExpenseType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "PosDepositExpenseType" ], "summary": "Update existing Resource ", "operationId": "update_28", "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-PosDepositExpenseType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosDepositExpenseType" } } } }, "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" } } } } } }, "delete": { "tags": [ "PosDepositExpenseType" ], "summary": "Delete an existing Resource", "operationId": "delete_25", "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" } } } } } } }, "/erp/pos/depositExpenseType/{id}/deactivate": { "put": { "tags": [ "PosDepositExpenseType" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_16", "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-PosDepositExpenseType" } } } }, "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" } } } } } } }, "/erp/pos/depositExpenseType/{id}/activate": { "put": { "tags": [ "PosDepositExpenseType" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_16", "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-PosDepositExpenseType" } } } }, "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" } } } } } } }, "/erp/pos/cash-drawer/{id}": { "get": { "tags": [ "CashDrawer" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-pos-CashDrawer" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CashDrawer" ], "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-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" } } } } } }, "delete": { "tags": [ "CashDrawer" ], "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": { "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" } } } } } } }, "/erp/pos/cash-drawer/{id}/deactivate": { "put": { "tags": [ "CashDrawer" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_17", "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" } } } } } } }, "/erp/pos/cash-drawer/{id}/activate": { "put": { "tags": [ "CashDrawer" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_17", "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" } } } } } } }, "/erp/payments/terms/{id}": { "get": { "tags": [ "PaymentTerms" ], "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-payment-PaymentTerm" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "PaymentTerms" ], "summary": "Update existing Resource ", "operationId": "update_30", "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-PaymentTerm" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentTerm" } } } }, "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" } } } } } }, "delete": { "tags": [ "PaymentTerms" ], "summary": "Delete an existing Resource", "operationId": "delete_27", "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" } } } } } } }, "/erp/payments/terms/{id}/deactivate": { "put": { "tags": [ "PaymentTerms" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_18", "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-payment-PaymentTerm" } } } }, "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" } } } } } } }, "/erp/payments/terms/{id}/activate": { "put": { "tags": [ "PaymentTerms" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_18", "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-payment-PaymentTerm" } } } }, "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" } } } } } } }, "/erp/payments/templates/{id}": { "get": { "tags": [ "PaymentTemplates" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-payment-PaymentTemplate" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "PaymentTemplates" ], "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-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" } } } } } }, "delete": { "tags": [ "PaymentTemplates" ], "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" } } } } } } }, "/erp/payments/methods/{id}": { "get": { "tags": [ "PaymentMethods" ], "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-payment-PaymentMethod" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "PaymentMethods" ], "summary": "Update existing Resource ", "operationId": "update_32", "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-PaymentMethod" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentMethod" } } } }, "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" } } } } } }, "delete": { "tags": [ "PaymentMethods" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/payments/methods/{id}/deactivate": { "put": { "tags": [ "PaymentMethods" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_19", "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-payment-PaymentMethod" } } } }, "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" } } } } } } }, "/erp/payments/methods/{id}/activate": { "put": { "tags": [ "PaymentMethods" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_19", "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-payment-PaymentMethod" } } } }, "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" } } } } } } }, "/erp/order-proposals/{id}": { "get": { "tags": [ "OrderProposals" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-stock-OrderProposal" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "OrderProposals" ], "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-stock-OrderProposal" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposal" } } } }, "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" } } } } } }, "delete": { "tags": [ "OrderProposals" ], "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" } } } } } } }, "/erp/order-proposals/{id}/order-proposals/{order-proposal-line-id}": { "put": { "tags": [ "OrderProposals" ], "operationId": "updateOrderProposalLine", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "order-proposal-line-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposalLine" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposalLine" } } } } } }, "delete": { "tags": [ "OrderProposals" ], "operationId": "removeOrderProposalLine", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "order-proposal-line-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/order-proposals/{id}/order-proposal-suppliers/{order-proposal-supplier-id}": { "put": { "tags": [ "OrderProposals" ], "operationId": "updateOrderProposalSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "order-proposal-supplier-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposalSupplier" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposalSupplier" } } } } } }, "delete": { "tags": [ "OrderProposals" ], "operationId": "removeOrderProposalSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "order-proposal-supplier-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitems/{openItemId}/change": { "put": { "tags": [ "OpenItem" ], "description": "\u00c4ndert Stammdaten am Offenen Posten wie Mahnsperre", "operationId": "update_34", "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" } } } } } } }, "/erp/finance/openitems/paymentplan/{openItemId}/change_paymentplan": { "put": { "tags": [ "PaymentPlan" ], "description": "\u00c4ndert einen Zahlungsplan", "operationId": "update_35", "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" } } } } } } }, "/erp/finance/openitems/matchingrules/{id}": { "get": { "tags": [ "MatchingRules" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemMatchingRule" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "MatchingRules" ], "summary": "Update existing Resource ", "operationId": "update_36", "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" } } } } } }, "delete": { "tags": [ "MatchingRules" ], "summary": "Delete an existing Resource", "operationId": "delete_31", "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" } } } } } } }, "/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": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItem" } } } } } } }, "/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": { "type": "object" } } } } } }, "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": { "type": "object" } }, "application/json": { "schema": { "type": "object" } } } } } } }, "/erp/finance/ledger/{id}": { "get": { "tags": [ "Ledger" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-Ledger" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Ledger" ], "summary": "Update existing Resource ", "operationId": "update_37", "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-Ledger" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-Ledger" } } } }, "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" } } } } } }, "delete": { "tags": [ "Ledger" ], "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" } } } } } } }, "/erp/finance/ledger-assignment/{id}": { "get": { "tags": [ "LedgerAssignment" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_39", "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-LedgerAssignment" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "LedgerAssignment" ], "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-LedgerAssignment" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-LedgerAssignment" } } } }, "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" } } } } } }, "delete": { "tags": [ "LedgerAssignment" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/finance/dunning_run/{id}/unmark_all_for_processing": { "put": { "tags": [ "DunningRun" ], "operationId": "unmarkAllForProcessing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/dunning_run/{id}/print": { "put": { "tags": [ "DunningRun" ], "operationId": "printDunningRun", "parameters": [ { "name": "id", "in": "path", "description": "dunning 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" } } } }, "/erp/finance/dunning_run/{id}/position/{positionId}/unmark_for_processing": { "put": { "tags": [ "DunningRun" ], "operationId": "unmarkPositionForProcessing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "positionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/dunning_run/{id}/position/{positionId}/mark_for_processing": { "put": { "tags": [ "DunningRun" ], "operationId": "markPositionForProcessing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "positionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/dunning_run/{id}/mark_all_for_processing": { "put": { "tags": [ "DunningRun" ], "operationId": "markAllForProcessing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/dunning/{id}": { "get": { "tags": [ "DunningLevel" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_41", "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-DunningLevel" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "DunningLevel" ], "summary": "Update existing Resource ", "operationId": "update_39", "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-DunningLevel" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-DunningLevel" } } } }, "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" } } } } } }, "delete": { "tags": [ "DunningLevel" ], "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" } } } } } } }, "/erp/finance/dunning/{id}/dunning_text/{textId}": { "get": { "tags": [ "DunningLevel" ], "operationId": "getTextById", "parameters": [ { "name": "id", "in": "path", "description": "identifier of a dunning level", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "textId", "in": "path", "description": "identifier of a dunning level text", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-LocalizedContentTemplate" } } } } } }, "put": { "tags": [ "DunningLevel" ], "operationId": "putDunningText", "parameters": [ { "name": "id", "in": "path", "description": "identifier of a dunning level", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "textId", "in": "path", "description": "identifier of a dunning level text", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-LocalizedContentTemplate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-LocalizedContentTemplate" } } } } } }, "delete": { "tags": [ "DunningLevel" ], "operationId": "deleteDunningText", "parameters": [ { "name": "id", "in": "path", "description": "identifier of a dunning level", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "textId", "in": "path", "description": "identifier of a dunning level text", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/finance/costcenter/{id}": { "get": { "tags": [ "Cost Center" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_42", "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" } } } } } }, "put": { "tags": [ "Cost Center" ], "summary": "Update existing Resource ", "operationId": "update_40", "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" } } } } } }, "delete": { "tags": [ "Cost Center" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/finance/business_transaction/{id}": { "get": { "tags": [ "BusinessTransaction" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_43", "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-BusinessTransaction" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "BusinessTransaction" ], "summary": "Update existing Resource ", "operationId": "update_41", "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-BusinessTransaction" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-BusinessTransaction" } } } }, "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" } } } } } }, "delete": { "tags": [ "BusinessTransaction" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/finance/booked_dunning/{id}/print": { "get": { "tags": [ "Dunning" ], "operationId": "getPrintPreview_1", "parameters": [ { "name": "id", "in": "path", "description": "dunning identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } }, "put": { "tags": [ "Dunning" ], "operationId": "printDunning_1", "parameters": [ { "name": "id", "in": "path", "description": "dunning 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": { "type": "object" } }, "application/json": { "schema": { "type": "object" } } } } } } }, "/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" } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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": { "type": "object" } } } } } }, "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": { "type": "object" } }, "application/json": { "schema": { "type": "object" } } } }, "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" } } } } } } }, "/erp/documents/{id}/leasable-lock/{lockToken}": { "put": { "tags": [ "Document" ], "summary": "Verl\u00e4ngert 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\u00e4ngernden 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" } } } } } }, "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" } } } }, "/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" } } } } } } }, "/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" } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } }, "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" } } } } } }, "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" } } } }, "/erp/documents/contract-additional-functions/{contractId}/update-due-dates": { "put": { "tags": [ "ContractAdditionalFunctions" ], "summary": "Update DueDates", "operationId": "updateDueDates", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-ContractDueDates" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } } } } }, "/erp/documents/additional-functions/{documentId}/updateTags/": { "put": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Tags aktualisieren", "operationId": "setDocumentTags", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } } } } }, "/erp/documents/additional-functions/{documentId}/update-type/{targetTypeId}": { "put": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Belegtyp \u00e4ndern", "operationId": "updateDocumentType", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "targetTypeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } } } } }, "/erp/documents/additional-functions/{documentId}/update-state/{targetState}": { "put": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Belegstatus \u00e4ndern", "operationId": "updateDocumentState", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "targetState", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } } } } }, "/erp/documents/additional-functions/{documentId}/unlock-openitem": { "put": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Offenen Posten entsperren", "operationId": "unlockOpenItem", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } } } } }, "/erp/documents/additional-functions/{documentId}/line/{documentLineId}/customerOrderLine/{customerOrderLineId}": { "put": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Kundenauftrags-Referenz f\u00fcr Belegposition \u00e4ndern", "operationId": "updateCustomerOrderLineForDocumentLine", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "documentLineId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "customerOrderLineId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentLine" } } } } } } }, "/erp/documents/additional-functions/{documentId}/line/{documentLineId}/customerOrderLine/{customerOrderLineId}/remove": { "put": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Kundenauftrags-Referenz f\u00fcr Belegposition l\u00f6schen", "operationId": "removeCustomerOrderLineForDocumentLine", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "documentLineId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "customerOrderLineId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentLine" } } } } } } }, "/erp/documents/additional-functions/{documentId}/change-delivery-status": { "put": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Lieferung freigeben status \u00e4ndern", "operationId": "setDocumentDelivery", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "approved", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } } } } }, "/erp/document-types/{id}": { "get": { "tags": [ "DocumentType" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_46", "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-DocumentType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "DocumentType" ], "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-document-DocumentType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentType" } } } }, "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" } } } } } }, "delete": { "tags": [ "DocumentType" ], "summary": "Delete an existing Resource", "operationId": "delete_38", "parameters": [ { "name": "id", "in": "path", "description": "identifier of document type", "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" } } } } } } }, "/erp/document-types/{id}/followUp/{followUpId}": { "get": { "tags": [ "DocumentType" ], "operationId": "getFollowUp", "parameters": [ { "name": "id", "in": "path", "description": "identifier of document type", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "followUpId", "in": "path", "description": "identifier of follow Up", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" } } } } } }, "put": { "tags": [ "DocumentType" ], "operationId": "updateFollowUp", "parameters": [ { "name": "id", "in": "path", "description": "identifier of document type", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "followUpId", "in": "path", "description": "identifier of follow up", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" } } } } } }, "delete": { "tags": [ "DocumentType" ], "operationId": "deleteFollowUp", "parameters": [ { "name": "id", "in": "path", "description": "identifier of document type", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "followUpId", "in": "path", "description": "identifier of follow Up Document Type", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/document-types/{id}/followUp/{followUpId}/deactivate": { "put": { "tags": [ "DocumentType" ], "operationId": "deactivateFollowUp", "parameters": [ { "name": "id", "in": "path", "description": "identifier of document type", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "followUpId", "in": "path", "description": "identifier of follow up", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" } } } } } } }, "/erp/document-types/{id}/followUp/{followUpId}/activate": { "put": { "tags": [ "DocumentType" ], "operationId": "activateFollowUp", "parameters": [ { "name": "id", "in": "path", "description": "identifier of document type", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "followUpId", "in": "path", "description": "identifier of follow up", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" } } } } } } }, "/erp/document-types/{id}/deactivate": { "put": { "tags": [ "DocumentType" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentType" } } } }, "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" } } } } } } }, "/erp/document-types/{id}/activate": { "put": { "tags": [ "DocumentType" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentType" } } } }, "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" } } } } } } }, "/erp/document-types/chains/{id}": { "get": { "tags": [ "DocumentTypeChain" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeChain" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "DocumentTypeChain" ], "summary": "Update existing Resource ", "operationId": "update_43", "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-DocumentTypeChain" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeChain" } } } }, "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" } } } } } }, "delete": { "tags": [ "DocumentTypeChain" ], "summary": "Delete an existing Resource", "operationId": "delete_39", "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" } } } } } } }, "/erp/delivery/terms/{id}": { "get": { "tags": [ "DeliveryTerm" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_48", "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-delivery-DeliveryTerm" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "DeliveryTerm" ], "summary": "Update existing Resource ", "operationId": "update_44", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-DeliveryTerm" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-DeliveryTerm" } } } }, "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" } } } } } }, "delete": { "tags": [ "DeliveryTerm" ], "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" } } } } } } }, "/erp/delivery/terms/{id}/deactivate": { "put": { "tags": [ "DeliveryTerm" ], "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-delivery-DeliveryTerm" } } } }, "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" } } } } } } }, "/erp/delivery/terms/{id}/activate": { "put": { "tags": [ "DeliveryTerm" ], "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-delivery-DeliveryTerm" } } } }, "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" } } } } } } }, "/erp/delivery/shipping-costs/{id}": { "get": { "tags": [ "Versandkosten" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-delivery-ShippingCost" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Versandkosten" ], "summary": "Update existing Resource ", "operationId": "update_45", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-ShippingCost" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-ShippingCost" } } } }, "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" } } } } } }, "delete": { "tags": [ "Versandkosten" ], "summary": "Delete an existing Resource", "operationId": "delete_41", "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" } } } } } } }, "/erp/custom-account-relation-types/{id}": { "get": { "tags": [ "CustomAccountRelationType" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_50", "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-account-CustomAccountRelationType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CustomAccountRelationType" ], "summary": "Update existing Resource ", "operationId": "update_46", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-CustomAccountRelationType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-CustomAccountRelationType" } } } }, "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" } } } } } }, "delete": { "tags": [ "CustomAccountRelationType" ], "summary": "Delete an existing Resource", "operationId": "delete_42", "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" } } } } } } }, "/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" } } } } } } }, "/erp/crm-tasks/types/{id}": { "get": { "tags": [ "Typen von Aufgaben" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_51", "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" } } } } } }, "put": { "tags": [ "Typen von Aufgaben" ], "summary": "Update existing Resource ", "operationId": "update_47", "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" } } } } } }, "delete": { "tags": [ "Typen von Aufgaben" ], "summary": "Delete an existing Resource", "operationId": "delete_43", "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" } } } } } } }, "/erp/crm-tasks/types/{id}/deactivate": { "put": { "tags": [ "Typen von Aufgaben" ], "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" } } } } } } }, "/erp/crm-tasks/types/{id}/activate": { "put": { "tags": [ "Typen von Aufgaben" ], "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" } } } } } } }, "/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" } } } } } } }, "/erp/crm-tasks/states/{id}": { "get": { "tags": [ "Status zu 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-CrmState" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Status zu 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-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" } } } } } }, "delete": { "tags": [ "Status zu Aufgaben" ], "summary": "Delete an existing Resource", "operationId": "delete_44", "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" } } } } } } }, "/erp/crm-tasks/states/{id}/deactivate": { "put": { "tags": [ "Status zu Aufgaben" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_23", "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" } } } } } } }, "/erp/crm-tasks/states/{id}/activate": { "put": { "tags": [ "Status zu Aufgaben" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_23", "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" } } } } } } }, "/erp/crm-tasks/priorities/{id}": { "get": { "tags": [ "Priorit\u00e4ten 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-CrmPriority" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Priorit\u00e4ten 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-CrmPriority" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } } }, "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" } } } } } }, "delete": { "tags": [ "Priorit\u00e4ten zu Aufgaben" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/crm-tasks/priorities/{crmTaskPriorityId}/move/{position}": { "put": { "tags": [ "Priorit\u00e4ten zu Aufgaben" ], "summary": "moves a line to a new position", "operationId": "moveLine_3", "parameters": [ { "name": "crmTaskPriorityId", "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-CrmPriority" } } } } } } }, "/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" } } } } } } }, "/erp/crm-projects/types/{id}": { "get": { "tags": [ "Typen von Projekten" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_54", "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" } } } } } }, "put": { "tags": [ "Typen von Projekten" ], "summary": "Update existing Resource ", "operationId": "update_50", "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" } } } } } }, "delete": { "tags": [ "Typen von Projekten" ], "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" } } } } } } }, "/erp/crm-projects/types/{id}/deactivate": { "put": { "tags": [ "Typen von Projekten" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_24", "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" } } } } } } }, "/erp/crm-projects/types/{id}/activate": { "put": { "tags": [ "Typen von Projekten" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_24", "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" } } } } } } }, "/erp/crm-projects/states/{projectStateId}/move/{position}": { "put": { "tags": [ "Status zu Projekten" ], "summary": "moves a line to a new position", "operationId": "moveLine_5", "parameters": [ { "name": "projectStateId", "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" } } } } } } }, "/erp/crm-projects/states/{id}": { "get": { "tags": [ "Status zu 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-CrmState" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Status zu 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-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" } } } } } }, "delete": { "tags": [ "Status zu Projekten" ], "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" } } } } } } }, "/erp/crm-projects/states/{id}/deactivate": { "put": { "tags": [ "Status zu Projekten" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_25", "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" } } } } } } }, "/erp/crm-projects/states/{id}/activate": { "put": { "tags": [ "Status zu Projekten" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_25", "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" } } } } } } }, "/erp/crm-projects/priorities/{id}": { "get": { "tags": [ "Priorit\u00e4t zu Projekten" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_56", "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-CrmPriority" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Priorit\u00e4t zu Projekten" ], "summary": "Update existing Resource ", "operationId": "update_52", "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-CrmPriority" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } } }, "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" } } } } } }, "delete": { "tags": [ "Priorit\u00e4t zu Projekten" ], "summary": "Delete an existing Resource", "operationId": "delete_48", "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" } } } } } } }, "/erp/crm-projects/priorities/{crmProjectPriorityId}/move/{position}": { "put": { "tags": [ "Priorit\u00e4t zu Projekten" ], "summary": "moves a line to a new position", "operationId": "moveLine_6", "parameters": [ { "name": "crmProjectPriorityId", "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-CrmPriority" } } } } } } }, "/erp/crm-projects/phases/{projectPhaseId}/move/{position}": { "put": { "tags": [ "Projekt-Phasen" ], "summary": "moves a line to a new position", "operationId": "moveLine_7", "parameters": [ { "name": "projectPhaseId", "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-CrmProjectPhase" } } } } } } }, "/erp/crm-projects/phases/{id}": { "get": { "tags": [ "Projekt-Phasen" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_57", "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-CrmProjectPhase" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Projekt-Phasen" ], "summary": "Update existing Resource ", "operationId": "update_53", "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-CrmProjectPhase" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmProjectPhase" } } } }, "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" } } } } } }, "delete": { "tags": [ "Projekt-Phasen" ], "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" } } } } } } }, "/erp/crm-projects/phases/{id}/deactivate": { "put": { "tags": [ "Projekt-Phasen" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_26", "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-CrmProjectPhase" } } } }, "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" } } } } } } }, "/erp/crm-projects/phases/{id}/activate": { "put": { "tags": [ "Projekt-Phasen" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_26", "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-CrmProjectPhase" } } } }, "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" } } } } } } }, "/erp/crm-deals/visibilities/{id}": { "get": { "tags": [ "Sichtbarkeit von CRM-Deals" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_58", "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-CrmDealVisibility" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Sichtbarkeit von CRM-Deals" ], "summary": "Update existing Resource ", "operationId": "update_54", "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-CrmDealVisibility" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealVisibility" } } } }, "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" } } } } } }, "delete": { "tags": [ "Sichtbarkeit von CRM-Deals" ], "summary": "Delete an existing Resource", "operationId": "delete_50", "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" } } } } } } }, "/erp/crm-deals/types/{id}": { "get": { "tags": [ "Typen von Deals" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_59", "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" } } } } } }, "put": { "tags": [ "Typen von Deals" ], "summary": "Update existing Resource ", "operationId": "update_55", "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" } } } } } }, "delete": { "tags": [ "Typen von Deals" ], "summary": "Delete an existing Resource", "operationId": "delete_51", "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" } } } } } } }, "/erp/crm-deals/types/{id}/deactivate": { "put": { "tags": [ "Typen von Deals" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_27", "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" } } } } } } }, "/erp/crm-deals/types/{id}/activate": { "put": { "tags": [ "Typen von Deals" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_27", "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" } } } } } } }, "/erp/crm-deals/types/{dealSubTypeId}/move/{position}": { "put": { "tags": [ "Typen von Deals" ], "summary": "moves a line to a new position", "operationId": "moveLine_8", "parameters": [ { "name": "dealSubTypeId", "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" } } } } } } }, "/erp/crm-deals/topics/{id}": { "get": { "tags": [ "Themen zu Deals" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_60", "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-CrmDealTopic" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Themen zu Deals" ], "summary": "Update existing Resource ", "operationId": "update_56", "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-CrmDealTopic" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealTopic" } } } }, "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" } } } } } }, "delete": { "tags": [ "Themen zu Deals" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/crm-deals/topics/{id}/deactivate": { "put": { "tags": [ "Themen zu Deals" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_28", "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-CrmDealTopic" } } } }, "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" } } } } } } }, "/erp/crm-deals/topics/{id}/activate": { "put": { "tags": [ "Themen zu Deals" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_28", "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-CrmDealTopic" } } } }, "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" } } } } } } }, "/erp/crm-deals/topics/{dealTopicId}/move/{position}": { "put": { "tags": [ "Themen zu Deals" ], "summary": "moves a line to a new position", "operationId": "moveLine_9", "parameters": [ { "name": "dealTopicId", "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-CrmDealTopic" } } } } } } }, "/erp/crm-deals/states/{id}": { "get": { "tags": [ "Status zu Deals" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_61", "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" } } } } } }, "put": { "tags": [ "Status zu Deals" ], "summary": "Update existing Resource ", "operationId": "update_57", "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" } } } } } }, "delete": { "tags": [ "Status zu Deals" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/crm-deals/states/{id}/deactivate": { "put": { "tags": [ "Status zu Deals" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_29", "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" } } } } } } }, "/erp/crm-deals/states/{id}/activate": { "put": { "tags": [ "Status zu Deals" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_29", "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" } } } } } } }, "/erp/crm-deals/states/{dealStateId}/move/{position}": { "put": { "tags": [ "Status zu Deals" ], "summary": "moves a line to a new position", "operationId": "moveLine_10", "parameters": [ { "name": "dealStateId", "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" } } } } } } }, "/erp/crm-deals/priorities/{id}": { "get": { "tags": [ "Priorit\u00e4ten zu Deals" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-crm-CrmPriority" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Priorit\u00e4ten zu Deals" ], "summary": "Update existing Resource ", "operationId": "update_58", "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-CrmPriority" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } } }, "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" } } } } } }, "delete": { "tags": [ "Priorit\u00e4ten zu Deals" ], "summary": "Delete an existing Resource", "operationId": "delete_54", "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" } } } } } } }, "/erp/crm-deals/priorities/{crmDealPriorityId}/move/{position}": { "put": { "tags": [ "Priorit\u00e4ten zu Deals" ], "summary": "moves a line to a new position", "operationId": "moveLine_11", "parameters": [ { "name": "crmDealPriorityId", "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-CrmPriority" } } } } } } }, "/erp/crm-deals/closing-reasons/{id}": { "get": { "tags": [ "Abschlu\u00dfgr\u00fcnde zu Deals" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_63", "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-CrmDealClosingReason" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Abschlu\u00dfgr\u00fcnde zu Deals" ], "summary": "Update existing Resource ", "operationId": "update_59", "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-CrmDealClosingReason" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealClosingReason" } } } }, "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" } } } } } }, "delete": { "tags": [ "Abschlu\u00dfgr\u00fcnde zu Deals" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/crm-deals/closing-reasons/{id}/deactivate": { "put": { "tags": [ "Abschlu\u00dfgr\u00fcnde zu Deals" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_30", "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-CrmDealClosingReason" } } } }, "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" } } } } } } }, "/erp/crm-deals/closing-reasons/{id}/activate": { "put": { "tags": [ "Abschlu\u00dfgr\u00fcnde zu Deals" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_30", "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-CrmDealClosingReason" } } } }, "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" } } } } } } }, "/erp/crm-deals/closing-reasons/{dealClosingReasonId}/move/{position}": { "put": { "tags": [ "Abschlu\u00dfgr\u00fcnde zu Deals" ], "summary": "moves a line to a new position", "operationId": "moveLine_12", "parameters": [ { "name": "dealClosingReasonId", "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-CrmDealClosingReason" } } } } } } }, "/erp/crm-activities/{id}": { "get": { "tags": [ "Aktivit\u00e4ten" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_65", "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-CrmActivity" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Aktivit\u00e4ten" ], "summary": "Update existing Resource ", "operationId": "update_60", "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-CrmActivity" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivity" } } } }, "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" } } } } } }, "delete": { "tags": [ "Aktivit\u00e4ten" ], "summary": "Delete an existing Resource", "operationId": "delete_56", "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" } } } } } } }, "/erp/crm-activities/types/{id}": { "get": { "tags": [ "Aktivit\u00e4tsarten" ], "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-CrmActivityType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Aktivit\u00e4tsarten" ], "summary": "Update existing Resource ", "operationId": "update_61", "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-CrmActivityType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityType" } } } }, "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" } } } } } }, "delete": { "tags": [ "Aktivit\u00e4tsarten" ], "summary": "Delete an existing Resource", "operationId": "delete_57", "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" } } } } } } }, "/erp/crm-activities/types/{id}/deactivate": { "put": { "tags": [ "Aktivit\u00e4tsarten" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_31", "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-CrmActivityType" } } } }, "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" } } } } } } }, "/erp/crm-activities/types/{id}/activate": { "put": { "tags": [ "Aktivit\u00e4tsarten" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_31", "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-CrmActivityType" } } } }, "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" } } } } } } }, "/erp/crm-activities/types/{activityTypeId}/move/{position}": { "put": { "tags": [ "Aktivit\u00e4tsarten" ], "summary": "moves a line to a new position", "operationId": "moveLine_13", "parameters": [ { "name": "activityTypeId", "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-CrmActivityType" } } } } } } }, "/erp/crm-activities/types-per-user/{id}": { "get": { "tags": [ "Aktivit\u00e4tstypen pro Benutzer" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-crm-CrmActivityTypePerUser" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Aktivit\u00e4tstypen pro Benutzer" ], "summary": "Update existing Resource ", "operationId": "update_62", "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" } } } } } }, "delete": { "tags": [ "Aktivit\u00e4tstypen pro Benutzer" ], "summary": "Delete an existing Resource", "operationId": "delete_58", "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" } } } } } } }, "/erp/crm-activities/set-billed": { "put": { "tags": [ "Aktivit\u00e4ten" ], "operationId": "setActivitiesBilled", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-SetActivitiesBilledRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmActivity" } } } } } } } }, "/erp/crm-activities/billing-rules/{id}": { "get": { "tags": [ "Abrechnungsregeln zu Aktivit\u00e4ten" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-crm-CrmActivityBillingRule" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Abrechnungsregeln zu Aktivit\u00e4ten" ], "summary": "Update existing Resource ", "operationId": "update_63", "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-CrmActivityBillingRule" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityBillingRule" } } } }, "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" } } } } } }, "delete": { "tags": [ "Abrechnungsregeln zu Aktivit\u00e4ten" ], "summary": "Delete an existing Resource", "operationId": "delete_59", "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" } } } } } } }, "/erp/contact-types/{id}": { "get": { "tags": [ "ContactType" ], "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-account-ContactType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "ContactType" ], "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-account-ContactType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-ContactType" } } } }, "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" } } } } } }, "delete": { "tags": [ "ContactType" ], "summary": "Delete an existing Resource", "operationId": "delete_60", "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" } } } } } } }, "/erp/contact-types/{id}/deactivate": { "put": { "tags": [ "ContactType" ], "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-account-ContactType" } } } }, "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" } } } } } } }, "/erp/contact-types/{id}/activate": { "put": { "tags": [ "ContactType" ], "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-account-ContactType" } } } }, "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" } } } } } } }, "/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": { "type": "object" } } } } } } }, "/erp/commission/commission-assignment/{id}": { "get": { "tags": [ "CommissionAssignment" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_71", "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-commission-CommissionAssignment" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CommissionAssignment" ], "summary": "Update existing Resource ", "operationId": "update_65", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-commission-CommissionAssignment" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-commission-CommissionAssignment" } } } }, "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" } } } } } }, "delete": { "tags": [ "CommissionAssignment" ], "summary": "Delete an existing Resource", "operationId": "delete_61", "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" } } } } } } }, "/erp/bundle-schemata/{id}": { "get": { "tags": [ "bundle schema" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_72", "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-BundleSchema" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "bundle schema" ], "summary": "Update existing Resource ", "operationId": "update_66", "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-BundleSchema" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-BundleSchema" } } } }, "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" } } } } } }, "delete": { "tags": [ "bundle schema" ], "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" } } } } } } }, "/erp/bank/{id}": { "get": { "tags": [ "Bank" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_73", "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" } } } } } }, "put": { "tags": [ "Bank" ], "summary": "Update existing Resource ", "operationId": "update_67", "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" } } } } } }, "delete": { "tags": [ "Bank" ], "summary": "Delete an existing Resource", "operationId": "delete_63", "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" } } } } } } }, "/erp/bank/{id}/deactivate": { "put": { "tags": [ "Bank" ], "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-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" } } } } } } }, "/erp/bank/{id}/activate": { "put": { "tags": [ "Bank" ], "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-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" } } } } } } }, "/erp/bank/transactions/{id}": { "get": { "tags": [ "BankTransactions" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_74", "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" } } } } } }, "put": { "tags": [ "BankTransactions" ], "summary": "Update existing Resource ", "operationId": "update_68", "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" } } } } } }, "delete": { "tags": [ "BankTransactions" ], "summary": "Delete an existing Resource", "operationId": "delete_64", "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" } } } } } } }, "/erp/bank/payments/{id}": { "get": { "tags": [ "BankPayment" ], "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-BankPayment" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "BankPayment" ], "summary": "Update existing Resource ", "operationId": "update_69", "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-BankPayment" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } } }, "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" } } } } } }, "delete": { "tags": [ "BankPayment" ], "summary": "Delete an existing Resource", "operationId": "delete_65", "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" } } } } } } }, "/erp/bank/backend/{id}": { "get": { "tags": [ "BankingBackend" ], "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-BankingBackend" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "BankingBackend" ], "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-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" } } } } } }, "delete": { "tags": [ "BankingBackend" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/bank/backend/{id}/deactivate": { "put": { "tags": [ "BankingBackend" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_34", "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" } } } } } } }, "/erp/bank/backend/{id}/activate": { "put": { "tags": [ "BankingBackend" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_34", "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" } } } } } } }, "/erp/bank/accounts/{id}": { "get": { "tags": [ "BankAccount" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_77", "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-BankAccount" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "BankAccount" ], "summary": "Update existing Resource ", "operationId": "update_71", "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-BankAccount" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankAccount" } } } }, "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" } } } } } }, "delete": { "tags": [ "BankAccount" ], "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" } } } } } } }, "/erp/bank/accounts/{id}/deactivate": { "put": { "tags": [ "BankAccount" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankAccount" } } } }, "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" } } } } } } }, "/erp/bank/accounts/{id}/activate": { "put": { "tags": [ "BankAccount" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankAccount" } } } }, "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" } } } } } } }, "/erp/bank/accounts/{accountId}/reset_last_import": { "put": { "tags": [ "BankAccount" ], "operationId": "resetLastImport", "parameters": [ { "name": "accountId", "in": "path", "description": "ID des Accounts", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/articles/{id}": { "get": { "tags": [ "Article" ], "operationId": "getArticleById", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gew\u00fcnschte Sprache (z.B. de)", "required": false, "style": "form", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Article" } } } } } }, "put": { "tags": [ "Article" ], "summary": "Update existing article", "operationId": "update_72", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gew\u00fcnschte Sprache (z.B. de)", "required": false, "style": "form", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-Article" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Article" } } } }, "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" } } } } } }, "delete": { "tags": [ "Article" ], "operationId": "deleteById", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/articles/{id}/taxes/{taxId}": { "put": { "tags": [ "Article" ], "summary": "Update existing Resource ", "operationId": "updateTax", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taxId", "in": "path", "description": "ID of product-tax", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleTax" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleTax" } } } }, "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" } } } } } }, "delete": { "tags": [ "Article" ], "summary": "Delete an existing Resource", "operationId": "deleteTax", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taxId", "in": "path", "description": "ID of product-tax", "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" } } } } } } }, "/erp/articles/{id}/storages/{storageId}": { "get": { "tags": [ "ArticleStorage" ], "operationId": "getArticleStorageByStorage", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storageId", "in": "path", "description": "ID of storage", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-ArticleStorage" } } } } } }, "put": { "tags": [ "ArticleStorage" ], "operationId": "updateArticleStorage", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storageId", "in": "path", "description": "ID of storage", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-ArticleStorage" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-ArticleStorage" } } } } } } }, "/erp/articles/{id}/leasable-lock/{lockToken}": { "put": { "tags": [ "Article" ], "summary": "Verl\u00e4ngert eine Sperre", "operationId": "refreshLeasableLock_1", "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\u00e4ngernden 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" } } } } } }, "delete": { "tags": [ "Article" ], "summary": "Gibt ein Sperre frei", "operationId": "releaseLeasableLock_1", "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" } } } }, "/erp/articles/{id}/fabrication-components/{componentId}": { "get": { "tags": [ "Article" ], "operationId": "getFabricationComponent", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "componentId", "in": "path", "description": "an component id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleFabricationComponent" } } } } } }, "put": { "tags": [ "Article" ], "operationId": "updateFabricationComponent", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "componentId", "in": "path", "description": "an component id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleFabricationComponent" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleFabricationComponent" } } } } } }, "delete": { "tags": [ "Article" ], "operationId": "deleteFabricationComponent", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "componentId", "in": "path", "description": "an component id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/articles/{id}/deactivate": { "put": { "tags": [ "Article" ], "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-product-Article" } } } }, "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" } } } } } } }, "/erp/articles/{id}/components/{componentId}": { "get": { "tags": [ "Article" ], "operationId": "getComponent", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "componentId", "in": "path", "description": "an component id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleComponent" } } } } } }, "put": { "tags": [ "Article" ], "operationId": "updateComponent", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "componentId", "in": "path", "description": "an component id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleComponent" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleComponent" } } } } } }, "delete": { "tags": [ "Article" ], "operationId": "deleteComponent", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "componentId", "in": "path", "description": "an component id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/articles/{id}/activate": { "put": { "tags": [ "Article" ], "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-product-Article" } } } }, "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" } } } } } } }, "/erp/articles/{articleId}/storage-areas/{articleStorageAreaId}": { "get": { "tags": [ "Lagerbereiche" ], "operationId": "getArticleStorageArea", "parameters": [ { "name": "articleId", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "articleStorageAreaId", "in": "path", "description": "ID of Storage-Area", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleStorageArea" } } } } } }, "put": { "tags": [ "Lagerbereiche" ], "operationId": "updateArticleStorageArea", "parameters": [ { "name": "articleId", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "articleStorageAreaId", "in": "path", "description": "ID of article-storage-area", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleStorageArea" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleStorageArea" } } } } } }, "delete": { "tags": [ "Lagerbereiche" ], "operationId": "deleteArticleStorageArea", "parameters": [ { "name": "articleId", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "articleStorageAreaId", "in": "path", "description": "ID of article-storage-area", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/articles/{articleId}/listings/{listingId}": { "get": { "tags": [ "Article" ], "operationId": "getListing", "parameters": [ { "name": "articleId", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingId", "in": "path", "description": "a listing id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gew\u00fcnschte Sprache (z.B. de)", "required": false, "style": "form", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleListing" } } } } } }, "put": { "tags": [ "Article" ], "operationId": "updateListing_2", "parameters": [ { "name": "articleId", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingId", "in": "path", "description": "an sales-channel id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gew\u00fcnschte Sprache (z.B. de)", "required": false, "style": "form", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleListing" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleListing" } } } } } }, "patch": { "tags": [ "Article" ], "operationId": "partialUpdateListing_2", "parameters": [ { "name": "articleId", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingId", "in": "path", "description": "an listingId id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gew\u00fcnschte Sprache (z.B. de)", "required": false, "style": "form", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleListing" } } } } } } }, "/erp/articles/{articleId}/listings/{listingId}/state": { "put": { "tags": [ "Article" ], "operationId": "updateListingState", "parameters": [ { "name": "articleId", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingId", "in": "path", "description": "an listing id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string", "description": "Synchronisationsstatus eines Listings", "enum": [ "DISABLED", "NEED_SYNCHRONIZE", "QUEUED_FOR_SYNCHRONIZE", "SYNCHRONIZED", "ERRONEOUS", "NEED_DELETION", "QUEUED_FOR_DELETION" ] } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/articles/serial-numbers/{id}": { "get": { "tags": [ "SerialNumber" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_78", "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-ArticleSerialNumber" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "SerialNumber" ], "summary": "Update existing Resource ", "operationId": "update_73", "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-ArticleSerialNumber" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" } } } }, "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" } } } } } }, "delete": { "tags": [ "SerialNumber" ], "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": { "*/*": { "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" } } } } } } }, "/erp/articles/print-labels/{batchId}": { "put": { "tags": [ "Article" ], "summary": "F\u00fchrt den Druck eines Etikettendruck-Stapels durch", "operationId": "printBatch", "parameters": [ { "name": "batchId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/erp/article-suppliers/{id}": { "get": { "tags": [ "ArticleSupplier" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSupplier" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "ArticleSupplier" ], "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-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" } } } } } }, "delete": { "tags": [ "ArticleSupplier" ], "summary": "Delete an existing Resource", "operationId": "delete_69", "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" } } } } } } }, "/erp/article-suppliers/{id}/deactivate": { "put": { "tags": [ "ArticleSupplier" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_37", "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" } } } } } } }, "/erp/article-suppliers/{id}/activate": { "put": { "tags": [ "ArticleSupplier" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_37", "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" } } } } } } }, "/erp/article-customers/{id}": { "get": { "tags": [ "ArticleCustomer" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_80", "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" } } } } } }, "put": { "tags": [ "ArticleCustomer" ], "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-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" } } } } } }, "delete": { "tags": [ "ArticleCustomer" ], "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": { "*/*": { "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" } } } } } } }, "/erp/article-customers/{id}/deactivate": { "put": { "tags": [ "ArticleCustomer" ], "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-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" } } } } } } }, "/erp/article-customers/{id}/activate": { "put": { "tags": [ "ArticleCustomer" ], "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-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" } } } } } } }, "/erp/accounts/{id}/output-rule/{ruleid}": { "get": { "tags": [ "account" ], "operationId": "readRuleById", "parameters": [ { "name": "id", "in": "path", "description": "account id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ruleid", "in": "path", "description": "rule id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountOutputRule" } } } } } }, "put": { "tags": [ "account" ], "operationId": "updateRule", "parameters": [ { "name": "id", "in": "path", "description": "account id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ruleid", "in": "path", "description": "rule id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountOutputRule" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountOutputRule" } } } } } }, "delete": { "tags": [ "account" ], "operationId": "deleteRule", "parameters": [ { "name": "id", "in": "path", "description": "account id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ruleid", "in": "path", "description": "rule id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/duplicates/{targetAccount}/deduplicate/{sourceAccount}": { "put": { "tags": [ "account" ], "operationId": "manualDeduplicateTwoAccounts", "parameters": [ { "name": "targetAccount", "in": "path", "description": "The target Account that will remain after deduplication", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "sourceAccount", "in": "path", "description": "The source Account whose data will be merged into the target, and which will then be deleted", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-account-Account" } } } } } } }, "/erp/accounts/duplicates/{duplicateId}/toggle_duplicate": { "put": { "tags": [ "account" ], "operationId": "toggleDuplicate", "parameters": [ { "name": "duplicateId", "in": "path", "description": "account-duplikat identifier ", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "markedNonDuplicate", "in": "query", "description": "zuweisung ob duplikat oder nicht", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/duplicates/{duplicateId}/deduplicateDuplicate": { "put": { "tags": [ "account" ], "operationId": "deduplicateDeduplicate", "parameters": [ { "name": "duplicateId", "in": "path", "description": "duplicate identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "useFirstAccountAsMainAccount", "in": "query", "description": "use first account as main account", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-account-Account" } } } } } } }, "/erp/account-types/supplier-group/{id}": { "get": { "tags": [ "SupplierGroup" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SupplierGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "SupplierGroup" ], "summary": "Update existing Resource ", "operationId": "update_76", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SupplierGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SupplierGroup" } } } }, "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" } } } } } }, "delete": { "tags": [ "SupplierGroup" ], "summary": "Delete an existing Resource", "operationId": "delete_71", "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" } } } } } } }, "/erp/account-types/supplier-group/{id}/deactivate": { "put": { "tags": [ "SupplierGroup" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SupplierGroup" } } } }, "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" } } } } } } }, "/erp/account-types/supplier-group/{id}/activate": { "put": { "tags": [ "SupplierGroup" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SupplierGroup" } } } }, "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" } } } } } } }, "/erp/account-types/customer-group/{id}": { "get": { "tags": [ "CustomerGroup" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-account-CustomerGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CustomerGroup" ], "summary": "Update existing Resource ", "operationId": "update_77", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-CustomerGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-CustomerGroup" } } } }, "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" } } } } } }, "delete": { "tags": [ "CustomerGroup" ], "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": { "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" } } } } } } }, "/erp/account-types/customer-group/{id}/deactivate": { "put": { "tags": [ "CustomerGroup" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_40", "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-account-CustomerGroup" } } } }, "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" } } } } } } }, "/erp/account-types/customer-group/{id}/activate": { "put": { "tags": [ "CustomerGroup" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_40", "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-account-CustomerGroup" } } } }, "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" } } } } } } }, "/dms/resources/{id}": { "get": { "tags": [ "Documents" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocument" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Documents" ], "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/dms-shelf-ShelfDocument" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocument" } } } }, "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" } } } } } } }, "/dms/resources/{id}/transformations/{transformationId}": { "get": { "tags": [ "Image Transformations" ], "operationId": "getImageTransformation", "parameters": [ { "name": "id", "in": "path", "description": "image id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "transformationId", "in": "path", "description": "transformation id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfImageTransformation" } } } } } }, "put": { "tags": [ "Image Transformations" ], "summary": "Update existing Image Transformation", "operationId": "updateTransformation", "parameters": [ { "name": "id", "in": "path", "description": "image id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "transformationId", "in": "path", "description": "transformationId", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfImageTransformation" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfImageTransformation" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Image Transformations" ], "summary": "delete an existing image share", "operationId": "deleteImageTransformationById", "parameters": [ { "name": "id", "in": "path", "description": "image id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "transformationId", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/dms/resources/{id}/shares/{shareId}": { "get": { "tags": [ "Documents" ], "summary": "get ONE existing share", "operationId": "getShareById", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "shareId", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfShare" } } } } } }, "put": { "tags": [ "Documents" ], "summary": "Update existing Share", "operationId": "updateShare", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "shareId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfShare" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfShare" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Documents" ], "summary": "delete an existing share", "operationId": "deleteShareById", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "shareId", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/dms/resources/{id}/file-transfer/{token}/{part}": { "put": { "tags": [ "Documents" ], "summary": "upload/change a file transfer part", "operationId": "updateFileTransferPart", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "token", "in": "path", "description": "file-transfer token", "required": true, "schema": { "type": "string" } }, { "name": "part", "in": "path", "description": "unique part number", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-TransferFilePartUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Documents" ], "summary": "upload/change a file transfer part", "operationId": "createFileTransferPart", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "token", "in": "path", "description": "file-transfer token", "required": true, "schema": { "type": "string" } }, { "name": "part", "in": "path", "description": "unique part number", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-TransferFilePartCreateResponse" } } } } } } }, "/dms/resources/{id}/deletion_state": { "put": { "tags": [ "Documents" ], "operationId": "updateDeletionState", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "newDeletionState", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "NOT_YET", "PREPARE_DELETE", "MANUALLY_RETAIN" ] } } ], "responses": { "200": { "description": "OK" } } } }, "/dms/resources/{id}/deactivate": { "put": { "tags": [ "Documents" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_41", "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/dms-shelf-ShelfDocument" } } } }, "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" } } } } } } }, "/dms/resources/{id}/activate": { "put": { "tags": [ "Documents" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_41", "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/dms-shelf-ShelfDocument" } } } }, "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" } } } } } } }, "/dms/resources/types/{id}": { "get": { "tags": [ "Document Types" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Document Types" ], "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/dms-shelf-ShelfDocumentType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentType" } } } }, "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" } } } } } }, "delete": { "tags": [ "Document Types" ], "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": { "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" } } } } } } }, "/dms/attributions/{id}": { "get": { "tags": [ "Attributions" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/dms-shelf-ShelfDocumentAttribution" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Attributions" ], "summary": "Update existing Resource ", "operationId": "update_80", "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" } } } } } }, "delete": { "tags": [ "Attributions" ], "summary": "Delete an existing Resource", "operationId": "delete_74", "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" } } } } } } }, "/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" } } } }, "/vds/carrier/{id}/deactivate": { "put": { "tags": [ "carrier-resource" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_42", "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/vds-carrier-Carrier" } } } }, "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" } } } } } } }, "/vds/carrier/{id}/activate": { "put": { "tags": [ "carrier-resource" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_42", "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/vds-carrier-Carrier" } } } }, "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" } } } } } } }, "/vds/carrier/{id}": { "get": { "tags": [ "carrier-resource" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/vds-carrier-Carrier" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "carrier-resource" ], "summary": "Update existing Resource ", "operationId": "update_81", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-carrier-Carrier" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-carrier-Carrier" } } } }, "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" } } } } } }, "delete": { "tags": [ "carrier-resource" ], "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": { "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" } } } } } } }, "/vds/carrier/{carrierId}/parameter/{key}": { "put": { "tags": [ "carrier-resource" ], "summary": "Sets the meta 'parameter' data (authentification fields and options) for a given Carrier.", "operationId": "updateParameter", "parameters": [ { "name": "carrierId", "in": "path", "description": "carrierId", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "APP", "NONE" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-unknownmodule-CarrierParameterType" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/vds/carrier-type/{id}/deactivate": { "put": { "tags": [ "carrier-type-resource" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_43", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-carrier-CarrierType" } } } }, "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" } } } } } } }, "/vds/carrier-type/{id}/activate": { "put": { "tags": [ "carrier-type-resource" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_43", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-carrier-CarrierType" } } } }, "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" } } } } } } }, "/vds/carrier-type/{id}": { "get": { "tags": [ "carrier-type-resource" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_88", "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/vds-carrier-CarrierType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "carrier-type-resource" ], "summary": "Update existing Resource ", "operationId": "update_82", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-carrier-CarrierType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-carrier-CarrierType" } } } }, "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" } } } } } }, "delete": { "tags": [ "carrier-type-resource" ], "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" } } } } } } }, "/erp/statistic/scenario/{id}/editable": { "put": { "tags": [ "scenario-resource" ], "operationId": "stateEdit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/erp/statistic/scenario/{id}/activate": { "put": { "tags": [ "scenario-resource" ], "operationId": "stateActive", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/erp/statistic/scenario/{id}": { "get": { "tags": [ "scenario-resource" ], "summary": "Find an existing Instance by identifier", "operationId": "getById_89", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-api-Scenario" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "scenario-resource" ], "summary": "Update a Instance", "operationId": "update_83", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-api-Scenario" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-api-Scenario" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "scenario-resource" ], "summary": "delete an existing Instance by identifier", "operationId": "deleteById_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "Resource is not deletable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/statistic/scenario-desired-value/{id}": { "get": { "tags": [ "scenario-desired-value-resource" ], "summary": "Find an existing Instance by identifier", "operationId": "getById_90", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioDesiredValue" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "scenario-desired-value-resource" ], "summary": "Update a Instance", "operationId": "update_84", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioDesiredValue" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioDesiredValue" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "scenario-desired-value-resource" ], "summary": "delete an existing Instance by identifier", "operationId": "deleteById_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "Resource is not deletable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/statistic/scenario-actual-value/{id}": { "get": { "tags": [ "scenario-actual-value-resource" ], "summary": "Find an existing Instance by identifier", "operationId": "getById_91", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioActualValue" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "scenario-actual-value-resource" ], "summary": "Update a Instance", "operationId": "update_85", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioActualValue" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioActualValue" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "scenario-actual-value-resource" ], "summary": "delete an existing Instance by identifier", "operationId": "deleteById_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "Resource is not deletable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } } } } }, "/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" ] } } } } } } }, "/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" ] } } } } } } }, "/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" ] } } } } } } }, "/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" } } } }, "/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" } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/sales-channels/{id}": { "get": { "tags": [ "SalesChannel" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_92", "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" } } } } } }, "put": { "tags": [ "SalesChannel" ], "summary": "Update existing Resource ", "operationId": "update_86", "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" } } } } } }, "delete": { "tags": [ "SalesChannel" ], "summary": "Delete an existing Resource", "operationId": "delete_77", "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/sales-channels/backend/{id}": { "get": { "tags": [ "SalesChannel" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_93", "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" } } } } } }, "put": { "tags": [ "SalesChannel" ], "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/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" } } } } } }, "delete": { "tags": [ "SalesChannel" ], "summary": "Delete an existing Resource", "operationId": "delete_78", "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" } } } } } } }, "/erp/pos/payment/method/{id}/deactivate": { "put": { "tags": [ "PosPaymentMethod" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_46", "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-PosPaymentMethod" } } } }, "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" } } } } } } }, "/erp/pos/payment/method/{id}/activate": { "put": { "tags": [ "PosPaymentMethod" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_46", "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-PosPaymentMethod" } } } }, "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" } } } } } } }, "/erp/pos/payment/method/{id}": { "get": { "tags": [ "PosPaymentMethod" ], "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/erp-pos-PosPaymentMethod" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "PosPaymentMethod" ], "summary": "Update existing Resource ", "operationId": "update_88", "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-PosPaymentMethod" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentMethod" } } } }, "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" } } } } } }, "delete": { "tags": [ "PosPaymentMethod" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/erp/pos/payment/backend/{id}/deactivate": { "put": { "tags": [ "PosPaymentBackend" ], "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-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" } } } } } } }, "/erp/pos/payment/backend/{id}/activate": { "put": { "tags": [ "PosPaymentBackend" ], "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-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" } } } } } } }, "/erp/pos/payment/backend/{id}": { "get": { "tags": [ "PosPaymentBackend" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_95", "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" } } } } } }, "put": { "tags": [ "PosPaymentBackend" ], "summary": "Update existing Resource ", "operationId": "update_89", "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" } } } } } }, "delete": { "tags": [ "PosPaymentBackend" ], "summary": "Delete an existing Resource", "operationId": "delete_80", "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" } } } } } } }, "/erp/finance/backend/{id}/deactivate": { "put": { "tags": [ "FinanceBookingBackend" ], "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-finance-FinanceBookingBackend" } } } }, "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" } } } } } } }, "/erp/finance/backend/{id}/activate": { "put": { "tags": [ "FinanceBookingBackend" ], "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-finance-FinanceBookingBackend" } } } }, "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" } } } } } } }, "/erp/finance/backend/{id}": { "get": { "tags": [ "FinanceBookingBackend" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_97", "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-FinanceBookingBackend" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "FinanceBookingBackend" ], "summary": "Update existing Resource ", "operationId": "update_90", "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-FinanceBookingBackend" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBookingBackend" } } } }, "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" } } } } } }, "delete": { "tags": [ "FinanceBookingBackend" ], "summary": "Delete an existing Resource", "operationId": "delete_81", "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" } } } } } } }, "/erp/delivery/methods/{id}/deactivate": { "put": { "tags": [ "DeliveryMethod" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_49", "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-delivery-DeliveryMethod" } } } }, "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" } } } } } } }, "/erp/delivery/methods/{id}/activate": { "put": { "tags": [ "DeliveryMethod" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_49", "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-delivery-DeliveryMethod" } } } }, "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" } } } } } } }, "/erp/delivery/methods/{id}": { "get": { "tags": [ "DeliveryMethod" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_98", "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-delivery-DeliveryMethod" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "DeliveryMethod" ], "summary": "Update existing Resource ", "operationId": "update_91", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-DeliveryMethod" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-DeliveryMethod" } } } }, "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" } } } } } }, "delete": { "tags": [ "DeliveryMethod" ], "summary": "Delete an existing Resource", "operationId": "delete_82", "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" } } } } } } }, "/erp/crm-tasks/{id}/reminders/{reminderId}": { "get": { "tags": [ "Aufgaben" ], "operationId": "getReminder", "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" } } } } } }, "put": { "tags": [ "Aufgaben" ], "operationId": "updateReminder", "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" } } } } } }, "delete": { "tags": [ "Aufgaben" ], "operationId": "deleteReminder", "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" } } } } } } }, "/erp/crm-tasks/{id}/finish": { "put": { "tags": [ "Aufgaben" ], "operationId": "finish", "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-CrmTask" } } } } } } }, "/erp/crm-tasks/{id}": { "get": { "tags": [ "Aufgaben" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-crm-CrmTask" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Aufgaben" ], "summary": "Update existing Resource ", "operationId": "update_92", "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-CrmTaskCreateOrUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmTask" } } } }, "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" } } } } } }, "delete": { "tags": [ "Aufgaben" ], "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" } } } } } }, "patch": { "tags": [ "Aufgaben" ], "summary": "Patch existing Resource ", "operationId": "partialUpdate", "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-CrmTask" } } } }, "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" } } } } } } }, "/erp/crm-tasks/parent/{childId}": { "get": { "tags": [ "Aufgaben" ], "operationId": "getParent", "parameters": [ { "name": "childId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } } } } } }, "put": { "tags": [ "Aufgaben" ], "operationId": "updateParent", "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" } } } } } }, "delete": { "tags": [ "Aufgaben" ], "operationId": "removeParent", "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" } } } } } } }, "/erp/crm-tasks/children/{parentId}": { "get": { "tags": [ "Aufgaben" ], "operationId": "getChildren", "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" } } } } } } }, "put": { "tags": [ "Aufgaben" ], "operationId": "updateChildren", "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" } } } } } } }, "delete": { "tags": [ "Aufgaben" ], "operationId": "removeChildren", "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" } } } } } } }, "/erp/crm-projects/{id}/reminders/{reminderId}": { "get": { "tags": [ "Projekte" ], "operationId": "getReminder_1", "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" } } } } } }, "put": { "tags": [ "Projekte" ], "operationId": "updateReminder_1", "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" } } } } } }, "delete": { "tags": [ "Projekte" ], "operationId": "deleteReminder_1", "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" } } } } } } }, "/erp/crm-projects/{id}": { "get": { "tags": [ "Projekte" ], "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-crm-CrmProject" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Projekte" ], "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-crm-CrmProjectCreateOrUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmProject" } } } }, "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" } } } } } }, "delete": { "tags": [ "Projekte" ], "summary": "Delete an existing Resource", "operationId": "delete_84", "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" } } } } } }, "patch": { "tags": [ "Projekte" ], "summary": "Patch existing Resource ", "operationId": "partialUpdate_1", "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-CrmProject" } } } }, "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" } } } } } } }, "/erp/crm-projects/parent/{childId}": { "get": { "tags": [ "Projekte" ], "operationId": "getParent_1", "parameters": [ { "name": "childId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } } } } } }, "put": { "tags": [ "Projekte" ], "operationId": "updateParent_1", "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" } } } } } }, "delete": { "tags": [ "Projekte" ], "operationId": "removeParent_1", "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" } } } } } } }, "/erp/crm-projects/children/{parentId}": { "get": { "tags": [ "Projekte" ], "operationId": "getChildren_1", "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" } } } } } } }, "put": { "tags": [ "Projekte" ], "operationId": "updateChildren_1", "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" } } } } } } }, "delete": { "tags": [ "Projekte" ], "operationId": "removeChildren_1", "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" } } } } } } }, "/erp/crm-deals/{id}/subscription/deactivate": { "put": { "tags": [ "Deals" ], "summary": "Entfernt eine Subscription auf dem Gesch\u00e4ftsobjekt f\u00fcr den Aufrufer", "operationId": "deregisterSubscription", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/crm-deals/{id}/subscription/activate": { "put": { "tags": [ "Deals" ], "summary": "Setzt eine Subscription auf dem Gesch\u00e4ftsobjekt f\u00fcr den Aufrufer", "operationId": "registerSubscription", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/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" } } } } } }, "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" } } } } } }, "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" } } } } } } }, "/erp/crm-deals/{id}": { "get": { "tags": [ "Deals" ], "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-crm-CrmDeal" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Deals" ], "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-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" } } } } } }, "delete": { "tags": [ "Deals" ], "summary": "Delete an existing Resource", "operationId": "delete_85", "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" } } } } } }, "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" } } } } } } }, "/erp/crm-deals/parent/{childId}": { "get": { "tags": [ "Deals" ], "operationId": "getParent_2", "parameters": [ { "name": "childId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } } } } } }, "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" } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "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" } } } } } } }, "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" } } } } } } }, "/erp/accounts/{id}/subscription/deactivate": { "put": { "tags": [ "account" ], "summary": "Entfernt eine Subscription auf dem Gesch\u00e4ftsobjekt f\u00fcr den Aufrufer", "operationId": "deregisterSubscription_1", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/{id}/subscription/activate": { "put": { "tags": [ "account" ], "summary": "Setzt eine Subscription auf dem Gesch\u00e4ftsobjekt f\u00fcr den Aufrufer", "operationId": "registerSubscription_1", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/{id}/relations/{relationId}": { "get": { "tags": [ "account" ], "operationId": "getRelation", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "relationId", "in": "path", "description": "identifier of relation", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountRelation" } } } } } }, "put": { "tags": [ "account" ], "operationId": "updateRelation", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "relationId", "in": "path", "description": "identifier of relation", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountRelation" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountRelation" } } } } } }, "delete": { "tags": [ "account" ], "operationId": "deleteRelation", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "relationId", "in": "path", "description": "identifier of relation", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/{id}/persons/{personId}/deactivate": { "put": { "tags": [ "account" ], "operationId": "deactivateAccountPerson", "parameters": [ { "name": "id", "in": "path", "description": "account identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "personId", "in": "path", "description": "person identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } } } } } }, "/erp/accounts/{id}/persons/{personId}/activate": { "put": { "tags": [ "account" ], "operationId": "activateAccountPerson", "parameters": [ { "name": "id", "in": "path", "description": "account identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "personId", "in": "path", "description": "person identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } } } } } }, "/erp/accounts/{id}/persons/{personId}": { "get": { "tags": [ "account" ], "operationId": "getSingleAccountPerson", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "personId", "in": "path", "description": "identifier of person", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } } } } }, "put": { "tags": [ "account" ], "operationId": "putAccountPerson", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "personId", "in": "path", "description": "person identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } } } } }, "delete": { "tags": [ "account" ], "operationId": "deleteAccountPerson", "parameters": [ { "name": "id", "in": "path", "description": "account identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "personId", "in": "path", "description": "person identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/{id}/leasable-lock/{lockToken}": { "put": { "tags": [ "account" ], "summary": "Verl\u00e4ngert eine Sperre", "operationId": "refreshLeasableLock_2", "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\u00e4ngernden 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": { "application/json": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } }, "delete": { "tags": [ "account" ], "summary": "Gibt ein Sperre frei", "operationId": "releaseLeasableLock_2", "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" } } } }, "/erp/accounts/{id}/deactivate-and-anonymize": { "put": { "tags": [ "account" ], "operationId": "deactivateAndAnonymizeAccount", "parameters": [ { "name": "id", "in": "path", "description": "account identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/{id}/deactivate": { "put": { "tags": [ "account" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_50", "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-account-Account" } } } }, "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" } } } } } } }, "/erp/accounts/{id}/bankdetails/{bankdetailId}/sepamandates/{sepamandateId}": { "get": { "tags": [ "account" ], "operationId": "getSEPAMandateDetail", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankdetailId", "in": "path", "description": "identifier of bankdetail", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "sepamandateId", "in": "path", "description": "identifier of sepamandate", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SEPAMandate" } } } } } }, "put": { "tags": [ "account" ], "operationId": "updateSEPAMandate", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankdetailId", "in": "path", "description": "identifier of bankdetail", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "sepamandateId", "in": "path", "description": "identifier of sepamandate", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SEPAMandate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SEPAMandate" } } } } } }, "delete": { "tags": [ "account" ], "operationId": "deleteSEPAMandate", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankdetailId", "in": "path", "description": "identifier of bankdetail", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "sepamandateId", "in": "path", "description": "identifier of sepamandate", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/{id}/bankdetails/{bankdetailId}": { "get": { "tags": [ "account" ], "operationId": "getBankdetail", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankdetailId", "in": "path", "description": "identifier of bankdetail", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountBankdetail" } } } } } }, "put": { "tags": [ "account" ], "operationId": "updateBankdetail", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankdetailId", "in": "path", "description": "identifier of bankdetail", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountBankdetail" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountBankdetail" } } } } } }, "delete": { "tags": [ "account" ], "operationId": "deleteBankdetail", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankdetailId", "in": "path", "description": "identifier of bankdetail", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/{id}/addresses/{addressId}": { "get": { "tags": [ "account" ], "operationId": "getSingleAccountAddress", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "addressId", "in": "path", "description": "identifier of address", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountAddress" } } } } } }, "put": { "tags": [ "account" ], "operationId": "updateAccountAddress", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "addressId", "in": "path", "description": "identifier of address", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountAddress" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountAddress" } } } } } }, "delete": { "tags": [ "account" ], "operationId": "deleteAccountAddress", "parameters": [ { "name": "id", "in": "path", "description": "account identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "addressId", "in": "path", "description": "address identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/accounts/{id}/activate": { "put": { "tags": [ "account" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_50", "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-account-Account" } } } }, "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" } } } } } } }, "/erp/accounts/{id}": { "get": { "tags": [ "account" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_102", "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-account-Account" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "account" ], "summary": "Update existing Resource ", "operationId": "update_95", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-Account" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-Account" } } } }, "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" } } } } } }, "delete": { "tags": [ "account" ], "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" } } } } } }, "patch": { "tags": [ "account" ], "summary": "Partial-Data-Update an Account", "operationId": "partialUpdate_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-Account" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-Account" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/account-types/salutations/{id}/deactivate": { "put": { "tags": [ "salutation" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_51", "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-account-AccountSalutation" } } } }, "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" } } } } } } }, "/erp/account-types/salutations/{id}/activate": { "put": { "tags": [ "salutation" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_51", "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-account-AccountSalutation" } } } }, "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" } } } } } } }, "/erp/account-types/salutations/{id}": { "get": { "tags": [ "salutation" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-account-AccountSalutation" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "salutation" ], "summary": "Update existing Resource ", "operationId": "update_96", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountSalutation" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountSalutation" } } } }, "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" } } } } } }, "delete": { "tags": [ "salutation" ], "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" } } } } } } }, "/cmn/system/log-entries/{id}": { "get": { "tags": [ "Logs" ], "summary": "Find an existing Instance by identifier", "operationId": "getById_104", "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" } } } } } }, "put": { "tags": [ "Logs" ], "summary": "Update a Instance", "operationId": "update_97", "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" } } } } } } }, "/cmn/system/app-scripting-proxy/{id}": { "get": { "tags": [ "app-scripting-proxy-resource" ], "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/common-api-AppScriptingProxy" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "app-scripting-proxy-resource" ], "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/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" } } } } } }, "delete": { "tags": [ "app-scripting-proxy-resource" ], "summary": "Delete an existing Resource", "operationId": "delete_88", "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" } } } } } } }, "/cmn/system/app-message/{id}": { "get": { "tags": [ "app-message-entry-resource" ], "summary": "Find an existing Instance by identifier", "operationId": "getById_106", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-AppMessageEntryGet" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "app-message-entry-resource" ], "summary": "Update a Instance", "operationId": "update_99", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-AppMessageEntry" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-AppMessageEntryGet" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/system/app-message/{entryId}/app/{appId}/deactivate": { "put": { "tags": [ "app-message-entry-resource" ], "operationId": "deactivateEntry", "parameters": [ { "name": "entryId", "in": "path", "description": "Entry-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "appId", "in": "path", "description": "App-ID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-AppMessageEntryGet" } } } } } } }, "/cmn/system/app-message/app/{appId}/deactivate": { "put": { "tags": [ "app-message-entry-resource" ], "operationId": "deactivateEntries", "parameters": [ { "name": "appId", "in": "path", "description": "App-ID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/output/consumer/{id}/rule-value": { "put": { "tags": [ "Output-Consumer" ], "operationId": "updateRuleValue", "parameters": [ { "name": "id", "in": "path", "description": "ID des Printservers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/cmn/output/consumer/{id}/request-refresh": { "put": { "tags": [ "Output-Consumer" ], "operationId": "requestRefresh", "parameters": [ { "name": "id", "in": "path", "description": "ID des Printservers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/output/consumer/{id}/heart-beat": { "put": { "tags": [ "Output-Consumer" ], "operationId": "doHeartbeat", "parameters": [ { "name": "id", "in": "path", "description": "ID des Printservers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/output/consumer/{id}/deactivate": { "put": { "tags": [ "Output-Consumer" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_52", "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-api-OutputConsumer" } } } }, "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" } } } } } } }, "/cmn/output/consumer/{id}/activate": { "put": { "tags": [ "Output-Consumer" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_52", "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-api-OutputConsumer" } } } }, "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" } } } } } } }, "/cmn/output/consumer/{id}": { "get": { "tags": [ "Output-Consumer" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_108", "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-OutputConsumer" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Output-Consumer" ], "summary": "Update existing Resource ", "operationId": "update_100", "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-OutputConsumer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-OutputConsumer" } } } }, "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" } } } } } }, "delete": { "tags": [ "Output-Consumer" ], "summary": "Delete an existing Resource", "operationId": "delete_89", "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" } } } } } } }, "/cmn/output/consumer-rule/{id}": { "get": { "tags": [ "Output-Rule" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_109", "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" } } } } } }, "put": { "tags": [ "Output-Rule" ], "summary": "Update existing Resource ", "operationId": "update_101", "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" } } } } } }, "delete": { "tags": [ "Output-Rule" ], "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" } } } } } } }, "/cmn/masterdata/text-enums/{id}/deactivate": { "put": { "tags": [ "TextEnumeration" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_53", "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-api-TextEnum" } } } }, "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" } } } } } } }, "/cmn/masterdata/text-enums/{id}/activate": { "put": { "tags": [ "TextEnumeration" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_53", "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-api-TextEnum" } } } }, "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" } } } } } } }, "/cmn/masterdata/text-enums/{id}": { "get": { "tags": [ "TextEnumeration" ], "summary": "Find an existing Instance by identifier", "operationId": "getById_110", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-api-TextEnumGet" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "TextEnumeration" ], "summary": "Update a Instance", "operationId": "update_102", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-TextEnum" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-api-TextEnumGet" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "TextEnumeration" ], "summary": "delete an existing Instance by identifier", "operationId": "deleteById_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "Resource is not deletable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/masterdata/text-enum-groups/{id}": { "get": { "tags": [ "TextEnumeration-Groups" ], "summary": "Find an existing Instance by identifier", "operationId": "getById_111", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-api-TextEnumGroupGet" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "TextEnumeration-Groups" ], "summary": "Update a Instance", "operationId": "update_103", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-TextEnumGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-api-TextEnumGroupGet" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "TextEnumeration-Groups" ], "summary": "delete an existing Instance by identifier", "operationId": "deleteById_5", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "Resource is not deletable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/eav-groups/{id}": { "get": { "tags": [ "EavGroup" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_112", "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-eav-EavGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "EavGroup" ], "summary": "Update existing Resource ", "operationId": "update_104", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-eav-EavGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-eav-EavGroup" } } } }, "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" } } } } } }, "delete": { "tags": [ "EavGroup" ], "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" } } } } } } }, "/cmn/workflows/{id}": { "get": { "tags": [ "Workflow" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_113", "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-workflow-Workflow" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Workflow" ], "summary": "Update existing Resource ", "operationId": "update_105", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } }, "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" } } } } } }, "delete": { "tags": [ "Workflow" ], "summary": "Delete an existing Resource", "operationId": "delete_92", "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" } } } } } } }, "/cmn/workflows/{id}/workflow-elements/{element-id}": { "get": { "tags": [ "Workflow" ], "operationId": "getElementById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "element-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-WorkflowElement" } } } } } }, "put": { "tags": [ "Workflow" ], "operationId": "updateElement", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "element-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-WorkflowElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-WorkflowElement" } } } } } }, "delete": { "tags": [ "Workflow" ], "operationId": "removeElement", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "element-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/workflows/{id}/setSavePointBeginEditing": { "put": { "tags": [ "Workflow" ], "operationId": "setSavePointBeginEditing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } }, "404": { "description": "workflow not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/workflows/{id}/restoreSavePointAfterCancelEditing": { "put": { "tags": [ "Workflow" ], "operationId": "restoreSavePointBeginEditing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } }, "404": { "description": "workflow not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/workflows/{id}/restoreNextSavePoint": { "put": { "tags": [ "Workflow" ], "operationId": "restoreNextSavePoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } }, "404": { "description": "workflow not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/workflows/{id}/restoreLastSavePoint": { "put": { "tags": [ "Workflow" ], "operationId": "restoreLastSavePoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } }, "404": { "description": "workflow not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/workflows/{id}/deactivate": { "put": { "tags": [ "Workflow" ], "operationId": "deactivate_54", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } }, "404": { "description": "workflow not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/workflows/{id}/changeNameAndDescription": { "put": { "tags": [ "Workflow" ], "operationId": "changeWorkflowNameAndDescription", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-WorkflowChangeNameAndDescriptionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } } } } }, "/cmn/workflows/{id}/activate": { "put": { "tags": [ "Workflow" ], "operationId": "activate_54", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } }, "404": { "description": "workflow not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } }, "/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" } } } }, "/cmn/work-items/{id}/unassign": { "put": { "tags": [ "WorkItem" ], "operationId": "unassignMe", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "404": { "description": "work item not found" }, "422": { "description": "work item not assigned to current user" }, "200": { "description": "successful operation" } } } }, "/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": { "type": "object" } } } }, "required": true }, "responses": { "404": { "description": "work item not found" }, "200": { "description": "successful operation" }, "422": { "description": "work item assigned to other user" } } } }, "/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": { "404": { "description": "work item not found" }, "422": { "description": "work item already assigned" }, "200": { "description": "successful operation" } } } }, "/cmn/users/{id}/signature/{signatureId}": { "get": { "tags": [ "User" ], "operationId": "getSignature", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "signatureId", "in": "path", "description": "Signature id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-output-OutputSignature" } } } } } }, "put": { "tags": [ "User" ], "operationId": "updateSignature", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "signatureId", "in": "path", "description": "Signature id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputSignature" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-output-OutputSignature" } } } } } }, "delete": { "tags": [ "User" ], "operationId": "deleteSignature", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "signatureId", "in": "path", "description": "Signature id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/users/{id}/messages/last_read": { "put": { "tags": [ "User Message" ], "summary": "mark messages as seen", "operationId": "putLastRead", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lastRead", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/users/{id}/favorites/subscription/{subscriptionId}": { "get": { "tags": [ "User" ], "operationId": "getSubscriptionFavorite", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "subscriptionId", "in": "path", "description": "Output Favorite id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } } } } }, "put": { "tags": [ "User" ], "operationId": "updateSubscriptionFavorite", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "subscriptionId", "in": "path", "description": "Output Favorite id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } } } } }, "delete": { "tags": [ "User" ], "operationId": "deleteSubscriptionFavorite", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "subscriptionId", "in": "path", "description": "Output Favorite id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/users/{id}/favorites/outputs/{favoriteId}": { "get": { "tags": [ "User" ], "operationId": "getOutputFavorite", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "favoriteId", "in": "path", "description": "Output Favorite id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } } } } }, "put": { "tags": [ "User" ], "operationId": "updateOutputFavorite", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "favoriteId", "in": "path", "description": "Output Favorite id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } } } } }, "delete": { "tags": [ "User" ], "operationId": "deleteOutputFavorite", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "favoriteId", "in": "path", "description": "Output Favorite id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/users/{id}/deactivate": { "put": { "tags": [ "User" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_55", "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-user-User" } } } }, "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" } } } } } } }, "/cmn/users/{id}/authorization": { "get": { "tags": [ "User" ], "summary": "Provides the authorizations for a given user", "operationId": "readUserPermissionByUserId", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserPermissionRead" } } } } } }, "put": { "tags": [ "User" ], "summary": "Updates the authorizations for a given user", "operationId": "writeUserPermission", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserPermission" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserPermissionRead" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/users/{id}/activate": { "put": { "tags": [ "User" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_55", "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-user-User" } } } }, "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" } } } } } } }, "/cmn/users/roles/{id}": { "get": { "tags": [ "Role" ], "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-user-Role" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Role" ], "summary": "Update existing Resource ", "operationId": "update_106", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-Role" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-Role" } } } }, "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" } } } } } }, "delete": { "tags": [ "Role" ], "summary": "Delete an existing Resource", "operationId": "delete_93", "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" } } } } } } }, "/cmn/users/roles/{id}/deactivate": { "put": { "tags": [ "Role" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-Role" } } } }, "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" } } } } } } }, "/cmn/users/roles/{id}/activate": { "put": { "tags": [ "Role" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-Role" } } } }, "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" } } } } } } }, "/cmn/users/my/messages/last_read": { "put": { "tags": [ "User Message" ], "summary": "mark current user messages as seen", "operationId": "putMyLastRead", "parameters": [ { "name": "lastRead", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/users/me/messages/{id}": { "put": { "tags": [ "User Message" ], "summary": "update a message", "operationId": "updateMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserMessage" } } } } } }, "delete": { "tags": [ "User Message" ], "summary": "delete a message", "operationId": "deleteMyMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/users/me/favorites/subscription/{subscriptionId}": { "get": { "tags": [ "User" ], "operationId": "getMeSubscriptionFavorite", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Output Subscription id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } } } } }, "put": { "tags": [ "User" ], "operationId": "updateMeSubscriptionFavorite", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Output Subscription id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } } } } }, "delete": { "tags": [ "User" ], "operationId": "deleteMeSubscriptionFavorite", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "Output Subscription id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/users/me/favorites/outputs/{favoriteId}": { "get": { "tags": [ "User" ], "operationId": "getOutputFavoriteMe", "parameters": [ { "name": "favoriteId", "in": "path", "description": "Output Favorite id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } } } } }, "put": { "tags": [ "User" ], "operationId": "updateOutputFavoriteMe", "parameters": [ { "name": "favoriteId", "in": "path", "description": "Output Favorite id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } } } } }, "delete": { "tags": [ "User" ], "operationId": "deleteOutputFavoriteMe", "parameters": [ { "name": "favoriteId", "in": "path", "description": "Output Favorite id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/users/groups/{id}": { "get": { "tags": [ "Group" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_116", "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-user-Group" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Group" ], "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-user-Group" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-Group" } } } }, "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" } } } } } }, "delete": { "tags": [ "Group" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/cmn/users/groups/{id}/deactivate": { "put": { "tags": [ "Group" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_57", "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-user-Group" } } } }, "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" } } } } } } }, "/cmn/users/groups/{id}/activate": { "put": { "tags": [ "Group" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_57", "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-user-Group" } } } }, "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" } } } } } } }, "/cmn/unit-types/{id}": { "get": { "tags": [ "UnitType" ], "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-masterdata-UnitType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "UnitType" ], "summary": "Update existing Resource ", "operationId": "update_108", "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" } } } } } }, "delete": { "tags": [ "UnitType" ], "summary": "Delete an existing Resource", "operationId": "delete_95", "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" } } } } } } }, "/cmn/unit-type-ratio/{id}": { "get": { "tags": [ "UnitTypeRatio" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/common-masterdata-UnitTypeRatio" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "UnitTypeRatio" ], "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-masterdata-UnitTypeRatio" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-UnitTypeRatio" } } } }, "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" } } } } } }, "delete": { "tags": [ "UnitTypeRatio" ], "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" } } } } } } }, "/cmn/ui-settings/{id}": { "get": { "tags": [ "Ui-Einstellungen" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_119", "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" } } } } } }, "put": { "tags": [ "Ui-Einstellungen" ], "summary": "Update existing Resource ", "operationId": "update_110", "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" } } } } } }, "delete": { "tags": [ "Ui-Einstellungen" ], "summary": "Delete an existing Resource", "operationId": "delete_97", "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" } } } } } } }, "/cmn/text/translations/{id}": { "get": { "tags": [ "Text" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_120", "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-cunit-Translation" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Text" ], "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-cunit-Translation" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-Translation" } } } }, "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" } } } } } }, "delete": { "tags": [ "Text" ], "summary": "Delete an existing Resource", "operationId": "delete_98", "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" } } } } } } }, "/cmn/text/baseHolder/{id}": { "get": { "tags": [ "query-base-holder-preset-resource" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryBaseHolderPreset" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "query-base-holder-preset-resource" ], "summary": "Update existing Resource ", "operationId": "update_112", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryBaseHolderPreset" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryBaseHolderPreset" } } } }, "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" } } } } } } }, "/cmn/task/{id}": { "get": { "tags": [ "Task" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_122", "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-task-Task" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Task" ], "summary": "Update existing Resource ", "operationId": "update_113", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-task-Task" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-task-Task" } } } }, "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" } } } } } }, "delete": { "tags": [ "Task" ], "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" } } } } } } }, "/cmn/tags/{id}": { "get": { "tags": [ "Tags" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_123", "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-tag-TagDto" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Tags" ], "summary": "Update existing Resource ", "operationId": "update_114", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-tag-TagDto" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-tag-TagDto" } } } }, "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" } } } } } }, "delete": { "tags": [ "Tags" ], "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" } } } } } } }, "/cmn/sequencer/{id}": { "get": { "tags": [ "Sequencer" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_124", "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-sequencer-SequencerConfiguration" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Sequencer" ], "summary": "Update existing Resource ", "operationId": "update_115", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-sequencer-SequencerConfiguration" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-sequencer-SequencerConfiguration" } } } }, "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" } } } } } }, "delete": { "tags": [ "Sequencer" ], "summary": "Delete an existing Resource", "operationId": "delete_101", "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" } } } } } } }, "/cmn/sequencer/free/{id}": { "get": { "tags": [ "FreeSequencer" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_125", "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-sequencer-FreeSequence" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "FreeSequencer" ], "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-sequencer-FreeSequence" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-sequencer-FreeSequence" } } } }, "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" } } } } } }, "delete": { "tags": [ "FreeSequencer" ], "summary": "Delete an existing Resource", "operationId": "delete_102", "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" } } } } } } }, "/cmn/sequencer/free/{id}/deactivate": { "put": { "tags": [ "FreeSequencer" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_58", "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-sequencer-FreeSequence" } } } }, "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" } } } } } } }, "/cmn/sequencer/free/{id}/activate": { "put": { "tags": [ "FreeSequencer" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_58", "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-sequencer-FreeSequence" } } } }, "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" } } } } } } }, "/cmn/scripting/modules/{id}": { "get": { "tags": [ "Skript-Modul" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_126", "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" } } } } } }, "put": { "tags": [ "Skript-Modul" ], "summary": "Update existing Resource ", "operationId": "update_117", "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" } } } } } }, "delete": { "tags": [ "Skript-Modul" ], "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" } } } } } } }, "/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" } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/cmn/scripting/module-groups/{id}": { "get": { "tags": [ "Skript-Modul-Gruppe" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/common-scripting-ScriptModuleGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Skript-Modul-Gruppe" ], "summary": "Update existing Resource ", "operationId": "update_118", "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-ScriptModuleGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-scripting-ScriptModuleGroup" } } } }, "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" } } } } } }, "delete": { "tags": [ "Skript-Modul-Gruppe" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/cmn/parameters/{key}": { "get": { "tags": [ "Parameter" ], "operationId": "read", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "put": { "tags": [ "Parameter" ], "operationId": "update_119", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "delete": { "tags": [ "Parameter" ], "operationId": "delete_105", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/cmn/output/reports/{id}": { "get": { "tags": [ "Output-Module" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_128", "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-output-OutputReport" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Output-Module" ], "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-output-OutputReport" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReport" } } } }, "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" } } } } } }, "delete": { "tags": [ "Output-Module" ], "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": { "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" } } } } } } }, "/cmn/output/reports/{id}/template-configuration": { "get": { "tags": [ "Output-Module" ], "operationId": "getTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "report identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Output-Module" ], "operationId": "putTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "report identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/cmn/output/reports/{id}/parameter": { "get": { "tags": [ "Output-Module" ], "operationId": "getParameter", "parameters": [ { "name": "id", "in": "path", "description": "report identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "Output-Module" ], "operationId": "putParameter", "parameters": [ { "name": "id", "in": "path", "description": "report identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/cmn/output/reports/{id}/deactivate": { "put": { "tags": [ "Output-Module" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_59", "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-output-OutputReport" } } } }, "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" } } } } } } }, "/cmn/output/reports/{id}/activate": { "put": { "tags": [ "Output-Module" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_59", "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-output-OutputReport" } } } }, "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" } } } } } } }, "/cmn/output/modules/{moduleKey}/texts/{id}": { "put": { "tags": [ "Output-Module" ], "summary": "Update Localisation", "operationId": "update_121", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportLocalizedText" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportLocalizedText" } } } } } }, "delete": { "tags": [ "Output-Module" ], "summary": "Deletes translation by id", "operationId": "deleteTranslation", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/output/modules/{moduleKey}/report-groups/{id}": { "get": { "tags": [ "Output-Module" ], "description": "liest eine Gruppe", "operationId": "getReportGroup", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportGroup" } } } } } }, "put": { "tags": [ "Output-Module" ], "description": "aktualisiert eine Gruppe", "operationId": "updateReportGroup", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportGroup" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportGroup" } } } } } }, "delete": { "tags": [ "Output-Module" ], "description": "l\u00f6scht diese Gruppe", "operationId": "deleteReportGroup", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportGroup" } } } } } } }, "/cmn/output/modules/{moduleKey}/report-groups/{id}/default-group": { "put": { "tags": [ "Output-Module" ], "description": "diese Gruppe wird f\u00fcr das Modul die Standardgruppe (falls kein Identifier angegeben wird)", "operationId": "setReportGroupDefault", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportGroup" } } } } } } }, "/cmn/leasable-locks/{token}": { "put": { "tags": [ "LeasableLock" ], "summary": "Verl\u00e4ngert eine Sperre", "operationId": "refreshLeasableLock_3", "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" } } } } } }, "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" } } } } } } }, "/cmn/language-codes/{id}": { "get": { "tags": [ "LanguageCode" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_130", "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-LanguageCode" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "LanguageCode" ], "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-masterdata-LanguageCode" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-LanguageCode" } } } }, "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" } } } } } } }, "/cmn/language-codes/{id}/deactivate": { "put": { "tags": [ "LanguageCode" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_60", "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-LanguageCode" } } } }, "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" } } } } } } }, "/cmn/language-codes/{id}/activate": { "put": { "tags": [ "LanguageCode" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_60", "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-LanguageCode" } } } }, "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" } } } } } } }, "/cmn/emails/{id}": { "get": { "tags": [ "email-list-resource" ], "operationId": "getEmailList", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-email-EmailList" } } } } } }, "put": { "tags": [ "email-list-resource" ], "operationId": "updateEmailListState", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "TO_DELIVER", "DELIVERED", "DELIVER_FAILED", "RECEIVED" ] } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "email-list-resource" ], "operationId": "deleteEmailList", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/data-import/scheduled-import/{id}": { "get": { "tags": [ "eingeplante Importe" ], "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": { "*/*": { "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" } } } } } }, "put": { "tags": [ "eingeplante Importe" ], "summary": "Update existing Resource ", "operationId": "update_123", "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" } } } } } }, "delete": { "tags": [ "eingeplante Importe" ], "summary": "Delete an existing Resource", "operationId": "delete_107", "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" } } } } } } }, "/cmn/data-import/runs/single/{id}": { "get": { "tags": [ "ImportRun" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_132", "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-DataImportRun" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "ImportRun" ], "summary": "Update existing Resource ", "operationId": "update_124", "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-DataImportRun" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-DataImportRun" } } } }, "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" } } } } } } }, "/cmn/data-import/runs/single/{id}/run": { "put": { "tags": [ "ImportRun" ], "operationId": "startImportRun", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "presettingImport", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "onlySingleImport", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/data-import/runs/single/{id}/load-data": { "put": { "tags": [ "ImportRun" ], "operationId": "loadData", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/data-import/runs/single/{id}/entries/{entryId}": { "put": { "tags": [ "ImportRun" ], "operationId": "updateEntry", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-data_import-DataImportEntry" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-DataImportEntry" } } } } } } }, "/cmn/data-import/runs/single/{id}/entries/{entryId}/state": { "put": { "tags": [ "ImportRun" ], "operationId": "updateEntryState", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "NOT_YET_RUN", "MANUALLY_IGNORED", "MANUALLY_COMPLETED" ] } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/data-import/runs/multi-part/{id}": { "get": { "tags": [ "MultiPartImport" ], "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-data_import-MultiPartImportRun" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "MultiPartImport" ], "operationId": "updateFromRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-data_import-UpdateMultiPartImportRunRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-MultiPartImportRun" } } } } } }, "delete": { "tags": [ "MultiPartImport" ], "summary": "Delete an existing Resource", "operationId": "delete_108", "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" } } } } } } }, "/cmn/data-import/runs/multi-part/{id}/run": { "put": { "tags": [ "MultiPartImport" ], "operationId": "startImportRun_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/data-import/rule-sets/{id}": { "get": { "tags": [ "ImportRuleSet" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_134", "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-ImportMappingRuleSet" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "ImportRuleSet" ], "summary": "Update existing Resource ", "operationId": "update_125", "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-ImportMappingRuleSet" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" } } } }, "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" } } } } } }, "delete": { "tags": [ "ImportRuleSet" ], "summary": "Delete an existing Resource", "operationId": "delete_109", "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" } } } } } } }, "/cmn/currency-codes/{id}": { "get": { "tags": [ "CurrencyCode" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/common-masterdata-CurrencyCode" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CurrencyCode" ], "summary": "Update existing Resource ", "operationId": "update_126", "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" } } } } } }, "delete": { "tags": [ "CurrencyCode" ], "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": { "*/*": { "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" } } } } } } }, "/cmn/currency-codes/{id}/deactivate": { "put": { "tags": [ "CurrencyCode" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_61", "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" } } } } } } }, "/cmn/currency-codes/{id}/activate": { "put": { "tags": [ "CurrencyCode" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_61", "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" } } } } } } }, "/cmn/currency-codes/rates/{id}": { "get": { "tags": [ "CurrencyExchangeRate" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_136", "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" } } } } } }, "put": { "tags": [ "CurrencyExchangeRate" ], "summary": "Update existing Resource ", "operationId": "update_127", "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" } } } } } }, "delete": { "tags": [ "CurrencyExchangeRate" ], "summary": "Delete an existing Resource", "operationId": "delete_111", "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" } } } } } } }, "/cmn/create-templates/{id}": { "get": { "tags": [ "CreateTemplates" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/common-create_template-CreateTemplate" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CreateTemplates" ], "summary": "Update existing Resource ", "operationId": "update_128", "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" } } } } } }, "delete": { "tags": [ "CreateTemplates" ], "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" } } } } } } }, "/cmn/create-templates/groups/{id}": { "get": { "tags": [ "CreateTemplateGroups" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_138", "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-CreateTemplateGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CreateTemplateGroups" ], "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-create_template-CreateTemplateGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-create_template-CreateTemplateGroup" } } } }, "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" } } } } } }, "delete": { "tags": [ "CreateTemplateGroups" ], "summary": "Delete an existing Resource", "operationId": "delete_113", "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" } } } } } } }, "/cmn/country-region/{id}": { "get": { "tags": [ "CountryRegion" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_139", "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" } } } } } }, "put": { "tags": [ "CountryRegion" ], "summary": "Update existing Resource ", "operationId": "update_130", "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" } } } } } }, "delete": { "tags": [ "CountryRegion" ], "summary": "Delete an existing Resource", "operationId": "delete_114", "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" } } } } } } }, "/cmn/country-region/{id}/deactivate": { "put": { "tags": [ "CountryRegion" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_62", "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" } } } } } } }, "/cmn/country-region/{id}/activate": { "put": { "tags": [ "CountryRegion" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_62", "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" } } } } } } }, "/cmn/country-codes/{id}": { "get": { "tags": [ "CountryCode" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CountryCode" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CountryCode" ], "summary": "Update existing Resource ", "operationId": "update_131", "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-CountryCode" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CountryCode" } } } }, "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" } } } } } } }, "/cmn/country-codes/{id}/deactivate": { "put": { "tags": [ "CountryCode" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_63", "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-CountryCode" } } } }, "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" } } } } } } }, "/cmn/country-codes/{id}/activate": { "put": { "tags": [ "CountryCode" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_63", "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-CountryCode" } } } }, "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" } } } } } } }, "/cmn/computed-queries/{group-key}/{id}/presets/{presetId}": { "get": { "tags": [ "computed-queries" ], "operationId": "getQueryPreset", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "presetId", "in": "path", "description": "Preset-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "forAdmin", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "forWorkflow", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPreset" } } } } } }, "put": { "tags": [ "computed-queries" ], "operationId": "updateQueryPreset", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "presetId", "in": "path", "description": "Filter-Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPreset" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPreset" } } } } } }, "delete": { "tags": [ "computed-queries" ], "operationId": "deleteQueryPreset", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "presetId", "in": "path", "description": "Filter-Id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/computed-queries/{group-key}/{id}/presets/{presetId}/user-options/{userOptionsId}": { "put": { "tags": [ "query-preset-user-options-resource" ], "operationId": "updateQueryPresetUserOption", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "presetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "userOptionsId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPresetUserOptions" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPresetUserOptions" } } } } } } }, "/banking/banking-user/{userId}": { "put": { "tags": [ "BankingUser" ], "operationId": "updateUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingUser" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingUser" } } } } } } }, "/banking/banking-user/{userId}/check_user_state": { "put": { "tags": [ "BankingUser" ], "operationId": "checkUserState", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/banking/banking-provider/{id}": { "get": { "tags": [ "BankingProvider" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_142", "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/banking-api-BankingProvider" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "BankingProvider" ], "summary": "Update existing Resource ", "operationId": "update_132", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingProvider" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingProvider" } } } }, "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" } } } } } }, "delete": { "tags": [ "BankingProvider" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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" } } } } } } }, "/banking/banking-provider/{bankingProviderId}/parameter/{key}": { "get": { "tags": [ "BankingProvider" ], "operationId": "getParameter_1", "parameters": [ { "name": "bankingProviderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "FINAPI", "FINAPI_SANDBOX", "MOCKBANK" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } }, "put": { "tags": [ "BankingProvider" ], "operationId": "updateParameter_1", "parameters": [ { "name": "bankingProviderId", "in": "path", "description": "bankingProviderId", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "FINAPI", "FINAPI_SANDBOX", "MOCKBANK" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-connector-BankingParameter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/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" } } } } } } }, "/wms/replenishment-proposal/template": { "post": { "tags": [ "Nachschub" ], "summary": "Create new Resource", "operationId": "create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalTemplate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalTemplate" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/wms/replenishment-proposal/create": { "post": { "tags": [ "Nachschub" ], "operationId": "createProposalIndirect", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalTemplate" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/wms/replenishment-proposal/create/{templateId}": { "post": { "tags": [ "Nachschub" ], "operationId": "createPicklistsIndirect", "parameters": [ { "name": "templateId", "in": "path", "description": "ID der zu verwendenden Picklisten-Vorlage", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/wms/picktrolleys": { "post": { "tags": [ "Pickwagen" ], "summary": "Create new Resource", "operationId": "create_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolley" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolley" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/wms/picktrolleys/{id}/generate-boxes": { "post": { "tags": [ "Pickwagen" ], "operationId": "generateBoxes", "parameters": [ { "name": "id", "in": "path", "description": "ID des Pickwagen", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBoxGenerateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBox" } } } } } } } }, "/wms/picktrolleys/{id}/boxes": { "post": { "tags": [ "Pickwagen" ], "operationId": "createPickTrolleyBox", "parameters": [ { "name": "id", "in": "path", "description": "ID des Pickwagen", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBox" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBox" } } } } } } }, "/wms/picktrolleys/groups": { "post": { "tags": [ "Pickwagengruppen" ], "summary": "Create new Resource", "operationId": "create_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/wms/picklists/{picklistId}/add-parcel-to-shipment/{shipmentId}": { "post": { "tags": [ "Picklisten" ], "operationId": "addParcelToShipment", "parameters": [ { "name": "picklistId", "in": "path", "description": "ID einer Pickliste, zu der ein Paket angelegt werden soll", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "shipmentId", "in": "path", "description": "ID eines Shipments, welches zu einem Beleg in einer Pickliste geh\u00f6rt", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistParcel" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-spi-VdsParcel" } } } } } } }, "/wms/picklists/reorg": { "post": { "tags": [ "Picklisten" ], "operationId": "reorgPicklistsAndTrolleys", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/wms/picklists/process-input": { "post": { "tags": [ "Picklisten" ], "operationId": "processInput_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistProcessingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistProcessingResponse" } } } } } } }, "/wms/picklists/create": { "post": { "tags": [ "Picklisten" ], "operationId": "createPicklistsIndirect_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/wms/picklists/create/{picklistTemplateId}": { "post": { "tags": [ "Picklisten" ], "operationId": "createPicklistsIndirect_2", "parameters": [ { "name": "picklistTemplateId", "in": "path", "description": "ID der zu verwendenden Picklisten-Vorlage", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/wms/picklists/create-for-pick-trolley/{picklistTemplateId}": { "post": { "tags": [ "Picklisten" ], "operationId": "createPicklistsForPickTrolley", "parameters": [ { "name": "picklistTemplateId", "in": "path", "description": "ID der zu verwendenden Picklisten-Vorlage", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "forPickTrolleyId", "in": "query", "description": "ID des Pickwagens, f\u00fcr den die Pickliste erzeugt werden soll", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistCreationResult" } } } } } } }, "/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" } } } } } } }, "/wms/inventories": { "post": { "tags": [ "Inventory" ], "summary": "Create new Resource", "operationId": "create_4", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-Inventory" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-Inventory" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/wms/inventories/{id}/removeStorageBins": { "post": { "tags": [ "Inventory" ], "operationId": "removeStorageBinsToInventory", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "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-wms-Inventory" } } } } } } }, "/wms/inventories/{id}/redo-countings": { "post": { "tags": [ "Inventory" ], "operationId": "redoCountings", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "allPositions", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-wms-InventoryCounting" } } } } } } } }, "/wms/inventories/{id}/generate-countings": { "post": { "tags": [ "Inventory" ], "operationId": "generateCountings", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "onlyArticlesWithStock", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "articlesThatWereOnceInStock", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "inactiveArticles", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-wms-InventoryCounting" } } } } } } } }, "/wms/inventories/{id}/countings": { "get": { "tags": [ "Inventory" ], "operationId": "getInventoryCountings", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "revision", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-wms-InventoryCounting" } } } } } } }, "post": { "tags": [ "Inventory" ], "operationId": "createInventoryCounting", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-InventoryCounting" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-InventoryCounting" } } } } } } }, "/wms/inventories/{id}/addStorageBins": { "post": { "tags": [ "Inventory" ], "operationId": "addStorageBinsToInventory", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "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-wms-Inventory" } } } } } } }, "/wms/inventories/process-input": { "post": { "tags": [ "Inventory" ], "operationId": "processInput_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-InventoryProcessingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-InventoryProcessingResponse" } } } } } } }, "/websocket/token": { "post": { "tags": [ "multi-tenant-websocket-token-resource" ], "operationId": "getToken", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/node-event-WebsocketToken" } } } } } } }, "/vds/shipment": { "post": { "tags": [ "Shipment" ], "summary": "Create new Resource", "operationId": "create_5", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-shipment-Shipment" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-shipment-Shipment" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/user-details": { "post": { "tags": [ "UserDescription" ], "summary": "Create new Resource", "operationId": "create_6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-user-ErpUserDetail" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-user-ErpUserDetail" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/text-templates": { "post": { "tags": [ "TextTemplate" ], "summary": "Create new Resource", "operationId": "create_7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-texttemplates-TextTemplate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-texttemplates-TextTemplate" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/taxes/tax-schemas": { "post": { "tags": [ "TaxSchemas" ], "summary": "Create new Resource", "operationId": "create_8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxSchema" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxSchema" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/taxes/tax-rates": { "post": { "tags": [ "TaxRates" ], "summary": "Create new Resource", "operationId": "create_9", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxRate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxRate" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/taxes/tax-ewu-delivery-limits": { "post": { "tags": [ "TaxEwuDeliveryLimits" ], "summary": "Create new Resource", "operationId": "create_10", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxEwuDeliveryLimit" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxEwuDeliveryLimit" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/storages": { "post": { "tags": [ "Storage" ], "summary": "Create new Resource", "operationId": "create_11", "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" } } } } } } }, "/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" } } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } } }, "/erp/storage-areas": { "post": { "tags": [ "StorageArea" ], "summary": "Create new Resource", "operationId": "create_12", "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" } } } } } } }, "/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" } } } } } } }, "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" } } } } } }, "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" } } } } } } }, "/erp/stocks/transfer": { "post": { "tags": [ "Stocks" ], "operationId": "transferStocks", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-StockTransferApi" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-StockTransferResult" } } } } } } }, "/erp/stocks/manual-movement": { "post": { "tags": [ "Stocks" ], "operationId": "bookManualStockMovement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-StockMovementManualApi" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-Stock" } } } } } } }, "/erp/stocks/bulk-transfer": { "post": { "tags": [ "Stocks" ], "operationId": "bulkTransferStocks", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-BulkTransferRequestApi" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-BulkTransferResult" } } } } } } }, "/erp/statistics/time-series/{id}": { "post": { "tags": [ "dataseries" ], "operationId": "processTimeSeries", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-statistic-DataSeriesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-statistic-DataSeries" } } } } } } } }, "/erp/statistics/datamarts/update-sales-fact": { "post": { "tags": [ "datamarts" ], "operationId": "rebuildSalesFact", "parameters": [ { "name": "with_delete", "in": "query", "description": "die Verkauf-Fakt-Changes werden komplett neu aufgebaut", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "full_update", "in": "query", "description": "sollen alle Fakten danach neu durchgerechnet werden", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/statistics/datamarts/update-dimensions": { "post": { "tags": [ "datamarts" ], "operationId": "rebuild", "parameters": [ { "name": "fullUpdate", "in": "query", "description": "alle Dimensionen werden komplett synchronisiert, nicht nur die \u00c4nderungen", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/sales-channels/storage-schema": { "post": { "tags": [ "Verkaufskanal-Lagerzuordnung" ], "summary": "Create new Resource", "operationId": "create_13", "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" } } } } } } }, "/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" } } } } } } }, "/erp/products/sales-prices": { "post": { "tags": [ "ProductPrices" ], "operationId": "postProductSalesPrice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } } } } } }, "/erp/products/sales-discounts": { "post": { "tags": [ "ProductPrices" ], "operationId": "postProductSalesDiscount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } } } } } }, "/erp/products/purchase-prices": { "post": { "tags": [ "ProductPrices" ], "operationId": "postProductPurchasePrice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } } } } } }, "/erp/products/purchase-discounts": { "post": { "tags": [ "ProductPrices" ], "operationId": "postProductPurchaseDiscount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } } } } } }, "/erp/products/manufacturers": { "post": { "tags": [ "Product-Manufacturers" ], "summary": "Create new Resource", "operationId": "create_14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-Manufacturer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Manufacturer" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-variants": { "post": { "tags": [ "Product-Variant" ], "summary": "Create new Resource", "operationId": "create_15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariant" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariant" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-variants/productVariantCreationJob": { "post": { "tags": [ "Product-Variant" ], "summary": "Create a Job according to the Request", "operationId": "createProductVariantCreationRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantCreationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/product-variant-attributes": { "post": { "tags": [ "Product-Variant-Attribute" ], "summary": "Create new Resource", "operationId": "create_16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttribute" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttribute" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-variant-attributes/{attributeId}/values": { "get": { "tags": [ "Product-Variant-Values" ], "summary": "find all values to attribute", "operationId": "findAll", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } } } } } } }, "post": { "tags": [ "Product-Variant-Values" ], "operationId": "add", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } } } } } } }, "/erp/product-variant-attributes/{attributeId}/values/add-all": { "post": { "tags": [ "Product-Variant-Values" ], "operationId": "addAll", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } } } } } } } }, "/erp/product-variant-attributes/{attributeId}/value/{valueId}/listings": { "post": { "tags": [ "Product-Variant-Values" ], "summary": "Create new listing", "operationId": "createListing", "parameters": [ { "name": "attributeId", "in": "path", "description": "Attribute-ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "valueId", "in": "path", "description": "Value-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValueListing" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValueListing" } } } } } } }, "/erp/product-variant-attributes/{attributeId}/listings": { "post": { "tags": [ "Product-Variant-Attribute" ], "summary": "Create new listing", "operationId": "createListing_1", "parameters": [ { "name": "attributeId", "in": "path", "description": "Attribute-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeListing" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeListing" } } } } } } }, "/erp/product-types/product-price-groups": { "post": { "tags": [ "ProductPriceGroups" ], "summary": "Create new Resource", "operationId": "create_17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPriceGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPriceGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-types/product-groups": { "post": { "tags": [ "ProductGroups" ], "summary": "Create new Resource", "operationId": "create_18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-types/main-product-groups": { "post": { "tags": [ "MainProductGroups" ], "summary": "Create new Resource", "operationId": "create_19", "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" } } } } } } }, "/erp/product-types/identifier-types": { "post": { "tags": [ "IdentifierType" ], "summary": "Create new Resource", "operationId": "create_20", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-IdentifierType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-IdentifierType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-types/discount-groups": { "post": { "tags": [ "discount group" ], "summary": "Create new Resource", "operationId": "create_21", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-DiscountGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-DiscountGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-types/discount-groups/{id}/rules": { "get": { "tags": [ "discount group" ], "operationId": "getRules", "parameters": [ { "name": "id", "in": "path", "description": "an discount group id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-DiscountGroupRule" } } } } } } }, "post": { "tags": [ "discount group" ], "operationId": "createRule", "parameters": [ { "name": "id", "in": "path", "description": "an discount group id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-DiscountGroupRule" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-DiscountGroupRule" } } } } } } }, "/erp/price-modifier-types": { "post": { "tags": [ "PriceModifierTypes" ], "summary": "Create new Resource", "operationId": "create_22", "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" } } } } } } }, "/erp/pos/register": { "post": { "tags": [ "PosRegister" ], "summary": "Create new Resource", "operationId": "create_23", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosRegister" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosRegister" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/fiscalization/backend": { "post": { "tags": [ "FiscalizationBackend" ], "summary": "Create new Resource", "operationId": "create_24", "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" } } } } } } }, "/erp/pos/depositExpenseType": { "post": { "tags": [ "PosDepositExpenseType" ], "summary": "Create new Resource", "operationId": "create_25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosDepositExpenseType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosDepositExpenseType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/cash-drawer": { "post": { "tags": [ "CashDrawer" ], "summary": "Create new Resource", "operationId": "create_26", "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" } } } } } } }, "/erp/payments": { "post": { "tags": [ "Payments" ], "operationId": "registerPayment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-Payment" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-ManualPaymentResponse" } } } } } } }, "/erp/payments/terms": { "post": { "tags": [ "PaymentTerms" ], "summary": "Create new Resource", "operationId": "create_27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentTerm" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentTerm" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/payments/templates": { "post": { "tags": [ "PaymentTemplates" ], "summary": "Create new Resource", "operationId": "create_28", "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" } } } } } } }, "/erp/payments/revert": { "post": { "tags": [ "Payments" ], "operationId": "revertPayment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-PaymentRevertRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/erp/payments/methods": { "post": { "tags": [ "PaymentMethods" ], "summary": "Create new Resource", "operationId": "create_29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentMethod" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentMethod" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/order-proposals": { "post": { "tags": [ "OrderProposals" ], "summary": "Create new Resource", "operationId": "create_30", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposal" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposal" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/order-proposals/{id}/suppliers/{supplier-id}/setProposalLinesToBeOrdered": { "post": { "tags": [ "OrderProposals" ], "operationId": "setProposalLinesToBeOrdered", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "supplier-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/order-proposals/{id}/suppliers/{supplier-id}/setProposalLinesToBeNotOrdered": { "post": { "tags": [ "OrderProposals" ], "operationId": "setProposalLinesToBeNotOrdered", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "supplier-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/order-proposals/{id}/perform-create-orders": { "post": { "tags": [ "OrderProposals" ], "operationId": "performCreateOrders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/order-proposals/{id}/order-proposals": { "post": { "tags": [ "OrderProposals" ], "operationId": "addOrderProposalLine", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposalLine" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposal" } } } } } } }, "/erp/order-proposals/{id}/order-proposal-suppliers": { "post": { "tags": [ "OrderProposals" ], "operationId": "createOrderProposalSupplier", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposalSupplier" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposalSupplier" } } } } } } }, "/erp/order-proposals/generate-background": { "post": { "tags": [ "OrderProposals" ], "operationId": "generateOrderProposalsInBackground", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-OrderProposalGenerateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitemsynchronization": { "post": { "tags": [ "OpenItemSynch" ], "operationId": "synchronizeOperations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemMatchingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitemsynchronization/{transactionId}/mark_manually/{id}": { "post": { "tags": [ "OpenItemSynch" ], "operationId": "markManually", "parameters": [ { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitemsynchronization/{bankAccountId}/unmark_all": { "post": { "tags": [ "OpenItemSynch" ], "operationId": "unmarkAllForBankAccount", "parameters": [ { "name": "bankAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitemsynchronization/mark_by_points": { "post": { "tags": [ "OpenItemSynch" ], "operationId": "markByPoints", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-SyncMarkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitemsynchronization/book_with_points": { "post": { "tags": [ "OpenItemSynch" ], "operationId": "bookWithPoints", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-TransactionFinalizationPointsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitemsynchronization/book_results": { "post": { "tags": [ "OpenItemSynch" ], "operationId": "bookResults", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemTransactionFinalizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitemsynchronization/book_marked_results": { "post": { "tags": [ "OpenItemSynch" ], "operationId": "bookMarkedResults", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/finance/openitems/{id}/revert/{recordId}": { "post": { "tags": [ "OpenItem" ], "description": "storniert eine Zahlung", "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" } } } } } } }, "/erp/finance/openitems/{id}/removeAssignmentTransaction/{recordId}": { "post": { "tags": [ "OpenItem" ], "description": "entfernt eine Transaction aus einem OP", "operationId": "removeAssignmentTransaction", "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" } } } } }, "deprecated": true } }, "/erp/finance/openitems/{firstOpenItemId}/clear_with/{secondOpenItemId}": { "get": { "tags": [ "OpenItem" ], "description": "Gibt das Saldo nach Verrechnung zur\u00fcck", "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" } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/finance/openitems/payment/{bankAccountId}/create_payments": { "post": { "tags": [ "OpenItemPayment" ], "description": "bereitet die Zahlungen f\u00fcr die \u00fcbergebenen Offenen Posten vor", "operationId": "createPayments", "parameters": [ { "name": "bankAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-PaymentCreationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-PaymentCreationResponse" } } } } } } }, "/erp/finance/openitems/payment/reimburse": { "post": { "tags": [ "OpenItemPayment" ], "operationId": "createReimbursementForOpenItemOverpayment", "parameters": [ { "name": "openItemId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-PaymentCreationResponseDetail" } } } } } } }, "/erp/finance/openitems/payment/prepare_payments_async": { "post": { "tags": [ "OpenItemPayment" ], "operationId": "preparePaymentRun", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-PaymentRunRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitems/matchingrules": { "post": { "tags": [ "MatchingRules" ], "summary": "Create new Resource", "operationId": "create_31", "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" } } } } } } }, "/erp/finance/openitems/create_op_from_transaction": { "post": { "tags": [ "OpenItem" ], "description": "Erzeugt einen OP aus einer Zahlung heraus", "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" } } } } } } }, "/erp/finance/openitems/closure/{openItemId}/reopen": { "post": { "tags": [ "OpenItemClosure" ], "description": "Er\u00f6ffnet 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" } } } } } } }, "/erp/finance/openitems/closure/{openItemId}/close": { "post": { "tags": [ "OpenItemClosure" ], "description": "Schlie\u00dft 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" } } } } } } }, "/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" } } } } } } }, "/erp/finance/manual-entry/{manualEntryId}/revert_manual_booking": { "post": { "tags": [ "ManualEntry" ], "operationId": "revertManualBooking", "parameters": [ { "name": "manualEntryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/ledger": { "post": { "tags": [ "Ledger" ], "summary": "Create new Resource", "operationId": "create_32", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-Ledger" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-Ledger" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/ledger-assignment": { "post": { "tags": [ "LedgerAssignment" ], "summary": "Create new Resource", "operationId": "create_33", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-LedgerAssignment" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-LedgerAssignment" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/dunning_run": { "post": { "tags": [ "DunningRun" ], "operationId": "startDunningRun", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-DunningRunRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/dunning_run/{id}/process": { "post": { "tags": [ "DunningRun" ], "operationId": "processDunningRun", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/dunning_run/{id}/dissolveRun": { "post": { "tags": [ "DunningRun" ], "operationId": "dissolveRun", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/dunning": { "post": { "tags": [ "DunningLevel" ], "summary": "Create new Resource", "operationId": "create_34", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-DunningLevel" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-DunningLevel" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/dunning/{id}/dunning_text": { "post": { "tags": [ "DunningLevel" ], "operationId": "postDunningText", "parameters": [ { "name": "id", "in": "path", "description": "identifier of a dunning level", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-LocalizedContentTemplate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-LocalizedContentTemplate" } } } } } } }, "/erp/finance/costcenter": { "post": { "tags": [ "Cost Center" ], "summary": "Create new Resource", "operationId": "create_35", "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" } } } } } } }, "/erp/finance/business_transaction": { "post": { "tags": [ "BusinessTransaction" ], "summary": "Create new Resource", "operationId": "create_36", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-BusinessTransaction" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-BusinessTransaction" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/booked_dunning/{id}/dissolve_dunning/{openItemId}": { "post": { "tags": [ "Dunning" ], "operationId": "dissolveDunning", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "openItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "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" } } } } } } }, "/erp/documents/{id}/leasable-lock": { "get": { "tags": [ "Document" ], "summary": "Pr\u00fcft, 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" } } } } } }, "post": { "tags": [ "Document" ], "summary": "Erstellt eine neue Sperre, optional mit einer G\u00fcltigkeitsdauer", "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" } } } } } } }, "/erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId}": { "post": { "tags": [ "Document" ], "summary": "Versucht einen Auftrag in Kommissionierung zu \u00fcbernehmen 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" } } } }, "/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" } } } } } } }, "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/documents/additional-functions/{documentId}/multiple_sourcelines": { "post": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "f\u00fcgt Zeilen unterschiedlicher Herkunft in ein bestehendes Dokument", "operationId": "addSourceLinesToDocument", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentMultipleSourceLinesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } } } } }, "/erp/documents/additional-functions/collectiveInvoice": { "post": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Erzeugt eine Sammelrechnung", "operationId": "createSalesCollectiveInvoice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-SalesCollectiveInvoiceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-Document" } } } } } } }, "/erp/document-types": { "post": { "tags": [ "DocumentType" ], "summary": "Create new Resource", "operationId": "create_37", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/document-types/{id}/followUp": { "get": { "tags": [ "DocumentType" ], "operationId": "getFollowUps", "parameters": [ { "name": "id", "in": "path", "description": "identifier of document type", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" } } } } } } }, "post": { "tags": [ "DocumentType" ], "operationId": "createFollowUp", "parameters": [ { "name": "id", "in": "path", "description": "identifier of document type", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" } } } } } } }, "/erp/document-types/chains": { "post": { "tags": [ "DocumentTypeChain" ], "summary": "Create new Resource", "operationId": "create_38", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeChain" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeChain" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/delivery/terms": { "post": { "tags": [ "DeliveryTerm" ], "summary": "Create new Resource", "operationId": "create_39", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-DeliveryTerm" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-DeliveryTerm" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/delivery/shipping-costs": { "post": { "tags": [ "Versandkosten" ], "summary": "Create new Resource", "operationId": "create_40", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-ShippingCost" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-ShippingCost" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/custom-account-relation-types": { "post": { "tags": [ "CustomAccountRelationType" ], "summary": "Create new Resource", "operationId": "create_41", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-CustomAccountRelationType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-CustomAccountRelationType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } } } } }, "post": { "tags": [ "Typen von Aufgaben" ], "summary": "Create new Resource", "operationId": "create_42", "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" } } } } } } }, "/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" } } } } } } }, "post": { "tags": [ "Status zu Aufgaben" ], "summary": "Create new Resource", "operationId": "create_43", "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" } } } } } } }, "/erp/crm-tasks/priorities": { "get": { "tags": [ "Priorit\u00e4ten zu Aufgaben" ], "operationId": "getAll_2", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } } } } } }, "post": { "tags": [ "Priorit\u00e4ten zu Aufgaben" ], "summary": "Create new Resource", "operationId": "create_44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } } } } }, "post": { "tags": [ "Typen von Projekten" ], "summary": "Create new Resource", "operationId": "create_45", "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" } } } } } } }, "/erp/crm-projects/states": { "get": { "tags": [ "Status zu Projekten" ], "operationId": "getAll_4", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmState" } } } } } } }, "post": { "tags": [ "Status zu Projekten" ], "summary": "Create new Resource", "operationId": "create_46", "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" } } } } } } }, "/erp/crm-projects/priorities": { "get": { "tags": [ "Priorit\u00e4t zu Projekten" ], "operationId": "getAll_5", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } } } } } }, "post": { "tags": [ "Priorit\u00e4t zu Projekten" ], "summary": "Create new Resource", "operationId": "create_47", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-projects/phases": { "post": { "tags": [ "Projekt-Phasen" ], "summary": "Create new Resource", "operationId": "create_48", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmProjectPhase" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmProjectPhase" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-deals/visibilities": { "post": { "tags": [ "Sichtbarkeit von CRM-Deals" ], "summary": "Create new Resource", "operationId": "create_49", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealVisibility" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealVisibility" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-deals/visibilities/bulk": { "post": { "tags": [ "Sichtbarkeit von CRM-Deals" ], "operationId": "bulkCreateOrUpdateVisibilities", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealVisibilityUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmDealVisibility" } } } } } } } }, "/erp/crm-deals/types": { "get": { "tags": [ "Typen von Deals" ], "operationId": "getAll_6", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } } } } } }, "post": { "tags": [ "Typen von Deals" ], "summary": "Create new Resource", "operationId": "create_50", "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" } } } } } } }, "/erp/crm-deals/topics": { "post": { "tags": [ "Themen zu Deals" ], "summary": "Create new Resource", "operationId": "create_51", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealTopic" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealTopic" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-deals/states": { "get": { "tags": [ "Status zu Deals" ], "operationId": "getAll_7", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmState" } } } } } } }, "post": { "tags": [ "Status zu Deals" ], "summary": "Create new Resource", "operationId": "create_52", "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" } } } } } } }, "/erp/crm-deals/priorities": { "get": { "tags": [ "Priorit\u00e4ten zu Deals" ], "operationId": "getAll_8", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } } } } } }, "post": { "tags": [ "Priorit\u00e4ten zu Deals" ], "summary": "Create new Resource", "operationId": "create_53", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmPriority" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-deals/closing-reasons": { "post": { "tags": [ "Abschlu\u00dfgr\u00fcnde zu Deals" ], "summary": "Create new Resource", "operationId": "create_54", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealClosingReason" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealClosingReason" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-activities": { "post": { "tags": [ "Aktivit\u00e4ten" ], "summary": "Create new Resource", "operationId": "create_55", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivity" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivity" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-activities/types": { "post": { "tags": [ "Aktivit\u00e4tsarten" ], "summary": "Create new Resource", "operationId": "create_56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-activities/types-per-user": { "post": { "tags": [ "Aktivit\u00e4tstypen pro Benutzer" ], "summary": "Create new Resource", "operationId": "create_57", "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" } } } } } } }, "/erp/crm-activities/perform-billing": { "post": { "tags": [ "Aktivit\u00e4ten" ], "operationId": "performBilling", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityPerformBillingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/crm-activities/for-email": { "post": { "tags": [ "Aktivit\u00e4ten" ], "operationId": "createActivityByEmail", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CreateActivityByEmailRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivity" } } } } } } }, "/erp/crm-activities/billing-rules": { "post": { "tags": [ "Abrechnungsregeln zu Aktivit\u00e4ten" ], "summary": "Create new Resource", "operationId": "create_58", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityBillingRule" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityBillingRule" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/contact-types": { "post": { "tags": [ "ContactType" ], "summary": "Create new Resource", "operationId": "create_59", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-ContactType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-ContactType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/commission/run/singlerun": { "post": { "tags": [ "CommissionRun" ], "operationId": "startRun", "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" } } } } } } }, "/erp/commission/commission-assignment": { "post": { "tags": [ "CommissionAssignment" ], "summary": "Create new Resource", "operationId": "create_60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-commission-CommissionAssignment" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-commission-CommissionAssignment" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/bundle-schemata/": { "post": { "tags": [ "bundle schema" ], "summary": "Create new Resource", "operationId": "create_61", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-BundleSchema" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-BundleSchema" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/bank": { "post": { "tags": [ "Bank" ], "summary": "Create new Resource", "operationId": "create_62", "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "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" } } } } } } }, "/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" } } } } } } } }, "/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" } } } } } } }, "/erp/bank/transactions": { "post": { "tags": [ "BankTransactions" ], "summary": "Create new Resource", "operationId": "create_63", "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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/bank/transactions/reset_state": { "post": { "tags": [ "BankTransactions" ], "operationId": "resetToCleanState", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/erp/bank/transactions/mark_as_not_relevant": { "post": { "tags": [ "BankTransactions" ], "description": "markiert alle Transaktionen f\u00fcr 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" } } } } } } }, "/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" ] } }, { "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" } } } } } } } }, "/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" } } } } } } }, "/erp/bank/payments": { "post": { "tags": [ "BankPayment" ], "summary": "Create new Resource", "operationId": "create_64", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/bank/payments/{paymentId}/send": { "post": { "tags": [ "BankPayment" ], "operationId": "sendPayment", "parameters": [ { "name": "paymentId", "in": "path", "description": "ID der Zahlung", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-bank-BankPaymentAction" } } } } } } } }, "/erp/bank/payments/change_amount": { "post": { "tags": [ "BankPayment" ], "operationId": "changeAmount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPaymentChangeAmountRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } } } } } }, "/erp/bank/backend": { "post": { "tags": [ "BankingBackend" ], "summary": "Create new Resource", "operationId": "create_65", "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" } } } } } } }, "/erp/bank/accounts": { "post": { "tags": [ "BankAccount" ], "summary": "Create new Resource", "operationId": "create_66", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankAccount" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankAccount" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/bank/accounts/{accountId}/transactions/sync_newest": { "post": { "tags": [ "BankAccount" ], "operationId": "syncNewestTransactions", "parameters": [ { "name": "accountId", "in": "path", "description": "ID des Accounts", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-bank-BankTransaction" } } } } } } } }, "/erp/bank/accounts/transactions/synchronize_all": { "post": { "tags": [ "BankAccount" ], "operationId": "syncAllTransactions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-TransactionSyncRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-TransactionSyncResponse" } } } } } } }, "/erp/articles": { "post": { "tags": [ "Article" ], "summary": "Neuen Artikel (ggf. mit Produkt) erzeugen", "operationId": "create_67", "parameters": [ { "name": "languageCode", "in": "query", "description": "Gew\u00fcnschte Sprache (z.B. de)", "required": false, "style": "form", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-CreateArticleRequestApi" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Article" } } } } } } }, "/erp/articles/{id}/taxes": { "get": { "tags": [ "Article" ], "summary": "Find all existing article-taxes", "operationId": "getTaxes", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ArticleTax" } } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "post": { "tags": [ "Article" ], "summary": "Create new ProductTax", "operationId": "createTax", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleTax" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleTax" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/articles/{id}/merge-bundle": { "post": { "tags": [ "ArticleStorage" ], "operationId": "mergeBundle", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-ArticleBundleMergeDissolveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-stock-ArticleStorage" } } } } } } } }, "/erp/articles/{id}/leasable-lock": { "get": { "tags": [ "Article" ], "summary": "Pr\u00fcft, ob eine Resource gesperrt ist", "operationId": "getLeasableLock_1", "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" } } } } } }, "post": { "tags": [ "Article" ], "summary": "Erstellt eine neue Sperre, optional mit einer G\u00fcltigkeitsdauer", "operationId": "createLeasableLock_1", "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" } } } } } } }, "/erp/articles/{id}/fabrication-components": { "post": { "tags": [ "Article" ], "operationId": "createFabricationComponent", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleFabricationComponent" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleFabricationComponent" } } } } } } }, "/erp/articles/{id}/dissolve-bundle": { "post": { "tags": [ "ArticleStorage" ], "operationId": "dissolveBundle", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-ArticleBundleMergeDissolveRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-stock-ArticleStorage" } } } } } } } }, "/erp/articles/{id}/components": { "get": { "tags": [ "Article" ], "operationId": "getComponents", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleComponentCollection" } } } } } }, "post": { "tags": [ "Article" ], "operationId": "createComponent", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleComponent" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleComponent" } } } } } } }, "/erp/articles/{articleId}/storage-areas": { "get": { "tags": [ "Lagerbereiche" ], "operationId": "getArticleStorageAreas", "parameters": [ { "name": "articleId", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ArticleStorageArea" } } } } } } }, "post": { "tags": [ "Lagerbereiche" ], "operationId": "createArticleStorageArea", "parameters": [ { "name": "articleId", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleStorageArea" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleStorageArea" } } } } } } }, "/erp/articles/{articleId}/listings": { "get": { "tags": [ "Article" ], "operationId": "getAllListings", "parameters": [ { "name": "articleId", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gew\u00fcnschte Sprache (z.B. de)", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "allSalesChannels", "in": "query", "description": "sollen alle SalesChannel gelesen werden, auch die die kein listing haben", "required": false, "style": "form", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ArticleListing" } } } } } } }, "post": { "tags": [ "Article" ], "operationId": "createListing_2", "parameters": [ { "name": "articleId", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gew\u00fcnschte Sprache (z.B. de)", "required": false, "style": "form", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleListing" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleListing" } } } } } } }, "/erp/articles/serial-numbers": { "post": { "tags": [ "SerialNumber" ], "summary": "Create new Resource", "operationId": "create_68", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/articles/print-labels": { "post": { "tags": [ "Article" ], "summary": "Erstellt einen Etikettendruck-Stapel", "operationId": "createPrintOrder", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ArticlePrintLabelOrderRequest" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } } } }, "/erp/article-suppliers": { "post": { "tags": [ "ArticleSupplier" ], "summary": "Create new Resource", "operationId": "create_69", "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" } } } } } } }, "/erp/article-customers": { "post": { "tags": [ "ArticleCustomer" ], "summary": "Create new Resource", "operationId": "create_70", "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" } } } } } } }, "/erp/accounts/{id}/output-rule": { "post": { "tags": [ "account" ], "operationId": "createRule_1", "parameters": [ { "name": "id", "in": "path", "description": "account id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountOutputRule" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountOutputRule" } } } } } } }, "/erp/account-types/supplier-group": { "post": { "tags": [ "SupplierGroup" ], "summary": "Create new Resource", "operationId": "create_71", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SupplierGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SupplierGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/account-types/customer-group": { "post": { "tags": [ "CustomerGroup" ], "summary": "Create new Resource", "operationId": "create_72", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-CustomerGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-CustomerGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/dms/resources": { "post": { "tags": [ "Documents" ], "summary": "Create new Resource", "operationId": "create_73", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentPostRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocument" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/dms/resources/{id}/transformations": { "get": { "tags": [ "Image Transformations" ], "operationId": "getAllImageTransformation", "parameters": [ { "name": "id", "in": "path", "description": "image id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfImageTransformation" } } } } } } }, "post": { "tags": [ "Image Transformations" ], "summary": "Create new Image Transformation", "operationId": "addImageTransformation", "parameters": [ { "name": "id", "in": "path", "description": "image id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfImageTransformation" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfImageTransformation" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/dms/resources/{id}/shares": { "get": { "tags": [ "Documents" ], "summary": "get all existing shares", "operationId": "getShare", "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/dms-shelf-ShelfShare" } } } } } } }, "post": { "tags": [ "Documents" ], "summary": "Create new Share", "operationId": "createShare", "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-ShelfShare" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfShare" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/dms/resources/{id}/file": { "get": { "tags": [ "Documents" ], "summary": "download the original or transformed document file", "operationId": "handleFileDownload", "parameters": [ { "name": "id", "in": "path", "description": "ID der DMS-Ressource", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "uiKey", "in": "query", "description": "optional: Einschr\u00e4nkung auf eine bestimmte Transformation", "required": false, "schema": { "type": "string" } }, { "name": "disposition", "in": "query", "description": "optional: gew\u00fcnschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response with download-url", "content": { "application/json": { "schema": { "type": "object" } } } }, "303": { "description": "Location attribute contains alternate download location", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "post": { "tags": [ "Documents" ], "summary": "upload/change the original document file", "operationId": "handleFileUpload", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "sha256hash", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/dms/resources/{id}/file-transfer": { "post": { "tags": [ "Documents" ], "summary": "start a file transfer (chunked and multiparted)", "operationId": "createFileTransfer", "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-TransferFileCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-TransferFileCreateResponse" } } } } } } }, "/dms/resources/{id}/file-transfer/{token}/terminate": { "post": { "tags": [ "Documents" ], "summary": "terminate/delete a file transfer", "operationId": "terminateFileTransfer", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "token", "in": "path", "description": "file-transfer token", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/dms/resources/{id}/file-transfer/{token}/finish": { "post": { "tags": [ "Documents" ], "summary": "finish a file transfer", "operationId": "finishFileTransfer", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "token", "in": "path", "description": "file-transfer token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-TransferFileFinishRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/dms/resources/types": { "post": { "tags": [ "Document Types" ], "summary": "Create new Resource", "operationId": "create_74", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/dms/resources/dms-key/{dmsKey}": { "post": { "tags": [ "Documents" ], "operationId": "createWithQuery", "parameters": [ { "name": "dmsKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-DmsUploadWrapper" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocument" } } } } } } }, "/dms/attributions": { "get": { "tags": [ "Attributions" ], "description": "Liefert alle Verkn\u00fcpfungen, die zu einem ERP-Objekt geh\u00f6ren.", "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\u00fcr 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" } } } } } } }, "post": { "tags": [ "Attributions" ], "summary": "Create new Resource", "operationId": "create_75", "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" } } } } } } }, "/vds/carrier-type": { "post": { "tags": [ "carrier-type-resource" ], "summary": "Create new Resource", "operationId": "create_76", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-carrier-CarrierType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vds-carrier-CarrierType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/vds/carrier": { "post": { "tags": [ "carrier-resource" ], "summary": "Create new Resource", "operationId": "create_77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-carrier-Carrier" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-carrier-Carrier" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/statistic/scenario/{id}/rebuild": { "post": { "tags": [ "scenario-resource" ], "operationId": "rebulid", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/erp/statistic/scenario-desired-value": { "post": { "tags": [ "scenario-desired-value-resource" ], "summary": "Create a Instance", "operationId": "create_78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioDesiredValue" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioDesiredValue" } } } }, "422": { "description": "Resource was unable to create", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/statistic/scenario-actual-value": { "post": { "tags": [ "scenario-actual-value-resource" ], "summary": "Create a Instance", "operationId": "create_79", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioActualValue" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-api-ScenarioActualValue" } } } }, "422": { "description": "Resource was unable to create", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/statistic/scenario": { "post": { "tags": [ "scenario-resource" ], "summary": "Create a Instance", "operationId": "create_80", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-api-Scenario" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-api-Scenario" } } } }, "422": { "description": "Resource was unable to create", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/sales-channels/backend": { "post": { "tags": [ "SalesChannel" ], "summary": "Create new Resource", "operationId": "create_81", "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" } } } } } } }, "/erp/sales-channels": { "post": { "tags": [ "SalesChannel" ], "summary": "Create new Resource", "operationId": "create_82", "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" } } } } } } }, "/erp/pos/payment/method": { "post": { "tags": [ "PosPaymentMethod" ], "summary": "Create new Resource", "operationId": "create_83", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentMethod" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentMethod" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/payment/backend": { "post": { "tags": [ "PosPaymentBackend" ], "summary": "Create new Resource", "operationId": "create_84", "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" } } } } } } }, "/erp/finance/booking/{id}/set-ledger-assignment/{recordId}": { "post": { "tags": [ "FinanceBooking" ], "operationId": "setLedgerForRecord", "parameters": [ { "name": "id", "in": "path", "description": "id of booking run", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "recordId", "in": "path", "description": "id of booking record", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-LedgerForSingleRecordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBookingRecord" } } } } } } }, "/erp/finance/booking/{id}/revert": { "post": { "tags": [ "FinanceBooking" ], "operationId": "revertById_1", "parameters": [ { "name": "id", "in": "path", "description": "id of booking run", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBookingRun" } } } } } } }, "/erp/finance/booking/{id}/create-missing-ledger-assignments": { "post": { "tags": [ "FinanceBooking" ], "operationId": "setLedgersForEmptyRecords", "parameters": [ { "name": "id", "in": "path", "description": "id of booking run", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-LedgerForMissingRecordsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBookingRun" } } } } } } }, "/erp/finance/booking/{id}/committable": { "post": { "tags": [ "FinanceBooking" ], "operationId": "committableById", "parameters": [ { "name": "id", "in": "path", "description": "id of booking run", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBookingRun" } } } } } } }, "/erp/finance/booking/{id}/commit": { "post": { "tags": [ "FinanceBooking" ], "operationId": "commitById_1", "parameters": [ { "name": "id", "in": "path", "description": "id of booking run", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBookingRun" } } } } } } }, "/erp/finance/booking/singlerun": { "post": { "tags": [ "FinanceBooking" ], "operationId": "startRun_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-BookingRunRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/backend": { "post": { "tags": [ "FinanceBookingBackend" ], "summary": "Create new Resource", "operationId": "create_85", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBookingBackend" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBookingBackend" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/delivery/methods": { "post": { "tags": [ "DeliveryMethod" ], "summary": "Create new Resource", "operationId": "create_86", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-DeliveryMethod" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-delivery-DeliveryMethod" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-tasks/{id}/reminders/": { "post": { "tags": [ "Aufgaben" ], "operationId": "createReminder", "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" } } } } } } }, "/erp/crm-tasks/{id}/reactivate": { "post": { "tags": [ "Aufgaben" ], "operationId": "reactivate", "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-CrmTask" } } } } } } }, "/erp/crm-tasks/{id}/perform-billing": { "post": { "tags": [ "Aufgaben" ], "operationId": "performBilling_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "direct-order-to-invoice", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmTask" } } } } } } }, "/erp/crm-tasks/perform-billing": { "post": { "tags": [ "Aufgaben" ], "operationId": "performBilling_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmTaskPerformBillingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/crm-tasks": { "post": { "tags": [ "Aufgaben" ], "summary": "Neue Aufgabe(n) erzeugen", "operationId": "createTasksByTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CreateCrmTaskRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CreateCrmTaskResponse" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-projects/{id}/reminders/": { "post": { "tags": [ "Projekte" ], "operationId": "createReminder_1", "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" } } } } } } }, "/erp/crm-projects/{id}/perform-billing": { "post": { "tags": [ "Projekte" ], "operationId": "performBilling_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/crm-projects": { "post": { "tags": [ "Projekte" ], "summary": "Neues Projekt erzeugen", "operationId": "createByTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CreateCrmProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmProject" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/crm-deals": { "post": { "tags": [ "Deals" ], "summary": "Neues Projekt erzeugen", "operationId": "createByTemplate_1", "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" } } } } } } }, "/erp/accounts/{id}/relations": { "get": { "tags": [ "account" ], "operationId": "getRelations", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-account-AccountRelation" } } } } } } }, "post": { "tags": [ "account" ], "operationId": "createRelation", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountRelation" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountRelation" } } } } } } }, "/erp/accounts/{id}/persons": { "get": { "tags": [ "account" ], "operationId": "getAccountPersons", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } } } } } }, "post": { "tags": [ "account" ], "operationId": "postAccountPerson", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } } } } } }, "/erp/accounts/{id}/leasable-lock": { "get": { "tags": [ "account" ], "summary": "Pr\u00fcft, ob eine Resource gesperrt ist", "operationId": "getLeasableLock_2", "parameters": [ { "name": "id", "in": "path", "description": "ID einer Resource", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } }, "post": { "tags": [ "account" ], "summary": "Erstellt eine neue Sperre, optional mit einer G\u00fcltigkeitsdauer", "operationId": "createLeasableLock_2", "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": { "application/json": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } } }, "/erp/accounts/{id}/bankdetails/{bankdetailId}/sepamandates": { "get": { "tags": [ "account" ], "operationId": "getSEPAMandates", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankdetailId", "in": "path", "description": "identifier of a bankdetail", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-account-SEPAMandate" } } } } } } }, "post": { "tags": [ "account" ], "operationId": "postSEPAMandate", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankdetailId", "in": "path", "description": "identifier of bankdetail", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SEPAMandate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-SEPAMandate" } } } } } } }, "/erp/accounts/{id}/bankdetails": { "get": { "tags": [ "account" ], "operationId": "getBankdetail_1", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-account-AccountBankdetail" } } } } } } }, "post": { "tags": [ "account" ], "operationId": "createBankdetail", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountBankdetail" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountBankdetail" } } } } } } }, "/erp/accounts/{id}/addresses/{addressId}/verify-taxid": { "post": { "tags": [ "account" ], "operationId": "verifyAccountAddressTaxId", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "addressId", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-TaxIDProtocol" } } } } } } }, "/erp/accounts/{id}/addresses": { "get": { "tags": [ "account" ], "operationId": "getAccountAddresses", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-account-AccountAddress" } } } } } } }, "post": { "tags": [ "account" ], "operationId": "postAccountAddresses", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountAddress" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountAddress" } } } } } } }, "/erp/accounts": { "post": { "tags": [ "account" ], "summary": "Neuen Account erzeugen", "operationId": "createAccount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-CreateAccountRequestApi" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-Account" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/account-types/salutations": { "post": { "tags": [ "salutation" ], "summary": "Create new Resource", "operationId": "create_87", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountSalutation" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountSalutation" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/system/log-entries": { "post": { "tags": [ "Logs" ], "summary": "Create a Instance", "operationId": "create_88", "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" } } } } } } }, "/cmn/system/app-scripting-proxy/{appIdentifier}/{triggerId}": { "post": { "tags": [ "app-scripting-proxy-resource" ], "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" } } } } } } }, "/cmn/system/app-scripting-proxy": { "post": { "tags": [ "app-scripting-proxy-resource" ], "summary": "Create new Resource", "operationId": "create_89", "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" } } } } } } }, "/cmn/system/app-message-webhook/register": { "post": { "tags": [ "app-message-webhook-resource" ], "summary": "deregister a webhook", "operationId": "register_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-AppMessageWebhook" } } }, "required": true }, "responses": { "200": { "description": "successful operation" }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/system/app-message-webhook/deregister": { "post": { "tags": [ "app-message-webhook-resource" ], "summary": "deregister an existing webhook", "operationId": "deregister_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-AppMessageWebhook" } } }, "required": true }, "responses": { "200": { "description": "successful operation" }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/system/app-message": { "post": { "tags": [ "app-message-entry-resource" ], "summary": "Create a Instance", "operationId": "create_90", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-AppMessageEntry" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-AppMessageEntryGet" } } } }, "422": { "description": "Resource was unable to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/output/queue/{taskId}/state/{newState}": { "post": { "tags": [ "Output-Queue" ], "operationId": "updateState", "parameters": [ { "name": "taskId", "in": "path", "description": "ID des Tasks", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "newState", "in": "path", "description": "neuer newState", "required": true, "schema": { "type": "string", "enum": [ "REQUESTED", "PROCESSING", "ERROR", "DONE", "ABORTED" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-OutputQueueStateChangeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/cmn/output/consumer/{id}/request-next": { "post": { "tags": [ "Output-Consumer" ], "operationId": "requestNextTask", "parameters": [ { "name": "id", "in": "path", "description": "ID des Printservers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-OutputQueue" } } } } } } }, "/cmn/output/consumer-rule": { "post": { "tags": [ "Output-Rule" ], "summary": "Create new Resource", "operationId": "create_91", "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" } } } } } } }, "/cmn/output/consumer": { "post": { "tags": [ "Output-Consumer" ], "summary": "Create new Resource", "operationId": "create_92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-OutputConsumer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-OutputConsumer" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/masterdata/text-enums": { "post": { "tags": [ "TextEnumeration" ], "summary": "Create a Instance", "operationId": "create_93", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-TextEnumCreate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-api-TextEnumGet" } } } }, "422": { "description": "Resource was unable to create", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/masterdata/text-enum-groups": { "post": { "tags": [ "TextEnumeration-Groups" ], "summary": "Create a Instance", "operationId": "create_94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-TextEnumGroupCreate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-api-TextEnumGroupGet" } } } }, "422": { "description": "Resource was unable to create", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/eav-groups/{id}/remove-data": { "post": { "tags": [ "EavGroup" ], "summary": "force deletion of data", "operationId": "removeData", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-eav-EavDataRemoveRequest" } } }, "required": true }, "responses": { "200": { "description": "operation process successfully" } } } }, "/cmn/eav-groups": { "post": { "tags": [ "EavGroup" ], "summary": "Create new Resource", "operationId": "create_95", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-eav-EavGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-eav-EavGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/workflows": { "post": { "tags": [ "Workflow" ], "summary": "Create new Resource", "operationId": "create_96", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/workflows/{id}/workflow-elements": { "get": { "tags": [ "Workflow" ], "operationId": "getElements", "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/common-workflow-WorkflowElement" } } } } } } }, "post": { "tags": [ "Workflow" ], "operationId": "addElement", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-WorkflowElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-WorkflowElement" } } } } } } }, "/cmn/workflows/{id}/workflow-elements/edge/{source-id}/to/{target-id}": { "post": { "tags": [ "Workflow" ], "operationId": "connectElements", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "source-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "target-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "executeOnSplitResult", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Workflow" ], "operationId": "disconnectElements", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "source-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "target-id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/workflows/try-execute-script": { "post": { "tags": [ "Workflow" ], "operationId": "tryExecuteScript", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-WorkflowScriptExecutionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/cmn/workflows/import": { "post": { "tags": [ "Workflow" ], "operationId": "importWorkflow", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } } } } }, "/cmn/users/{id}/signature": { "post": { "tags": [ "User" ], "operationId": "createSignature", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputSignature" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-output-OutputSignature" } } } } } } }, "/cmn/users/{id}/favorites/subscription": { "post": { "tags": [ "User" ], "operationId": "createSubscriptionFavorite", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } } } } } }, "/cmn/users/{id}/favorites/outputs": { "post": { "tags": [ "User" ], "operationId": "createOutputFavorite", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } } } } } }, "/cmn/users/roles": { "post": { "tags": [ "Role" ], "summary": "Create new Resource", "operationId": "create_97", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-Role" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-Role" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/users/me/settings/{settingKey}": { "get": { "tags": [ "User" ], "operationId": "singleSetting", "parameters": [ { "name": "settingKey", "in": "path", "description": "setting key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserSetting" } } } } } }, "post": { "tags": [ "User" ], "operationId": "storeUserSetting", "parameters": [ { "name": "settingKey", "in": "path", "description": "setting key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserSetting" } } } } } }, "delete": { "tags": [ "User" ], "operationId": "deleteSingleSetting", "parameters": [ { "name": "settingKey", "in": "path", "description": "setting key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/users/me/messages": { "post": { "tags": [ "User Message" ], "summary": "post a message", "operationId": "postMessage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserMessageCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserMessage" } } } } } } }, "/cmn/users/me/favorites/subscription": { "post": { "tags": [ "User" ], "operationId": "createMeSubscriptionFavorite", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserSubscriptionFavorite" } } } } } } }, "/cmn/users/me/favorites/outputs": { "post": { "tags": [ "User" ], "operationId": "createOutputFavoriteMe", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserOutputFavorite" } } } } } } }, "/cmn/users/groups": { "post": { "tags": [ "Group" ], "summary": "Create new Resource", "operationId": "create_98", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-Group" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-user-Group" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/unit-types": { "post": { "tags": [ "UnitType" ], "summary": "Create new Resource", "operationId": "create_99", "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" } } } } } } }, "/cmn/unit-type-ratio": { "post": { "tags": [ "UnitTypeRatio" ], "summary": "Create new Resource", "operationId": "create_100", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-UnitTypeRatio" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-UnitTypeRatio" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/ui-settings": { "post": { "tags": [ "Ui-Einstellungen" ], "summary": "Create new Resource", "operationId": "create_101", "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" } } } } } } }, "/cmn/text/translations": { "post": { "tags": [ "Text" ], "summary": "Create new Resource", "operationId": "create_102", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-Translation" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-Translation" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/task": { "post": { "tags": [ "Task" ], "summary": "Create new Resource", "operationId": "create_103", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-task-Task" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-task-Task" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/task/{id}/start": { "post": { "tags": [ "Task" ], "operationId": "triggerTaskStart", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/task/support/{identifier}/run-now": { "post": { "tags": [ "Task" ], "summary": "Plant einen Support-Task als runOnce & now ein", "operationId": "start", "parameters": [ { "name": "identifier", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/cmn/tags": { "post": { "tags": [ "Tags" ], "summary": "Create new Resource", "operationId": "create_104", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-tag-TagDto" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-tag-TagDto" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/sequencer/{id}/reinit/{groupKey}": { "post": { "tags": [ "Sequencer" ], "operationId": "reinitSequence", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "groupKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "newValue", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/sequencer/free": { "post": { "tags": [ "FreeSequencer" ], "summary": "Create new Resource", "operationId": "create_105", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-sequencer-FreeSequence" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-sequencer-FreeSequence" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/scripting/modules": { "post": { "tags": [ "Skript-Modul" ], "summary": "Create new Resource", "operationId": "create_106", "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" } } } } } } }, "/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" } } } } } } }, "/cmn/scripting/module-groups": { "post": { "tags": [ "Skript-Modul-Gruppe" ], "summary": "Create new Resource", "operationId": "create_107", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-scripting-ScriptModuleGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-scripting-ScriptModuleGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/purgeMovementRecords/purge": { "post": { "tags": [ "PurgeMovementData" ], "operationId": "purgeMovementRecords", "responses": { "200": { "description": "OK" } } } }, "/cmn/output/reports": { "post": { "tags": [ "Output-Module" ], "summary": "Create new Resource", "operationId": "create_108", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReport" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/output/reports/{id}/reset": { "post": { "tags": [ "Output-Module" ], "operationId": "postReset", "parameters": [ { "name": "id", "in": "path", "description": "report identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/output/modules/{moduleKey}/texts": { "get": { "tags": [ "Output-Module" ], "summary": "Find all by module key and isoalpha2", "operationId": "getAllTranslations", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "languageId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-output-OutputReportLocalizedText" } } } } } } }, "post": { "tags": [ "Output-Module" ], "summary": "Create translation", "operationId": "createTranslation", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportLocalizedText" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportLocalizedText" } } } } } } }, "/cmn/output/modules/{moduleKey}/report-groups": { "post": { "tags": [ "Output-Module" ], "description": "erstellt eine Gruppe", "operationId": "createReportGroup", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportGroup" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputReportGroup" } } } } } } }, "/cmn/language-codes": { "post": { "tags": [ "LanguageCode" ], "summary": "Create new Resource", "operationId": "create_109", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-LanguageCode" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-LanguageCode" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/ft-search/types/index": { "post": { "tags": [ "FulltextSearch" ], "summary": "rebuild index for type(s)", "operationId": "rebuildIndexByType", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/cmn/ft-search/phonetic": { "post": { "tags": [ "FulltextSearch" ], "summary": "phonetic search", "operationId": "queryPhonetic", "parameters": [ { "name": "perspective", "in": "query", "description": "Perspective of result", "required": false, "style": "form", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-ftsearch-SearchPhoneticRequest" } } }, "required": true }, "responses": { "422": { "description": "query was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-ftsearch-SearchResult" } } } } } } } }, "/cmn/data-import/scheduled-import": { "post": { "tags": [ "eingeplante Importe" ], "summary": "Create new Resource", "operationId": "create_110", "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" } } } } } } }, "/cmn/data-import/runs/single": { "post": { "tags": [ "ImportRun" ], "summary": "Create new Resource", "operationId": "create_111", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-data_import-DataImportRun" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-DataImportRun" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/data-import/runs/single/{id}/run/validate": { "post": { "tags": [ "ImportRun" ], "operationId": "startValidation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "from", "in": "query", "description": "Optional: Datens\u00e4tze erst ab Eintrag ... validieren. null = ohne Einschr\u00e4nkung", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "to", "in": "query", "description": "Optional: Datens\u00e4tze nur bis Eintrag ... validieren. null = ohne Einschr\u00e4nkung", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/data-import/runs/multi-part": { "post": { "tags": [ "MultiPartImport" ], "operationId": "createFromRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-data_import-CreateMultiPartImportRunRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-MultiPartImportRun" } } } } } } }, "/cmn/data-import/runs/multi-part/{id}/create-import-runs": { "post": { "tags": [ "MultiPartImport" ], "operationId": "createImportRuns", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "startImport", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-MultiPartImportRun" } } } } } } }, "/cmn/data-import/runs/multi-part/template/{templateName}/start": { "post": { "tags": [ "MultiPartImport" ], "operationId": "startFromTemplate", "parameters": [ { "name": "templateName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/data-import/rule-sets": { "post": { "tags": [ "ImportRuleSet" ], "summary": "Create new Resource", "operationId": "create_112", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/currency-codes": { "post": { "tags": [ "CurrencyCode" ], "summary": "Create new Resource", "operationId": "create_113", "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" } } } } } } }, "/cmn/currency-codes/rates": { "post": { "tags": [ "CurrencyExchangeRate" ], "summary": "Create new Resource", "operationId": "create_114", "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" } } } } } } }, "/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" } } } } } } }, "post": { "tags": [ "CreateTemplates" ], "summary": "Create new Resource", "operationId": "create_115", "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" } } } } } } }, "/cmn/create-templates/groups": { "get": { "tags": [ "CreateTemplateGroups" ], "operationId": "getAll_10", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-create_template-CreateTemplateGroup" } } } } } } }, "post": { "tags": [ "CreateTemplateGroups" ], "summary": "Create new Resource", "operationId": "create_116", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-create_template-CreateTemplateGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-create_template-CreateTemplateGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/country-region": { "post": { "tags": [ "CountryRegion" ], "summary": "Create new Resource", "operationId": "create_117", "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" } } } } } } }, "/cmn/country-codes": { "post": { "tags": [ "CountryCode" ], "summary": "Create new Resource", "operationId": "create_118", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-CountryCode" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CountryCode" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/computed-queries/{group-key}/{id}": { "post": { "tags": [ "computed-queries" ], "operationId": "query", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPresetRequest" } } } }, "responses": { "422": { "description": "query was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-cunit-CuResult" } } } } } } }, "/cmn/computed-queries/{group-key}/{id}/print": { "post": { "tags": [ "computed-queries" ], "operationId": "print", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPresetOutputRequest" } } } }, "responses": { "202": { "description": "Request is accepted and processing in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-OutputQueue" } } } }, "200": { "description": "Request is processed and returned as Stream", "content": { "*/*": {} } } } } }, "/cmn/computed-queries/{group-key}/{id}/presets": { "get": { "tags": [ "computed-queries" ], "operationId": "getAllQueryPresets", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "forAdmin", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "forWorkflow", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-cunit-QueryPreset" } } } } } } }, "post": { "tags": [ "computed-queries" ], "operationId": "createQueryPreset", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-CreateQueryPresetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPreset" } } } } } } }, "/cmn/computed-queries/{group-key}/{id}/presets/{presetId}/user-options": { "post": { "tags": [ "query-preset-user-options-resource" ], "operationId": "createQueryPresetUserOption", "parameters": [ { "name": "presetId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPresetUserOptions" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPresetUserOptions" } } } } } } }, "/cmn/computed-queries/{group-key}/{id}/presets/adhoc": { "post": { "tags": [ "computed-queries" ], "operationId": "getStructure", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPresetRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPreset" } } } } } } }, "/cmn/computed-queries/execute": { "post": { "tags": [ "computed-queries" ], "operationId": "executeQuery", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-VqlQueryApi" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-cunit-CuResult" } } } } } } }, "/cmn/apps/{identifier}/token": { "post": { "tags": [ "tenant-app-resource" ], "operationId": "issueInstalledAppToken", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/node-nodemaster-AppToken" } } } } } } }, "/cmn/apps/{identifier}/refresh-token": { "post": { "tags": [ "tenant-app-resource" ], "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-nodemaster-AppToken" } } } } } } }, "/cmn/apps/{identifier}/permitted-token": { "post": { "tags": [ "tenant-app-resource" ], "operationId": "issueTokenByPermission", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/node-nodemaster-PermittedTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/node-nodemaster-AppToken" } } } } } } }, "/banking/banking-user/{userId}/replicate": { "post": { "tags": [ "BankingUser" ], "operationId": "replicateUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/banking/banking-user/create/{bankingProviderId}": { "post": { "tags": [ "BankingUser" ], "operationId": "createUser", "parameters": [ { "name": "bankingProviderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingUser" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingUser" } } } } } } }, "/banking/banking-provider": { "post": { "tags": [ "BankingProvider" ], "summary": "Create new Resource", "operationId": "create_119", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingProvider" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingProvider" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/banking/banking-provider/create": { "post": { "tags": [ "BankingProvider" ], "operationId": "createProvider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingProviderCreationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingProviderCreationMessage" } } } } } } }, "/erp/accounts/{id}/person/{personId}": { "patch": { "tags": [ "account" ], "summary": "Partial-Data-Update for Account-Person", "operationId": "partialUpdatePerson", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "personId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountPerson" } } } }, "404": { "description": "Resource with given ids was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/accounts/{id}/address/{addressId}": { "patch": { "tags": [ "account" ], "summary": "Partial-Data-Update for Account-Address", "operationId": "partialUpdateAccountAddress", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "addressId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountAddress" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountAddress" } } } }, "404": { "description": "Resource with given ids was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/wms/scannable-code-recognition/process-input/{inputData}": { "get": { "tags": [ "Scanbare-Code-Erkennung" ], "operationId": "processInput_3", "parameters": [ { "name": "inputData", "in": "path", "description": "Benutzereingabe/Scan", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-ScannableCodeRecognitionResult" } } } } } } }, "/wms/picktrolleys/byIdentifier/{identifier}": { "get": { "tags": [ "Pickwagen" ], "operationId": "getPickTrolleyByIdentifier", "parameters": [ { "name": "identifier", "in": "path", "description": "Identifier des Pickwagen", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolley" } } } } } } }, "/wms/picktrolleys/boxByIdentifier/{identifier}": { "get": { "tags": [ "Pickwagen" ], "operationId": "getPickTrolleyBoxByIdentifier", "parameters": [ { "name": "identifier", "in": "path", "description": "Identifier der Pickbox", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBox" } } } } } } }, "/wms/picklists/{id}": { "get": { "tags": [ "Picklisten" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-wms-Picklist" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/wms/picklists/script-context-description/{picklistScriptType}": { "get": { "tags": [ "Picklisten" ], "operationId": "getScriptDescription", "parameters": [ { "name": "picklistScriptType", "in": "path", "description": "Typ des Skripts", "required": true, "schema": { "type": "string", "description": "M\u00f6gliche Skript-Typen f\u00fcr Erstellung und Verarbeitung von Picklisten", "enum": [ "CONNECT_PICK_BOXES_TO_PICKLIST_LINE" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-scripting-ScriptDescription" } } } } } } }, "/wms/inventories/{id}/differences": { "get": { "tags": [ "Inventory" ], "operationId": "getInventoryDifferences", "parameters": [ { "name": "id", "in": "path", "description": "ID der Inventur", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-wms-InventoryDifference" } } } } } } } }, "/vds/carrier-initializer": { "get": { "tags": [ "carrier-initialize-resource" ], "summary": "Get a list of possible keys for initializer objects", "operationId": "getKeys", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/vds-carrier-VdiInitializerKey" } } } } } } } }, "/third-party-info": { "get": { "tags": [ "third-party-info-resource" ], "operationId": "thirdPartyLicenses", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-system-ThirdPartyDependency" } } } } } } } }, "/public/dms/{public-id}": { "get": { "tags": [ "shelf-public-access-resource" ], "summary": "download the public accessible image", "operationId": "handlePublicFileDownload", "parameters": [ { "name": "public-id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "422": { "description": "Resource was not valid to process", "content": { "application/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "303": { "description": "Location attribute contains alternate download location", "content": { "application/*": { "schema": { "type": "object" } } } } } } }, "/public/dms-presigned/{id}/download": { "get": { "tags": [ "local-storage-file-resource" ], "operationId": "downloadFile", "parameters": [ { "name": "id", "in": "path", "description": "shelf-document-id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storageHandle", "in": "query", "description": "storageHandle", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "token", "required": true, "schema": { "type": "string" } }, { "name": "disposition", "in": "query", "description": "disposition", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response with download-url", "content": { "application/*": { "schema": { "type": "object" } } } }, "303": { "description": "Location attribute contains alternate download location", "content": { "application/*": { "schema": { "type": "object" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "Response contains File", "content": { "application/*": { "schema": { "type": "object" } } } } } } }, "/git-info": { "get": { "tags": [ "git-info-resource" ], "operationId": "infos", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-unknownmodule-GitInfo" } } } } } } } }, "/erp/user-details/user-id/{id}": { "get": { "tags": [ "UserDescription" ], "operationId": "readByUserId", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-user-ErpUserDetail" } } } } } } }, "/erp/text-templates/variables": { "get": { "tags": [ "TextTemplate" ], "operationId": "queryVariables", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-cunit-CuAttribute" } } } } } } } }, "/erp/taxes/tax-select": { "get": { "tags": [ "TaxSelect" ], "operationId": "getTaxRateBySelection", "parameters": [ { "name": "articleId", "in": "query", "description": "Ein Artikel", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "countryCode", "in": "query", "description": "L\u00e4ndercode", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Ein Datum", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxRate" } } } } } } }, "/erp/taxes/tax-select/{taxSchemaId}": { "get": { "tags": [ "TaxSelect" ], "operationId": "getTaxRateBySchema", "parameters": [ { "name": "taxSchemaId", "in": "path", "description": "Ein Tax-Schema", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-tax-TaxRate" } } } } } } }, "/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" } } } } } } }, "/erp/stocks/stockjournal": { "get": { "tags": [ "Stocks" ], "operationId": "getStockJournalBySelection", "parameters": [ { "name": "selection", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/erp-stock-StockJournalSelection" } }, { "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-StockJournal" } } } } } } } }, "/erp/statistics/time-series": { "get": { "tags": [ "dataseries" ], "operationId": "getQueries", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-statistic-QueryAlias" } } } } } } } }, "/erp/products/{id}/suppliers": { "get": { "tags": [ "Product" ], "summary": "F\u00fcr 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" } } } } } } } }, "/erp/products/{id}/customers": { "get": { "tags": [ "Product" ], "summary": "F\u00fcr 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" } } } } } } } }, "/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": { "type": "string", "description": "Id der Mengeneinheit f\u00fcr den der Preis gilt" } }, { "name": "convertToUnitTypeId", "in": "query", "required": true, "style": "form", "schema": { "type": "string", "description": "Id der Mengeneinheit f\u00fcr den der Preis umgerechnet werden soll" } }, { "name": "price", "in": "query", "required": true, "style": "form", "schema": { "type": "string", "description": "Preis" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "number" } } } } } } }, "/erp/products/sales-prices/{articleId}": { "get": { "tags": [ "ProductPrices" ], "operationId": "getProductSalesPricesBySelection", "parameters": [ { "name": "articleId", "in": "path", "description": "ID des Artikels", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "required": false, "style": "form", "schema": { "type": "string", "description": "ID eines Accounts zum Filtern der Preise" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } } } } } } }, "/erp/products/sales-prices/{articleId}/history/{salesChannelId}": { "get": { "tags": [ "ProductPrices" ], "operationId": "getProductSalesPriceHistory", "parameters": [ { "name": "articleId", "in": "path", "description": "ID des Artikels", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "salesChannelId", "in": "path", "description": "ID des Verkaufskanals", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductPriceHistory" } } } } } } } }, "/erp/products/sales-price-rules-to-account/{accountId}": { "get": { "tags": [ "ProductPrices" ], "operationId": "getProductSalesPriceRulesToAccount", "parameters": [ { "name": "accountId", "in": "path", "description": "ID eines Accounts", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } } } } } } }, "/erp/products/sales-price-by-selection": { "get": { "tags": [ "ProductPrices" ], "operationId": "getProductSalesPriceBySelection", "parameters": [ { "name": "articleId", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Produkt", "format": "int64", "nullable": true } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Account", "format": "int64", "nullable": true } }, { "name": "productGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Warengruppe", "format": "int64", "nullable": true } }, { "name": "priceGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Preisgruppe", "format": "int64", "nullable": true } }, { "name": "manufacturerId", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Hersteller", "format": "int64", "nullable": true } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Datum", "format": "date", "nullable": true } }, { "name": "quantity", "in": "query", "required": false, "schema": { "type": "number", "description": "Eine Menge", "format": "double", "nullable": true } }, { "name": "noteSpecialOfferPrice", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Soll ein Aktionspreis beachtet werden?", "nullable": true } }, { "name": "discountGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Rabattgruppe", "format": "int64", "nullable": true } }, { "name": "salesChannelId", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Verkaufskanal", "format": "int64", "nullable": true } }, { "name": "customerGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Kundengruppe", "format": "int64", "nullable": true } }, { "name": "supplierGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Lieferantengruppe", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } } } } } }, "/erp/products/sales-discounts/{articleId}": { "get": { "tags": [ "ProductPrices" ], "operationId": "getProductSalesPriceRulesBySelection", "parameters": [ { "name": "articleId", "in": "path", "description": "ID des Produkts", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "required": false, "style": "form", "schema": { "type": "string", "description": "ID eines Accounts zum Filtern der Preisregeln" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } } } } } } }, "/erp/products/purchase-prices/{articleId}": { "get": { "tags": [ "ProductPrices" ], "operationId": "getProductPurchasePricesBySelection", "parameters": [ { "name": "articleId", "in": "path", "description": "ID des Produkts", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "required": false, "style": "form", "schema": { "type": "string", "description": "ID eines Accounts zum Filtern der Preise" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } } } } } } }, "/erp/products/purchase-prices/{articleId}/statistic": { "get": { "tags": [ "ProductPrices" ], "summary": "liefert dem dEK und letzten EK f\u00fcr ein Artikel (View Stammdaten)", "operationId": "getPurchasePriceStatistic", "parameters": [ { "name": "articleId", "in": "path", "description": "ID des Artikels", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-PurchasePriceStatistic" } } } } } } }, "/erp/products/purchase-price-rules-to-account/{accountId}": { "get": { "tags": [ "ProductPrices" ], "operationId": "getProductPurchasePriceRulesToAccount", "parameters": [ { "name": "accountId", "in": "path", "description": "ID eines Accounts", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } } } } } } }, "/erp/products/purchase-price-by-selection": { "get": { "tags": [ "ProductPrices" ], "operationId": "getProductPurchasePriceBySelection", "parameters": [ { "name": "articleId", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Produkt", "format": "int64", "nullable": true } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Account", "format": "int64", "nullable": true } }, { "name": "productGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Warengruppe", "format": "int64", "nullable": true } }, { "name": "priceGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Preisgruppe", "format": "int64", "nullable": true } }, { "name": "manufacturerId", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Hersteller", "format": "int64", "nullable": true } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Datum", "format": "date", "nullable": true } }, { "name": "quantity", "in": "query", "required": false, "schema": { "type": "number", "description": "Eine Menge", "format": "double", "nullable": true } }, { "name": "noteSpecialOfferPrice", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Soll ein Aktionspreis beachtet werden?", "nullable": true } }, { "name": "discountGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Rabattgruppe", "format": "int64", "nullable": true } }, { "name": "salesChannelId", "in": "query", "required": false, "schema": { "type": "string", "description": "Ein Verkaufskanal", "format": "int64", "nullable": true } }, { "name": "customerGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Kundengruppe", "format": "int64", "nullable": true } }, { "name": "supplierGroupId", "in": "query", "required": false, "schema": { "type": "string", "description": "Eine Lieferantengruppe", "format": "int64", "nullable": true } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } } } } } }, "/erp/products/purchase-discounts/{articleId}": { "get": { "tags": [ "ProductPrices" ], "operationId": "getProductPurchasePriceRulesBySelection", "parameters": [ { "name": "articleId", "in": "path", "description": "ID des Artikels", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "required": false, "style": "form", "schema": { "type": "string", "description": "ID eines Accounts zum Filtern der Preisregeln" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } } } } } } }, "/erp/products/prices/{priceId}": { "get": { "tags": [ "ProductPrices" ], "operationId": "getPrice", "parameters": [ { "name": "priceId", "in": "path", "description": "ID des Preises", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } } } } } }, "/erp/products/discounts/{discountId}": { "get": { "tags": [ "ProductPrices" ], "operationId": "getDiscount", "parameters": [ { "name": "discountId", "in": "path", "description": "ID des Rabatts", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } } } } } } }, "/erp/products/calculate-net-price": { "get": { "tags": [ "ProductPrices" ], "operationId": "calculateNetPrice", "parameters": [ { "name": "grossPrice", "in": "query", "required": true, "schema": { "type": "number" } }, { "name": "taxSchemaId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "number" } } } } } } }, "/erp/products/calculate-gross-price": { "get": { "tags": [ "ProductPrices" ], "operationId": "calculateGrossPrice", "parameters": [ { "name": "netPrice", "in": "query", "required": true, "schema": { "type": "number" } }, { "name": "taxSchemaId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "number" } } } } } } }, "/erp/product-variants/{mainVariantArticleId}/combinations": { "get": { "tags": [ "Product-Variant" ], "operationId": "getCombinationsForArticleMainProductVariant", "parameters": [ { "name": "mainVariantArticleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantCombinationsDto" } } } } } } }, "/erp/product-variants/{id}/attributes": { "get": { "tags": [ "Product-Variant" ], "operationId": "getAllAttributesForProductVariant", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttribute" } } } } } } } }, "/erp/pos/register/{posRegisterId}/tss/state": { "get": { "tags": [ "PosRegister" ], "operationId": "retrieveClientState", "parameters": [ { "name": "posRegisterId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "enum": [ "REGISTERED", "DEREGISTERED" ] } } } } } } }, "/erp/payments/templates/get_standard": { "get": { "tags": [ "PaymentTemplates" ], "description": "gibt die Standard-Zahlungstr\u00e4gervorlage f\u00fcr den angegeben Typ zur\u00fcck", "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" } } } } } } }, "/erp/payments/templates/get_available_fields": { "get": { "tags": [ "PaymentTemplates" ], "description": "gibt die Felder, die in einer Zahlungsvorlage verwendet werden k\u00f6nnen, zur\u00fcck", "operationId": "getAvailableFields", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-payment-PaymentTemplateField" } } } } } } } }, "/erp/order-proposal-to-orders-run/{id}": { "get": { "tags": [ "Bestellvorschlag-zu-Bestellungen-Lauf" ], "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-stock-OrderProposalToOrdersRun" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/payment_run/{id}": { "get": { "tags": [ "PaymentRun" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_34", "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-PaymentRun" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/openitemsynchronization/{bankAccountId}/start_matching": { "get": { "tags": [ "OpenItemSynch" ], "operationId": "getWithLock", "parameters": [ { "name": "bankAccountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } } }, "/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" ] } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/finance/openitems/{id}": { "get": { "tags": [ "OpenItem" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/erp-finance-OpenItem" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } } } } } }, "/erp/finance/openitems/payment/prepare_payments": { "get": { "tags": [ "OpenItemPayment" ], "description": "gibt einen Zahlungsvorschlag bestehend aus mehreren Offenen Posten zur\u00fcck.", "operationId": "preparePayments", "parameters": [ { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "bankAccountId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "incoming", "in": "query", "required": true, "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-PaymentPrepareResponse" } } } } } } }, "/erp/finance/openitems/matchingrules/max_points": { "get": { "tags": [ "MatchingRules" ], "operationId": "getMaxPoints", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/manual-entry/{id}": { "get": { "tags": [ "ManualEntry" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-ManualEntry" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/dunning_run/{id}": { "get": { "tags": [ "DunningRun" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_40", "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-DunningRun" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "DunningRun" ], "summary": "Delete an existing Resource", "operationId": "delete_34", "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" } } } } } } }, "/erp/finance/booked_dunning/{id}": { "get": { "tags": [ "Dunning" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_44", "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-Dunning" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/booked_dunning/highest_dunning_to_open_item/{openItemId}": { "get": { "tags": [ "Dunning" ], "operationId": "getByOpenItemId", "parameters": [ { "name": "openItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-Dunning" } } } } } } }, "/erp/finance/booked_dunning/cancelled_dunnings_to_open_item/{openItemId}": { "get": { "tags": [ "Dunning" ], "operationId": "getAllCancelledDunningsByOpenItemId", "parameters": [ { "name": "openItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-finance-Dunning" } } } } } } } }, "/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" ] } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/documents/{id}": { "get": { "tags": [ "Document" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } } }, "/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" } } } } } } } }, "/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" } } } } } } } }, "/erp/documents/{id}/text-templates": { "get": { "tags": [ "Document" ], "summary": "Gibt die manuellen Textbausteine f\u00fcr Kopf-/Fu\u00dftexte zur\u00fcck, die f\u00fcr 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" } } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } } }, "/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" } } } } } } } }, "/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" } } } } } } }, "/erp/documents/{id}/lines/{lineId}/purchase-price-statistic": { "get": { "tags": [ "Document" ], "summary": "liefert dem dEK und letzten EK f\u00fcr 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" } } } } } } }, "/erp/documents/{id}/lines/text-templates": { "get": { "tags": [ "Document" ], "summary": "Gibt die manuellen Textbausteine f\u00fcr Textpositionen zur\u00fcck, die f\u00fcr 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" } } } } } } } }, "/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" } } } } } } } }, "/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": { "type": "array", "items": { "$ref": "#/components/schemas/erp-document-ToSupplierDeliveryTransferableLine" } } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } } }, "/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-wms-CompleteDocumentAvailabilityInfo" } } } } } } }, "/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": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "SALE", "PURCHASE", "COMMISSION", "SALES_CONTRACT", "PURCHASE_CONTRACT", "POINT_OF_SALE", "FABRICATION" ] } } }, { "name": "languageCode", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-document-DocumentTransitionRef" } } } } } } } }, "/erp/documents/additional-functions/{documentId}/possible-correct-state": { "get": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "M\u00f6glichen korrekten Belegstatus abfragen", "operationId": "getPossibleCorrectDocumentState", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentTypeState" } } } } } } }, "/erp/document-types/{id}/transitions": { "get": { "tags": [ "DocumentType" ], "operationId": "readTransition", "parameters": [ { "name": "id", "in": "path", "description": "type identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeTransition" } } } } } } } }, "/erp/document-types/{id}/states": { "get": { "tags": [ "DocumentType" ], "operationId": "readStates", "parameters": [ { "name": "id", "in": "path", "description": "type identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeState" } } } } } } } }, "/erp/document-types/{id}/dot-file": { "get": { "tags": [ "DocumentType" ], "operationId": "buildDotFile", "parameters": [ { "name": "id", "in": "path", "description": "type identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain;charset=UTF-8": { "schema": { "type": "string" } } } } } } }, "/erp/document-types/states": { "get": { "tags": [ "DocumentType" ], "description": "return all UI relevant document-type-states Labels)", "operationId": "getDocumentTypeStates", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeStateRef" } } } } } } } }, "/erp/document-types/dot-file": { "get": { "tags": [ "DocumentType" ], "operationId": "buildCompleteDotFile", "responses": { "200": { "description": "OK", "content": { "text/plain;charset=UTF-8": { "schema": { "type": "string" } } } } } } }, "/erp/document-types/chains/by-predecessor/{predecessorId}": { "get": { "tags": [ "DocumentTypeChain" ], "operationId": "getDocumentTypeChains", "parameters": [ { "name": "predecessorId", "in": "path", "description": "ID of Predecessor", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeChain" } } } } } } } }, "/erp/document-types/categories": { "get": { "tags": [ "DocumentType" ], "description": "return all document-type-categories", "operationId": "getDocumentTypeCategories", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/erp/crm-deals/visibilities/by-deal-user/{dealUserId}": { "get": { "tags": [ "Sichtbarkeit von CRM-Deals" ], "operationId": "getAllByDealUserId", "parameters": [ { "name": "dealUserId", "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-CrmDealVisibility" } } } } } } } }, "/erp/crm-billing-run/{id}": { "get": { "tags": [ "CRM Abrechnungslauf" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_64", "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" } } } } } } }, "/erp/crm-activities/{refId}/workflow-state": { "get": { "tags": [ "Aktivit\u00e4ten" ], "summary": "Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz", "operationId": "getWorkflowState_2", "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" ] } } } } } } }, "/erp/crm-activities/{refId}/workflow-instances-preset": { "get": { "tags": [ "Aktivit\u00e4ten" ], "summary": "Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz", "operationId": "getWorkflowInstancesPreset_2", "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" } } } } } } }, "/erp/crm-activities/{refId}/latest-workflow-instance": { "get": { "tags": [ "Aktivit\u00e4ten" ], "summary": "Liefert die neuste Workflow-Instanz zu der gegebenen Referenz", "operationId": "getLatestWorkflowInstance_2", "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" } } } } } } }, "/erp/commission/run/{id}": { "get": { "tags": [ "CommissionRun" ], "operationId": "getById_70", "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" } } } } } } }, "/erp/commission/run/check": { "get": { "tags": [ "CommissionRun" ], "operationId": "check", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } } } }, "/erp/bundle-schemata/templates": { "get": { "tags": [ "bundle schema" ], "operationId": "getTemplates", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-BundleSchema" } } } } } } } }, "/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" } } } } } } } }, "/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" ] } }, { "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" } } } } } } } }, "/erp/bank/payments/{paymentId}/actions": { "get": { "tags": [ "BankPayment" ], "operationId": "getBankPaymentActions", "parameters": [ { "name": "paymentId", "in": "path", "description": "ID der Zahlung", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-bank-BankPaymentAction" } } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/bank/accounts/{accountId}/transactions": { "get": { "tags": [ "BankAccount" ], "operationId": "getBankTransactions", "parameters": [ { "name": "accountId", "in": "path", "description": "ID des Accounts", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-bank-BankTransaction" } } } } } } } }, "/erp/bank/accounts/{accountId}/transactions/{transactionId}": { "get": { "tags": [ "BankAccount" ], "operationId": "getBankTransaction", "parameters": [ { "name": "accountId", "in": "path", "description": "ID des Accounts", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "transactionId", "in": "path", "description": "ID der Transaktion", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankTransaction" } } } } } } }, "/erp/bank/accounts/{accountId}/balance_at_date/{date}": { "get": { "tags": [ "BankAccount" ], "operationId": "getBalanceAtDate", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "date", "in": "path", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } } } } }, "/erp/articles/{refId}/workflow-state": { "get": { "tags": [ "Article" ], "summary": "Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz", "operationId": "getWorkflowState_3", "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" ] } } } } } } }, "/erp/articles/{refId}/workflow-instances-preset": { "get": { "tags": [ "Article" ], "summary": "Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz", "operationId": "getWorkflowInstancesPreset_3", "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" } } } } } } }, "/erp/articles/{refId}/latest-workflow-instance": { "get": { "tags": [ "Article" ], "summary": "Liefert die neuste Workflow-Instanz zu der gegebenen Referenz", "operationId": "getLatestWorkflowInstance_3", "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" } } } } } } }, "/erp/articles/{id}/ui-hints": { "get": { "tags": [ "Article" ], "summary": "find all active ui hints of one article", "operationId": "queryUiHints", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/articles/{id}/storages": { "get": { "tags": [ "ArticleStorage" ], "operationId": "getArticleStorages", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-stock-ArticleStorage" } } } } } } } }, "/erp/articles/{id}/storages/{storageId}/stocks": { "get": { "tags": [ "ArticleStorage" ], "operationId": "getArticleStorageStocks", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "storageId", "in": "path", "description": "ID 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-Stock" } } } } } } } }, "/erp/articles/{id}/storage-movements": { "get": { "tags": [ "ArticleStorage" ], "operationId": "getArticleStorageMovement", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-ArticleStorageMovement" } } } } } } }, "/erp/articles/{id}/stocks": { "get": { "tags": [ "ArticleStorage" ], "operationId": "getArticleStock", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "salesChannelId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-ArticleStock" } } } } } } }, "/erp/articles/{id}/products": { "get": { "tags": [ "Article" ], "operationId": "getProductByArticleId", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Product" } } } } } } }, "/erp/articles/{id}/bundle-merge-or-dissolve-info": { "get": { "tags": [ "ArticleStorage" ], "operationId": "getArticleBundleMergeDissolveInfo", "parameters": [ { "name": "id", "in": "path", "description": "ID of Article", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleBundleMergeDissolveInfo" } } } } } } }, "/erp/articles/variables": { "get": { "tags": [ "Article" ], "operationId": "queryVariables_1", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-cunit-CuAttribute" } } } } } } } }, "/erp/articles/serial-numbers/process-code/{code}": { "get": { "tags": [ "SerialNumber" ], "operationId": "processCode", "parameters": [ { "name": "code", "in": "path", "description": "Code (z.B. GS1 oder HIBC", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" } } } } } } }, "/erp/articles/print-labels/candidates": { "get": { "tags": [ "Article" ], "summary": "Erstellt entweder eine Etikettendruck-Vorschau zu einem Beleg oder einem Artikel", "operationId": "createPrintOrderPreview", "parameters": [ { "name": "documentId", "in": "query", "description": "Beleg", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "articleId", "in": "query", "description": "Artikel", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ArticlePrintLabelOrderResponse" } } } } } } } }, "/erp/accounts/{accountId}/non_marked_duplicates": { "get": { "tags": [ "account" ], "operationId": "findNonMarkedDuplicatesByAccountId", "parameters": [ { "name": "accountId", "in": "path", "description": "account identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-account-AccountDuplicate" } } } } } } } }, "/erp/accounts/{accountId}/duplicates": { "get": { "tags": [ "account" ], "operationId": "findDuplicatesByAccountId", "parameters": [ { "name": "accountId", "in": "path", "description": "account identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-account-AccountDuplicate" } } } } } } } }, "/erp/accounts/duplicates/{id}": { "get": { "tags": [ "account" ], "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-account-AccountDuplicate" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/account-types": { "get": { "tags": [ "AccountType" ], "operationId": "get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "CUSTOMER", "SUPPLIER", "SERVICE_PROVIDER", "MERCHANT", "SALES_AGENT", "COMPANY", "PROSPECTIVE" ] } } } } } } } }, "/dms/resources/{uuid}/fileUUID": { "get": { "tags": [ "Documents" ], "summary": "Download File using a UUID", "operationId": "downloadFileByUUID", "parameters": [ { "name": "uuid", "in": "path", "description": "UUID der DMS-Ressource", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "disposition", "in": "query", "description": "optional: gew\u00fcnschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response with download-url", "content": { "application/json": { "schema": { "type": "object" } } } }, "303": { "description": "Location attribute contains alternate download location", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/dms/resources/{id}/transformations/{transformationId}/file": { "get": { "tags": [ "Image Transformations" ], "summary": "download the transformed image", "operationId": "downloadTransformedFile", "parameters": [ { "name": "id", "in": "path", "description": "image id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "transformationId", "in": "path", "description": "transformationId", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "disposition", "in": "query", "description": "optional: gew\u00fcnschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response with download-url", "content": { "application/json": { "schema": { "type": "object" } }, "application/*": { "schema": { "type": "object" } } } }, "303": { "description": "Location attribute contains alternate download location", "content": { "application/json": { "schema": { "type": "object" } }, "application/*": { "schema": { "type": "object" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } }, "application/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } }, "application/*": { "schema": { "type": "object" } } } } } } }, "/dms/resources/{id}/revisions": { "get": { "tags": [ "Documents" ], "summary": "get metadata of all files for a document in revision order", "operationId": "getFiles", "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/dms-shelf-ShelfFile" } } } } } } } }, "/dms/resources/{id}/protocol": { "get": { "tags": [ "Documents" ], "summary": "get the protocol of all changes on the document in chronological order", "operationId": "getProtocol", "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/dms-shelf-ShelfDocumentProtocol" } } } } } } } }, "/dms/resources/{alias}/alias": { "get": { "tags": [ "Documents" ], "summary": "download the original or transformed document file by alias", "operationId": "handleFileDownloadByAlias", "parameters": [ { "name": "alias", "in": "path", "description": "Alias der DMS-Ressource", "required": true, "schema": { "type": "string" } }, { "name": "disposition", "in": "query", "description": "optional: gew\u00fcnschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response with download-url", "content": { "application/json": { "schema": { "type": "object" } } } }, "303": { "description": "Location attribute contains alternate download location", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/dms/resources/file/{shelfId}/file": { "get": { "tags": [ "Documents" ], "summary": "get ShelfFile by ShelfFile-ID", "operationId": "findByShelfId", "parameters": [ { "name": "shelfId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "disposition", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response with download-url", "content": { "application/json": { "schema": { "type": "object" } } } }, "303": { "description": "Location attribute contains alternate download location", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/dms/resources/file/{shelfFileId}/entries": { "get": { "tags": [ "Documents" ], "summary": "get Subfiles from ShelfFile by ShelfFileId", "operationId": "findBySubFileId", "parameters": [ { "name": "shelfFileId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/dms-shelf-SubFileInfo" } } } } } } } }, "/dms/resources/file/{shelfFileId}/entries/{subFileId}/file": { "get": { "tags": [ "Documents" ], "summary": "get SubFile as Source from ShelfFIle", "operationId": "findSubFileByShelfIdAndName", "parameters": [ { "name": "shelfFileId", "in": "path", "description": "ID der shelfFile", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "subFileId", "in": "path", "description": "ID der subFile", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "disposition", "in": "query", "description": "optional: gew\u00fcnschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Response with download-url", "content": { "application/json": { "schema": { "type": "object" } } } }, "303": { "description": "Location attribute contains alternate download location", "content": { "application/json": { "schema": { "type": "object" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/dms/resources/byRef": { "get": { "tags": [ "Documents" ], "summary": "get shelf documents by reference type and id", "operationId": "findByRefTypeAndRefId", "parameters": [ { "name": "refType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "refId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfDocument" } } } } } } } }, "/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" ] } } } } } } }, "/erp/finance/booking/{id}": { "get": { "tags": [ "FinanceBooking" ], "operationId": "getById_96", "parameters": [ { "name": "id", "in": "path", "description": "id of booking run", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBookingRun" } } } } } } }, "/erp/finance/booking/check/document/{id}": { "get": { "tags": [ "FinanceBooking" ], "operationId": "simulateBookingsByDocumentId", "parameters": [ { "name": "id", "in": "path", "description": "id of document", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-FinanceBooking" } } } } } } }, "/erp/finance/booking/check": { "get": { "tags": [ "FinanceBooking" ], "operationId": "check_1", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "boolean" } } } } } } }, "/erp/crm-tasks/{refId}/workflow-state": { "get": { "tags": [ "Aufgaben" ], "summary": "Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz", "operationId": "getWorkflowState_4", "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" ] } } } } } } }, "/erp/crm-tasks/{refId}/workflow-instances-preset": { "get": { "tags": [ "Aufgaben" ], "summary": "Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz", "operationId": "getWorkflowInstancesPreset_4", "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" } } } } } } }, "/erp/crm-tasks/{refId}/latest-workflow-instance": { "get": { "tags": [ "Aufgaben" ], "summary": "Liefert die neuste Workflow-Instanz zu der gegebenen Referenz", "operationId": "getLatestWorkflowInstance_4", "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" } } } } } } }, "/erp/crm-tasks/{id}/reminders": { "get": { "tags": [ "Aufgaben" ], "operationId": "getReminders", "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" } } } } } } } }, "/erp/crm-tasks/reminders": { "get": { "tags": [ "Aufgaben" ], "operationId": "getAllReminders", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmReminder" } } } } } } } }, "/erp/crm-projects/{refId}/workflow-state": { "get": { "tags": [ "Projekte" ], "summary": "Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz", "operationId": "getWorkflowState_5", "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" ] } } } } } } }, "/erp/crm-projects/{refId}/workflow-instances-preset": { "get": { "tags": [ "Projekte" ], "summary": "Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz", "operationId": "getWorkflowInstancesPreset_5", "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" } } } } } } }, "/erp/crm-projects/{refId}/latest-workflow-instance": { "get": { "tags": [ "Projekte" ], "summary": "Liefert die neuste Workflow-Instanz zu der gegebenen Referenz", "operationId": "getLatestWorkflowInstance_5", "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" } } } } } } }, "/erp/crm-projects/{id}/reminders": { "get": { "tags": [ "Projekte" ], "operationId": "getReminders_1", "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" } } } } } } } }, "/erp/crm-projects/reminders": { "get": { "tags": [ "Projekte" ], "operationId": "getAllReminders_1", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmReminder" } } } } } } } }, "/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" ] } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/erp/crm-deals/{id}/subscription": { "get": { "tags": [ "Deals" ], "summary": "Liefert alle Subscription auf dem Gesch\u00e4ftsobjekt", "operationId": "getSubscriber", "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" } } } } } } } }, "/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" } } } } } } } }, "/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" } } } } } } } }, "/erp/accounts/{refId}/workflow-state": { "get": { "tags": [ "account" ], "summary": "Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz", "operationId": "getWorkflowState_7", "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" ] } } } } } } }, "/erp/accounts/{refId}/workflow-instances-preset": { "get": { "tags": [ "account" ], "summary": "Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz", "operationId": "getWorkflowInstancesPreset_7", "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" } } } } } } }, "/erp/accounts/{refId}/latest-workflow-instance": { "get": { "tags": [ "account" ], "summary": "Liefert die neuste Workflow-Instanz zu der gegebenen Referenz", "operationId": "getLatestWorkflowInstance_7", "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" } } } } } } }, "/erp/accounts/{id}/ui-hints": { "get": { "tags": [ "account" ], "summary": "find all active ui hints of one account", "operationId": "queryUiHints_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/accounts/{id}/subscription": { "get": { "tags": [ "account" ], "summary": "Liefert alle Subscription auf dem Gesch\u00e4ftsobjekt", "operationId": "getSubscriber_1", "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" } } } } } } } }, "/erp/accounts/{id}/addresses/{addressId}/tax-id-protocol/{taxIdProtocolId}": { "get": { "tags": [ "account" ], "operationId": "getSingleTaxIdProtocol", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "addressId", "in": "path", "description": "identifier of address", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taxIdProtocolId", "in": "path", "description": "identifier of tax id protocol", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-TaxIDProtocol" } } } } } } }, "/erp/accounts/{id}/addresses/{addressId}/tax-id-protocol": { "get": { "tags": [ "account" ], "operationId": "queryAccountAddressTaxIdProtocol", "parameters": [ { "name": "id", "in": "path", "description": "identifier of account", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "addressId", "in": "path", "description": "identifier of address", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-account-TaxIDProtocol" } } } } } } } }, "/cmn/system/app-message-webhook/destinations": { "get": { "tags": [ "app-message-webhook-resource" ], "summary": "list all available webhook-queues", "operationId": "getDestinations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-system-QueueDestinationDescription" } } } } } } } }, "/cmn/scripting/script/runs/{runId}": { "get": { "tags": [ "script-resource" ], "operationId": "getRunById", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-scripting-ScriptRun" } } } } } } }, "/cmn/scripting/script/module/{module}/script-context-description": { "get": { "tags": [ "script-resource" ], "operationId": "getScriptContextDescription", "parameters": [ { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-scripting-ScriptDescription" } } } } } } }, "/cmn/scripting/script/module": { "get": { "tags": [ "script-resource" ], "operationId": "getModules", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/cmn/output/queue/{id}": { "get": { "tags": [ "Output-Queue" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_107", "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-OutputQueue" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/eav-groups/{id}/is-used": { "get": { "tags": [ "EavGroup" ], "summary": "check if the group is in use e.g contains valid content in associated entities", "operationId": "isGroupInUse", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/cmn/eav-groups/{id}/attribute/{attributeId}/is-used": { "get": { "tags": [ "EavGroup" ], "summary": "check if the attribute is in use contains valid content in associated entities", "operationId": "isAttributeInUse", "parameters": [ { "name": "id", "in": "path", "description": "group-id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "attributeId", "in": "path", "description": "attribute-id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } } } } }, "/cmn/eav-groups/entities": { "get": { "tags": [ "EavGroup" ], "summary": "return all custom field ids", "operationId": "getAllCustomFieldIds", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-eav-EavEntityRef" } } } } } } } }, "/cmn/eav-groups/by-key/{groupKey}": { "get": { "tags": [ "EavGroup" ], "summary": "return group by key", "operationId": "isGroupInUseByKey", "parameters": [ { "name": "groupKey", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-eav-EavGroup" } } } } } } }, "/cmn/workflows/{id}/script-context-description": { "get": { "tags": [ "Workflow" ], "operationId": "getScriptDescription_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "elementType", "in": "query", "required": true, "schema": { "type": "string", "description": "Gibt an, um welche Art von Element es sich bei einem WorkflowElement handelt", "enum": [ "START_EVENT", "INTERMEDIATE_EVENT", "END_EVENT_SUCCESS", "END_EVENT_ERROR", "USER_TASK", "SCRIPT_TASK", "EXCLUSIVE_SPLIT_GATEWAY", "EXCLUSIVE_JOIN_GATEWAY", "PARALLEL_JOIN_GATEWAY", "TIMER", "SUB_WORKFLOW" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-scripting-ScriptDescription" } } } } } } }, "/cmn/workflows/{id}/export": { "get": { "tags": [ "Workflow" ], "operationId": "exportWorkflow", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } } } } } }, "/cmn/workflows/{id}/editable-copy": { "get": { "tags": [ "Workflow" ], "operationId": "getEditableCopy", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-workflow-Workflow" } } } } } } }, "/cmn/workflows/triggers": { "get": { "tags": [ "Workflow" ], "operationId": "getTriggers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-workflow-WorkflowTriggerDto" } } } } } } } }, "/cmn/workflows/search-dialogs": { "get": { "tags": [ "Workflow" ], "operationId": "getSearchDialogs", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-cunit-SearchDialogWithIdentifier" } } } } } } } }, "/cmn/workflow-instances/{id}": { "get": { "tags": [ "WorkflowInstance" ], "operationId": "getById_114", "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" } } } } } } }, "/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" ] } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } }, "/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" } } } } } } } }, "/cmn/users": { "get": { "tags": [ "User" ], "summary": "Provides all Users (without hidden buildin users)", "operationId": "getUsers", "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-user-User" } } } } } } } }, "/cmn/users/{id}/messages/count": { "get": { "tags": [ "User Message" ], "summary": "return message count for specific user", "operationId": "getMessageCount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SEEN", "NOT_SEEN" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/cmn/users/{id}/available-permissions": { "get": { "tags": [ "User" ], "summary": "Provides all roles defined in the system that are feasible for the given user", "operationId": "availablePermission", "parameters": [ { "name": "id", "in": "path", "description": "user id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-user-RolePermission" } } } } } } } }, "/cmn/users/roles/permissions": { "get": { "tags": [ "Role" ], "summary": "Provides all roles defined in the system", "operationId": "permissions", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-user-RolePermission" } } } } } } } }, "/cmn/users/me": { "get": { "tags": [ "User" ], "summary": "Provides the current user", "operationId": "getMe", "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-MeResponse" } } } } } } }, "/cmn/users/me/settings": { "get": { "tags": [ "User" ], "operationId": "allSettings", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-user-UserSetting" } } } } } } } }, "/cmn/users/me/messages/count": { "get": { "tags": [ "User Message" ], "summary": "return message count for user", "operationId": "getMyMessageCount", "parameters": [ { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "SEEN", "NOT_SEEN" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/cmn/users/me/authorization": { "get": { "tags": [ "User" ], "summary": "Provides the authorizations for the current user", "operationId": "getMyAuthorizations", "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-user-UserPermissionRead" } } } } } } }, "/cmn/users/me/authorization/{resource}": { "get": { "tags": [ "User" ], "summary": "Provides the authorizations of a given resource for the current user", "operationId": "getMyAppPermissions", "parameters": [ { "name": "resource", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-user-RolePermission" } } } } } } } }, "/cmn/users/all": { "get": { "tags": [ "User" ], "summary": "Provides all Users (without hidden buildin users)", "operationId": "getAllUsers", "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } } } } } } }, "/cmn/unit-type-ratio/convert/from/{sourceTypeAbbreviation}/to/{targetTypeAbbreviation}": { "get": { "tags": [ "UnitTypeRatio" ], "operationId": "convertUnits", "parameters": [ { "name": "value", "in": "query", "required": true, "schema": { "type": "number" } }, { "name": "sourceTypeAbbreviation", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "targetTypeAbbreviation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number" } } } } } } }, "/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" } } } } } } } }, "/cmn/text/variables/{domain}": { "get": { "tags": [ "Text" ], "operationId": "getAttributesForDomain", "parameters": [ { "name": "domain", "in": "path", "description": "domain identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-cunit-CuAttribute" } } } } } } } }, "/cmn/text/variables/domains/identifier": { "get": { "tags": [ "Text" ], "operationId": "getDomains", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/cmn/text/baseHolder/byKey/{key}": { "get": { "tags": [ "query-base-holder-preset-resource" ], "operationId": "findByKey", "parameters": [ { "name": "key", "in": "path", "description": "queryBaseHolder identifier", "required": true, "schema": { "type": "string", "enum": [ "ACCOUNT", "ARTICLE", "BANK", "BANK_TRANSACTION", "DOCUMENT", "DOCUMENT_LINE", "DUNNING", "MANDATE", "OPENITEM", "SHIPPED_DOCUMENT", "POS_REGISTER", "CASH_DRAWER", "POS_PAYMENT_METHOD", "POS_DEPOSIT_EXPENSE_TYPE" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryBaseHolderPreset" } } } } } } }, "/cmn/text/baseHolder/all/presets": { "get": { "tags": [ "query-base-holder-preset-resource" ], "operationId": "findAll_1", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-text-QueryBaseHolderPresetEntity" } } } } } } } }, "/cmn/task/{id}/log/{logId}": { "get": { "tags": [ "Task" ], "operationId": "getLogById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-task-TaskLog" } } } } } }, "delete": { "tags": [ "Task" ], "operationId": "deleteLog", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "logId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/task/support": { "get": { "tags": [ "Task" ], "summary": "liefert alle 'supportf\u00e4higen' Tasks", "operationId": "getAllSupportTasks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-task-SupportTask" } } } } } } } }, "/cmn/task/support/{identifier}/parameter-meta": { "get": { "tags": [ "Task" ], "summary": "liefert die Parameterstruktur f\u00fcr einen Task", "operationId": "getParameterMeta", "parameters": [ { "name": "identifier", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/cmn/systems/messages/": { "get": { "tags": [ "System" ], "operationId": "getCodes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } } } } } }, "/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" } } } } } } } }, "/cmn/sequencer/{id}/pool/{groupKey}": { "get": { "tags": [ "Sequencer" ], "operationId": "getSequencePool", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "groupKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-sequencer-PooledSequence" } } } } } } } }, "/cmn/sequencer/{id}/next-value/{groupKey}": { "get": { "tags": [ "Sequencer" ], "operationId": "getNextValue", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "groupKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/cmn/sequencer/{id}/last-value/{groupKey}": { "get": { "tags": [ "Sequencer" ], "operationId": "getLastValue", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "groupKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/cmn/sequencer/sequences": { "get": { "tags": [ "Sequencer" ], "operationId": "getAllSequences", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-sequencer-Sequence" } } } } } } } }, "/cmn/sequencer/free/{id}/peek/": { "get": { "tags": [ "FreeSequencer" ], "operationId": "getPeekValue", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/cmn/sequencer/free/{id}/next-value/": { "get": { "tags": [ "FreeSequencer" ], "operationId": "getNextValue_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/cmn/sequencer/free/sequences": { "get": { "tags": [ "FreeSequencer" ], "operationId": "getAllSequences_1", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-sequencer-FreeSequence" } } } } } } } }, "/cmn/parameters/meta": { "get": { "tags": [ "Parameter" ], "operationId": "listAllParameters", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-unknownmodule-ParameterSourceRef" } } } } } } } }, "/cmn/parameters/meta/{key}": { "get": { "tags": [ "Parameter" ], "operationId": "listParameter", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/cmn/parameters/": { "get": { "tags": [ "Parameter" ], "operationId": "read_1", "parameters": [ { "name": "key", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } }, "/cmn/output/subscription": { "get": { "tags": [ "Output-Module" ], "operationId": "getPossibleSubscription", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-observer-PossibleSubscription" } } } } } } } }, "/cmn/output/reports/{id}/template-configuration-meta": { "get": { "tags": [ "Output-Module" ], "operationId": "getTemplateConfigurationMeta", "parameters": [ { "name": "id", "in": "path", "description": "report identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/cmn/output/reports/{id}/resource": { "get": { "tags": [ "Output-Module" ], "operationId": "getReportTemplateRef", "parameters": [ { "name": "id", "in": "path", "description": "report identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-ReportTemplateResponse" } } } } } } }, "/cmn/output/reports/{alias}/by-resource-alias": { "get": { "tags": [ "Output-Module" ], "operationId": "getReportTemplateRef_1", "parameters": [ { "name": "alias", "in": "path", "description": "report identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-ReportTemplateResponse" } } } } } } }, "/cmn/output/report-types/{id}": { "get": { "tags": [ "Output-Module" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_129", "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-output-OutputReportType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/output/modules": { "get": { "tags": [ "Output-Module" ], "operationId": "getModuleInfos", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-output-OutputModuleInfo" } } } } } } } }, "/cmn/output/modules/{moduleKey}/template-factory-meta": { "get": { "tags": [ "Output-Module" ], "description": "liefert die Parameter um das Template zu bauen", "operationId": "getTemplateFactoryMeta", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/cmn/output/modules/{moduleKey}/rule-meta": { "get": { "tags": [ "Output-Module" ], "description": "liefert die Regel-Struktur des Reports/Ausgabe", "operationId": "getRuleMeta", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/cmn/output/modules/{moduleKey}/parameter-value": { "get": { "tags": [ "Output-Module" ], "description": "liefert die Report-Parameter, die f\u00fcr das Layout gebraucht werden", "operationId": "getReportParameter", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } }, "/cmn/output/modules/{moduleKey}/parameter-meta": { "get": { "tags": [ "Output-Module" ], "description": "liefert die Parameter-Struktur des Reports", "operationId": "getParameterMeta_1", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/cmn/leasable-locks": { "get": { "tags": [ "LeasableLock" ], "operationId": "getAllActiveLocks", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-locknlease-LeasableLockDto" } } } } } } } }, "/cmn/ft-search": { "get": { "tags": [ "FulltextSearch" ], "summary": "Find the Resource by query-parameters", "operationId": "query_1", "parameters": [ { "name": "words", "in": "query", "description": "terms to search for", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "types", "in": "query", "description": "types to search into", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "grouped", "in": "query", "description": "should the result be grouped by types", "required": false, "style": "form", "schema": { "type": "boolean" } }, { "name": "_limit", "in": "query", "description": "max number of search results (per group, if grouped == true)", "required": false, "style": "form", "schema": { "type": "integer" } }, { "name": "_start", "in": "query", "description": "Offset", "required": false, "style": "form", "schema": { "type": "integer" } }, { "name": "mode", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "EXACT", "DISTINCT_MATCH_COUNT", "FREQUENCY" ] } }, { "name": "perspective", "in": "query", "description": "Perspective of result", "required": false, "style": "form", "schema": { "type": "string" } } ], "responses": { "422": { "description": "query was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-ftsearch-SearchResult" } } } } } } } }, "/cmn/ft-search/types": { "get": { "tags": [ "FulltextSearch" ], "summary": "return all available types", "operationId": "getAvailableTypes", "parameters": [ { "name": "indexable", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } } } } } }, "/cmn/ft-search/types/statistics": { "get": { "tags": [ "FulltextSearch" ], "operationId": "getStatisticTypes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-fulltext-SearchEntryStatistics" } } } } } } } }, "/cmn/ft-search/find-first": { "get": { "tags": [ "FulltextSearch" ], "summary": "unstructured search", "operationId": "fetchFirstOnly", "parameters": [ { "name": "words", "in": "query", "description": "terms to search for", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "types", "in": "query", "description": "types to search into", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "perspective", "in": "query", "description": "Perspective of result", "required": false, "style": "form", "schema": { "type": "string" } } ], "responses": { "422": { "description": "query was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-ftsearch-SearchResult" } } } } } } }, "/cmn/emails/failures/{failureId}": { "get": { "tags": [ "email-list-resource" ], "operationId": "getEmailFailure", "parameters": [ { "name": "failureId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-email-EmailFailure" } } } } } } }, "/cmn/data-import/runs/single/{id}/script-context-description": { "get": { "tags": [ "ImportRun" ], "operationId": "getScriptingDescription", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-scripting-ScriptDescription" } } } } } } }, "/cmn/data-import/runs/single/{id}/entries": { "get": { "tags": [ "ImportRun" ], "operationId": "getEntries", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "states", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "NOT_YET_RUN", "ERRONEOUS", "SUCCESSFUL", "IGNORED", "OUT_OF_BOUNDS", "MANUALLY_IGNORED", "MANUALLY_COMPLETED" ] } } }, { "name": "validationStates", "in": "query", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "enum": [ "NOT_YET_RUN", "ERRONEOUS", "SUCCESSFUL", "IGNORED", "OUT_OF_BOUNDS", "MANUALLY_IGNORED", "MANUALLY_COMPLETED" ] } } }, { "name": "_limit", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "_start", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "applyTransformations", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-data_import-DataImportEntry" } } } } } } } }, "/cmn/data-import/runs/single/supported-file-formats": { "get": { "tags": [ "ImportRun" ], "operationId": "getSupportedFileFormats", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/cmn/data-import/runs/multi-part/{id}/extensive": { "get": { "tags": [ "MultiPartImport" ], "operationId": "getByIdExtensive", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-MultiPartImportRunExtensive" } } } } } } }, "/cmn/data-import/runs/multi-part/{id}/copy": { "get": { "tags": [ "MultiPartImport" ], "operationId": "getCopy", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "asTemplate", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "label", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-MultiPartImportRun" } } } } } } }, "/cmn/data-import/rule-sets/{id}/target-fields": { "get": { "tags": [ "ImportRuleSet" ], "operationId": "getAccessibleFields", "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-data_import-BatchProcessingTargetFieldApi" } } } } } } } }, "/cmn/data-import/rule-sets/{id}/copy": { "get": { "tags": [ "ImportRuleSet" ], "operationId": "getCopy_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" } } } } } } }, "/cmn/data-import/rule-sets/module/{moduleKey}/target-fields": { "get": { "tags": [ "ImportRuleSet" ], "operationId": "getAccessibleFields_1", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-data_import-BatchProcessingTargetFieldApi" } } } } } } } }, "/cmn/data-import/rule-sets/importable-types": { "get": { "tags": [ "ImportRuleSet" ], "operationId": "getImportableTypes", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-data_import-ImportModuleInformation" } } } } } } } }, "/cmn/computed-queries": { "get": { "tags": [ "computed-queries" ], "operationId": "listGroups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-cunit-CuTemplateGroup" } } } } } } } }, "/cmn/computed-queries/{group-key}": { "get": { "tags": [ "computed-queries" ], "operationId": "listTemplates", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-cunit-CuTemplate" } } } } } } } }, "/cmn/computed-queries/{group-key}/{id}/presets/{presetId}/validate": { "get": { "tags": [ "computed-queries" ], "operationId": "validatePreset", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "presetId", "in": "path", "description": "Filter-Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "forAdmin", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "forWorkflow", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPresetValidationResult" } } } } } } }, "/cmn/computed-queries/{group-key}/{id}/fields": { "get": { "tags": [ "computed-queries" ], "operationId": "getTemplateFields", "parameters": [ { "name": "group-key", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filterable", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "resultable", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "verbose", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "visibility", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "INTERNAL", "SUPPORT", "API", "PUBLIC" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-cunit-CuAttributes" } } } } } } }, "/cmn/computed-queries/workflow-presets": { "get": { "tags": [ "computed-queries" ], "operationId": "getAllWorkflowPresets", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-cunit-QueryPreset" } } } } } } } }, "/cmn/computed-queries/workflow-presets/{id}": { "get": { "tags": [ "computed-queries" ], "operationId": "getWorkflowPresetById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-QueryPreset" } } } } } } }, "/cmn/computed-queries/dialect-info": { "get": { "tags": [ "computed-queries" ], "operationId": "listDefaults", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-cunit-CuDialect" } } } } } } }, "/cmn/audit/snapshot/{id}": { "get": { "tags": [ "\u00c4nderungsprotokoll" ], "operationId": "restore", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } } } } } }, "/cmn/audit/snapshot/{id}/with-previous": { "get": { "tags": [ "\u00c4nderungsprotokoll" ], "operationId": "restoreWithPrevious", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-audit-SnapshotAndPredecessorApi" } } } } } } }, "/cmn/atm-history": { "get": { "tags": [ "ATM" ], "operationId": "findAll_2", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-api-AfterTenantMigrationActionExecutionHistory" } } } } } } } }, "/cmn/apps/installed": { "get": { "tags": [ "tenant-app-resource" ], "operationId": "getInstalledApps", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/node-nodemaster-InstalledApp" } } } } } } } }, "/banking/banking-user/{userId}/get_external_user/{bankingProviderId}": { "get": { "tags": [ "BankingUser" ], "operationId": "getExternalUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "bankingProviderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/banking-api-BankingUser" } } } } } } }, "/banking/banking-user/{userId}/check_login_with_user": { "get": { "tags": [ "BankingUser" ], "summary": "Checks if the connector can connect", "operationId": "checkLoginWithUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/banking/banking-user/{id}": { "get": { "tags": [ "BankingUser" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_141", "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/banking-api-BankingUser" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "BankingUser" ], "summary": "Delete an existing Resource", "operationId": "delete_116", "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" } } } } } } }, "/banking/banking-user/users": { "get": { "tags": [ "BankingUser" ], "operationId": "findAll_3", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/banking-api-BankingUser" } } } } } } } }, "/banking/banking-user/get_users_for_bank/{bankId}": { "get": { "tags": [ "BankingUser" ], "operationId": "getUsersForBank", "parameters": [ { "name": "bankId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-user-User" } } } } } } } }, "/banking/banking-user/get_bankinguser/{accountId}": { "get": { "tags": [ "BankingUser" ], "operationId": "getBankingUserForAccountId", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/banking-api-BankingUser" } } } } } } } }, "/banking/banking-provider/{bankingProviderId}/check_login": { "get": { "tags": [ "BankingProvider" ], "summary": "Checks if the general parameters are correct", "operationId": "checkLogin", "parameters": [ { "name": "bankingProviderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/banking/banking-provider/meta/{key}": { "get": { "tags": [ "BankingProvider" ], "operationId": "getParameterMeta_2", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "FINAPI", "FINAPI_SANDBOX", "MOCKBANK" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/banking/bank-initializer": { "get": { "tags": [ "BankInitializer" ], "summary": "Get a list of banking providers", "operationId": "getKeys_1", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/banking-api-BankInitializerKey" } } } } } } } }, "/banking/bank-initializer/{key}/parameters": { "get": { "tags": [ "BankInitializer" ], "operationId": "getParameter_2", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "FINAPI", "FINAPI_SANDBOX", "MOCKBANK" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/banking-api-BankInitializerParameter" } } } } } } } }, "/app-traces": { "get": { "tags": [ "trace-resource" ], "operationId": "allTraces", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/app-traces/{key}": { "get": { "tags": [ "trace-resource" ], "operationId": "trace", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/node-event-TraceDump" } } } } } } }, "/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" } } } }, "/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" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/bank/accounts/{accountId}/delete_connection": { "delete": { "tags": [ "BankAccount" ], "operationId": "deleteConnection_1", "parameters": [ { "name": "accountId", "in": "path", "description": "ID des Accounts", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/articles/{id}/listings/{listingId}": { "delete": { "tags": [ "Article" ], "operationId": "deleteListing", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "listingId", "in": "path", "description": "a listing id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gew\u00fcnschte Sprache (z.B. de)", "style": "form", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/users/{userId}/messages/{id}": { "delete": { "tags": [ "User Message" ], "summary": "delete a message", "operationId": "deleteMessage", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/users/me/seen-messages": { "delete": { "tags": [ "User Message" ], "summary": "delete all seen messages", "operationId": "deleteMySeenMessages", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/users/me/all-messages": { "delete": { "tags": [ "User Message" ], "summary": "delete all messages", "operationId": "deleteMyMessages", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/leasable-locks/custom/{token}": { "delete": { "tags": [ "LeasableLock" ], "summary": "Gibt eine Sperre manuell frei, z.B. \u00fcber 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" } } } } } } }, "/banking/banking-webform/{id}": { "delete": { "tags": [ "BankingWebform" ], "summary": "Delete an existing Resource", "operationId": "delete_115", "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": { "common-task-TaskLogLine": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "logTime", "format": "date-time", "readOnly": true }, "origin": { "type": "string", "description": "log level", "readOnly": true, "enum": [ "DEBUG", "INFO", "WARNING", "ERROR", "CONSOLE", "STACKTRACE" ] }, "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } }, "description": "Abschluss-Protokoll" }, "core-api-ApiObjectReference": { "required": [ "id" ], "type": "object", "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 } }, "description": "custom related type" }, "core-api-LocalizeableMessage": { "type": "object", "properties": { "messageCode": { "type": "string", "description": "Internal unique identifier/key for this message" }, "messageParameters": { "type": "object", "additionalProperties": { "type": "object", "description": "list of parameters to fill a formattable message" }, "description": "list of parameters to fill a formattable message" }, "formattedMessage": { "type": "string", "description": "formatted message (default language)" } }, "description": "localizeable message" }, "core-api-MetaInfo": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "Created At Timestamp", "format": "date-time", "readOnly": true }, "createdFrom": { "type": "string", "description": "TenantUser-Identifier of the creator", "readOnly": true }, "updatedAt": { "type": "string", "description": "Last Updated AT Timestamp", "format": "date-time", "readOnly": true }, "updatedFrom": { "type": "string", "description": "TenantUser-Identifier of most recent updater", "readOnly": true } }, "description": "MetaInformations for this Object" }, "erp-document-DocumentRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64" }, "category": { "type": "string", "description": "Dokumenttypen", "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_CASH_RECEIPT_CANCELLATION", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ] }, "documentType": { "type": "string", "description": "Belegart" }, "documentState": { "type": "string", "description": "Belegstatus" }, "number": { "type": "string", "description": "Belegnummer" } }, "description": "Referenz auf ein Document" }, "erp-product-ArticleSerialNumber": { "required": [ "articleRef", "serialNumber1" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Seriennummer 1" }, "serialNumber2": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Seriennummer 2" }, "expiryDate": { "type": "string", "description": "Haltbarkeitsdatum", "format": "date" }, "note": { "type": "string", "description": "Notiz" }, "udi": { "type": "string", "description": "Unique Device Identifier (UDI)" } }, "description": "Seriennummer" }, "erp-stock-StorageBinRef": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64" }, "displayName": { "type": "string", "description": "Anzeigename" }, "color": { "type": "string", "description": "Anzeigefarbe" }, "storageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Lagerplatz" }, "erp-wms-ReplenishmentProposal": { "type": "object", "properties": { "version": { "type": "string", "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", "readOnly": true }, "state": { "type": "string", "description": "Status des Nachschubvorschlags", "readOnly": true, "enum": [ "OPEN", "FINISHED", "CANCELLED" ] }, "picklistRefs": { "type": "array", "description": "Nachschub-Picklisten", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "sourceDocumentRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "targetDocumentRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "finishLogLines": { "type": "array", "description": "Abschluss-Protokoll", "readOnly": true, "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" } }, "lines": { "type": "array", "description": "Positionen", "items": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalLine" } } }, "description": "Nachschubvorschlag" }, "erp-wms-ReplenishmentProposalLine": { "required": [ "articleRef", "proposedQuantity", "replenishedQuantity", "sourceStorageRef", "targetStorageRef" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "sourceStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "proposedQuantity": { "type": "number", "description": "Vorgeschlagene Menge", "readOnly": true }, "replenishedQuantity": { "type": "number", "description": "Tats\u00e4chliche Nachschubmenge" }, "bookings": { "type": "array", "description": "Buchungsdetails", "items": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalLineBooking" } } }, "description": "Position vom Nachschubvorschlag" }, "erp-wms-ReplenishmentProposalLineBooking": { "required": [ "quantity", "storageBinRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "storageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "quantity": { "type": "number", "description": "Menge" } }, "description": "Buchungsdetails vom Nachschubvorschlag" }, "core-error-ApiError": { "required": [ "decisions", "errors", "instance", "timeOfOccurence", "trackingId" ], "type": "object", "properties": { "instance": { "type": "string", "description": "the resource that produced the error", "readOnly": true }, "trackingId": { "type": "string", "description": "Internal tracking number for this Error", "readOnly": true }, "timeOfOccurence": { "type": "string", "description": "Internal timestamp, when this error happened", "format": "date-time", "readOnly": true }, "errors": { "$ref": "#/components/schemas/core-error-Errors" }, "decisions": { "uniqueItems": true, "type": "array", "description": "all decisions, we need to take care of", "readOnly": true, "items": { "$ref": "#/components/schemas/core-error-ApiErrorDecision" } }, "httpStatus": { "type": "integer", "description": "HTTP-Status code", "format": "int32" }, "debug-info-url": { "type": "string", "description": "optional url to get a more detailed stack trace", "format": "uri", "readOnly": true } } }, "core-error-ApiErrorDecision": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "title": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "multipleAnswersAllowed": { "type": "boolean", "description": "true, if an array of answers is required", "readOnly": true, "default": false }, "textInput": { "type": "boolean", "description": "true, if text input instead of decisions is required", "readOnly": true, "default": false }, "options": { "type": "array", "description": "possible options for this decision", "readOnly": true, "items": { "$ref": "#/components/schemas/core-error-DecisionOption" } }, "answerProperty": { "type": "string", "description": "property to fill the decision into", "readOnly": true }, "answerPropertyType": { "type": "string", "description": "type of the target property", "readOnly": true, "enum": [ "FIELD", "PARAMETER" ] }, "searchDialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "all decisions, we need to take care of", "readOnly": true }, "core-error-ApiErrorDetail": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "property": { "type": "string", "description": "property that has a constraint violation (optional)" } }, "description": "One or more generel service errors", "readOnly": true }, "core-error-DecisionOption": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "value": { "type": "string", "description": "value for this decision", "readOnly": true }, "defaultOption": { "type": "boolean", "description": "default option", "readOnly": true, "default": false }, "searchDialogs": { "type": "array", "description": "Zu verwendende Search-Dialogs", "readOnly": true, "items": { "$ref": "#/components/schemas/core-error-DecisionOptionSearchDialog" } } }, "description": "possible options for this decision" }, "core-error-DecisionOptionSearchDialog": { "type": "object", "properties": { "dialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "answerKey": { "type": "string", "description": "Schl\u00fcssel f\u00fcr das Ergebnis vom Search-Dialog", "readOnly": true } }, "description": "Zu verwendende Search-Dialogs" }, "core-error-Errors": { "required": [ "fieldErrors", "services" ], "type": "object", "properties": { "fieldErrors": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "One or more validation errors", "readOnly": true, "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } }, "description": "One or more validation errors", "readOnly": true }, "services": { "uniqueItems": true, "type": "array", "description": "One or more generel service errors", "readOnly": true, "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } } }, "description": "all occured errors", "readOnly": true }, "unknownservice-unknownmodule-JsonNode": { "type": "object", "description": "Search-Dialog" }, "erp-wms-ReplenishmentProposalTemplate": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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 der Vorlage" }, "description": { "type": "string", "description": "Beschreibung der Vorlage" }, "active": { "type": "boolean", "description": "Aktiv?" }, "cycleToCreateReplenishmentProposalCronExpression": { "type": "string", "description": "Zyklus zur Erstellung von Nachschubvorschl\u00e4gen (f\u00fcr Background-Jobs, als Quartz-Cron-Expression)" }, "alternativeSelectionInVql": { "type": "string", "description": "Alternative Selektion in VQL (Spalten: Artikel-ID, Lager-ID, Ziel-Menge)" }, "additionalExistsStatementsInVql": { "type": "array", "description": "Zus\u00e4tzliche Exists-Statements in VQL", "items": { "type": "string", "description": "Zus\u00e4tzliche Exists-Statements in VQL" } }, "targetStorageId": { "type": "integer", "description": "Bestimmtes Ziel-Lager f\u00fcr den Nachschubvorschlag", "format": "int64" }, "articleNumberFrom": { "type": "string", "description": "Artikel von" }, "articleNumberTo": { "type": "string", "description": "Artikel bis" }, "productGroupFrom": { "type": "string", "description": "Warengruppe von" }, "productGroupTo": { "type": "string", "description": "Warengruppe bis" }, "onlyArticlesWithSalesInNumberOfLastDays": { "type": "integer", "description": "Nur Artikel mit Verk\u00e4ufen in den letzten n Tagen", "format": "int32" }, "onlySalesStoragesAsTarget": { "type": "boolean", "description": "Nur Verkaufslager beachten", "default": false }, "considerReservedQuantities": { "type": "boolean", "description": "Reserviert-Mengen beachten", "default": false }, "considerOrderedQuantities": { "type": "boolean", "description": "Bestellt-Mengen beachten", "default": false }, "considerActualAvailableQuantities": { "type": "boolean", "description": "Tats\u00e4chliche verf\u00fcgbare Mengen beachten. Optionen zu Reserviert- und Bestellt-Mengen werden dabei nicht mehr beachtet, da diese Werte ggf. schon in die Verf\u00fcgbarkeitsermittlung eingeflossen sind", "default": true }, "sortByRoutePosition": { "type": "boolean", "description": "Positionen der Pickliste nach Laufwegposition sortieren", "default": true }, "specifyStorageBins": { "type": "boolean", "description": "Lagerpl\u00e4tze vorgeben", "default": true }, "specifySerialWithOldestExpiryDate": { "type": "boolean", "description": "Automatische Ermittlung von S/N oder Chargen sortiert \u00fcber das Verfallsdatum", "default": false }, "performStockTransferViaDocuments": { "type": "boolean", "description": "Umlagerung \u00fcber Belege durchf\u00fchren", "default": false } }, "description": "Vorlage zur Erstellung von Nachschubvorschl\u00e4gen" }, "erp-wms-PickTrolley": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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 Wagens" }, "description": { "type": "string", "description": "Beschreibung des Wagens" }, "identifier": { "type": "string", "description": "Barcode zur Selektion des Wagens" }, "type": { "type": "string", "description": "Pickwagen Typen", "enum": [ "FREE_COLLECTION", "FOR_ROLLING_ORDER_PICKING", "FOR_CONSOLIDATION" ] }, "state": { "type": "string", "description": "Status vom Pickwagen", "readOnly": true, "enum": [ "NOT_ACTIVE", "AVAILABLE", "CONTAINS_GOODS", "RESERVED_FOR_PICKLIST", "IN_PICKING", "PAUSED_IN_PICKING", "READY_FOR_PACKING", "IN_PACKING", "PAUSED_IN_PACKING", "READY_FOR_SHIPPING", "WAITING_FOR_SHIPPING_DOCUMENTS" ] }, "processedByUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "currentPicklistId": { "type": "integer", "description": "Wagen geh\u00f6rt aktuell zu dieser Pickliste", "format": "int64", "readOnly": true }, "pickTrolleyGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "storageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "pickTrolleyBoxes": { "type": "array", "description": "Zu diesem Wagen geh\u00f6rende Boxen", "items": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBox" } }, "picklistTemplateRefs": { "type": "array", "description": "Picklistenvorlagen, welche genutzt werden k\u00f6nnen, um in der MDE Picklisten zu dem Wagen zu erzeugen", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "description": "Pickwagen" }, "erp-wms-PickTrolleyBox": { "required": [ "label", "pickTrolleyId" ], "type": "object", "properties": { "version": { "type": "string", "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 Box" }, "description": { "type": "string", "description": "Beschreibung der Box" }, "identifier": { "type": "string", "description": "Barcode zur Selektion der Box" }, "state": { "type": "string", "description": "Status der Pickbox", "readOnly": true, "enum": [ "NOT_ACTIVE", "AVAILABLE", "RESERVED_FOR_ORDER", "IN_PICKING", "READY_FOR_PACKING", "READY_FOR_SHIPPING", "WAITING_FOR_DELIVERY_DOCUMENT_AND_SHIPPING_LABEL", "WAITING_FOR_DELIVERY_DOCUMENT", "WAITING_FOR_SHIPPING_LABEL" ] }, "currentDocumentId": { "type": "integer", "description": "Aktuell kommissionierter Beleg", "format": "int64" }, "pickTrolleyId": { "type": "integer", "description": "Box geh\u00f6rt zu diesem Pickwagen", "format": "int64" } }, "description": "Pickbox" }, "erp-wms-PickTrolleyGroup": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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 Gruppe" }, "description": { "type": "string", "description": "Beschreibung der Gruppe" }, "pickTrolleys": { "type": "array", "description": "Zur Gruppe geh\u00f6rende Pickwagen", "items": { "$ref": "#/components/schemas/erp-wms-PickTrolley" } } }, "description": "Pickwagen-Gruppe" }, "common-output-OutputRequest": { "type": "object", "properties": { "exportFormat": { "type": "string", "description": "output forma f\u00fcr mail/file-export", "enum": [ "PDF", "XLSX", "XLSX_RAW", "JSON_RAW", "REPORT_TEMPLATE" ] }, "exportFilename": { "type": "string", "description": "filename (ohne extension) bei einem file-export" }, "outputType": { "type": "string", "description": "outputType" }, "groupIdentifier": { "type": "string", "description": "OutputReportGroup Identifier (optional), sonst Default-Group des Moduls" }, "published": { "type": "boolean", "description": "sollen nur bereits ver\u00f6ffentlichte Dokumente beachtet werden?" } } }, "erp-wms-PicklistCancellationResult": { "type": "object", "properties": { "cancelledPicklistRefs": { "type": "array", "description": "IDs der stornierten Picklisten", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "pickTrolleyWithPickedGoodsRefs": { "type": "array", "description": "Pickwagen, die noch Waren enthalten", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "freedOrders": { "type": "array", "description": "Freigegebene Auftr\u00e4ge", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "description": "Ergebnis der Stornierung einer Pickliste" }, "erp-wms-DateRange": { "type": "object", "properties": { "from": { "type": "string", "description": "Datum von (ggf. als relatives Datum)" }, "to": { "type": "string", "description": "Datum bis (ggf. als relatives Datum)" }, "allowEmpty": { "type": "boolean", "description": "Datumsbereich darf leer sein", "default": true } }, "description": "Selektion \u00fcber einen Datumsbereich" }, "erp-wms-OrderSelectionOptions": { "type": "object", "properties": { "maxOrderCount": { "type": "integer", "description": "Nur f\u00fcr Einzelkommissionierung und Konsolidierung: maximale Anzahl zu \u00fcbernehmender Auftr\u00e4ge", "format": "int64" }, "alternativeSelectionInVql": { "type": "string", "description": "Alternative Selektion in VQL" }, "additionalExistsStatementsInVql": { "type": "array", "description": "Zus\u00e4tzliche Exists-Statements in VQL", "items": { "type": "string", "description": "Zus\u00e4tzliche Exists-Statements in VQL" } }, "deliveryMethodRefs": { "type": "array", "description": "Liste der g\u00fcltigen 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-DateRange" }, "deliveryDateRange": { "$ref": "#/components/schemas/erp-wms-DateRange" }, "confirmedDeliveryDateRange": { "$ref": "#/components/schemas/erp-wms-DateRange" }, "onlyFullDeliverableOrders": { "type": "boolean", "description": "Nur vollst\u00e4ndig lieferbare Auftr\u00e4ge", "default": false }, "onlyFullDeliverableOrderLines": { "type": "boolean", "description": "Nur vollst\u00e4ndig lieferbare Positionen", "default": false }, "storageAreaRefs": { "type": "array", "description": "Liste von g\u00fcltigen Lagerbereichen", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "minArticleCountPerOrder": { "type": "integer", "description": "Minimale Anzahl Artikel pro Auftrag", "format": "int32" }, "maxArticleCountPerOrder": { "type": "integer", "description": "Maximale Anzahl Artikel pro Auftrag", "format": "int32" }, "maxShippingWeightPerOrder": { "type": "number", "description": "Maximales Versandgewicht pro Auftrag" }, "maxTotalVolumePerOrderInCCM": { "type": "number", "description": "Maximales Gesamtvolumen pro Auftrag (in ccm)" }, "maxOrderValue": { "type": "number", "description": "Maximaler Auftragswert" } }, "description": "Optionen zur Selektion von Auftr\u00e4gen" }, "erp-wms-PicklistCreationOptions": { "type": "object", "properties": { "sortByRoutePosition": { "type": "boolean", "description": "Positionen der Pickliste nach Laufwegposition sortieren", "default": true }, "maxPicklistLineCount": { "type": "integer", "description": "Maximale Anzahl an Positionen einer Pickliste", "format": "int64" }, "maxQuantityOfOrderLineForFastOrderPicking": { "type": "integer", "description": "Maximale Menge einer Auftragsposition f\u00fcr Schnellkommissionierungs-Picklisten", "format": "int64", "default": 1 }, "orderPickingTrolleyRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "orderPickingTrolleyGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "useAllAvailOrderPickingTrolleys": { "type": "boolean", "description": "Sollen alle verf\u00fcgbaren Pickwagen verwendet werden?", "default": false }, "cycleToCreatePicklistsCronExpression": { "type": "string", "description": "Zyklus zur Erstellung von Picklisten (f\u00fcr Background-Jobs, als Quartz-Cron-Expression) (https://www.freeformatter.com/cron-expression-generator-quartz.html)" }, "specifyStorageBins": { "type": "boolean", "description": "Lagerpl\u00e4tze vorgeben", "default": true }, "specifySerialWithOldestExpiryDate": { "type": "boolean", "description": "F\u00fcr Serien-Artikel mit Verfallsdatum/MHD: \u00e4lteste Serie in Pickliste vorgeben", "default": false }, "firstCreateFastOrderPickingPicklists": { "type": "boolean", "description": "Sollen zuerst noch Picklisten f\u00fcr die Schnellkommissionierung erzeugt werden?", "default": false }, "fastOrderPickingTemplateToUseRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "printPicklist": { "type": "boolean", "description": "Soll die Pickliste gedruckt werden?", "default": false }, "picklistOutputReportGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Optionen zur Erstellung von Picklisten" }, "erp-wms-PicklistProcessingOptions": { "type": "object", "properties": { "autoPrintDeliveryDocument": { "type": "boolean", "description": "Soll die Lieferbelege automatisch nach Abschluss der Kommissionierung gedruckt werden?", "default": false }, "autoPrintShippingLabel": { "type": "boolean", "description": "Sollen die Paketlabel automatisch nach Abschluss der Kommissionierung gedruckt werden?", "default": false }, "allowOnlyScanOfArticles": { "type": "boolean", "description": "D\u00fcrfen Artikel nur per Scan (oder z.B. auch Eingabe der Artikelnummer) erfasst werden", "default": false }, "hideTargetQuantityInViews": { "type": "boolean", "description": "Zielmengen in Masken verstecken?", "default": false }, "allowPickingOfServiceArticles": { "type": "boolean", "description": "Sollen Dienstleistungen kommissioniert werden?", "default": false }, "allowPickingOfNonInventoryManagedArticles": { "type": "boolean", "description": "Sollen nicht-bestandsgef\u00fchrte Artikel kommissioniert werden?", "default": false }, "allowFullConfirmation": { "type": "boolean", "description": "Sammelbest\u00e4tigung erlauben", "default": false }, "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", "description": "Baugruppen als Ganzes kommissionieren", "default": false }, "alwaysShowDeliveryMethod": { "type": "boolean", "description": "Immer die Lieferbedingung in Masken zeigen", "default": true }, "showShippingFormOnPickingFinish": { "type": "boolean", "description": "Versand-Dialog beim Abschluss zeigen", "default": false }, "autoPickingFinishAfterLastArticleInOrder": { "type": "boolean", "description": "Automatischer Abschluss nach letztem Artikel vom aktuellen Auftrag", "default": false }, "useDigitalPicklist": { "type": "boolean", "description": "Digitale Pickliste verwenden: dabei werden nur die Positionen im Frontend gezeigt und durch Tippen oder Wischen best\u00e4tigt", "default": false }, "usePickNPack": { "type": "boolean", "description": "Pick'n'Pack verwenden", "default": false }, "scanDeliveryDocumentAndShippingLabelOnFinish": { "type": "boolean", "description": "Nur f\u00fcr Konsolidierung: Lieferbeleg und Versandlabel zum Abschluss scannen", "default": false } }, "description": "Optionen f\u00fcr die Verarbeitung von Picklisten" }, "erp-wms-PicklistScript": { "type": "object", "properties": { "source": { "type": "string", "description": "Der Quelltext vom Skript" }, "active": { "type": "boolean", "description": "Ist das Skript aktiv?", "default": false } }, "description": "Ein Picklisten-Skript" }, "erp-wms-PicklistTemplate": { "required": [ "label", "pickingType" ], "type": "object", "properties": { "version": { "type": "string", "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-PicklistCreationOptions" }, "orderSelectionOptions": { "$ref": "#/components/schemas/erp-wms-OrderSelectionOptions" }, "picklistProcessingOptions": { "$ref": "#/components/schemas/erp-wms-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" ] }, "defaultTemplate": { "type": "boolean", "description": "Handelt es sich um eine Standard-Vorlage?", "readOnly": true, "default": false }, "active": { "type": "boolean", "description": "Is Template active?", "readOnly": true, "default": true }, "picklistScripts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/erp-wms-PicklistScript" }, "description": "Skripte f\u00fcr die Erstellung und Verarbeitung von Picklisten" } } }, "erp-wms-Inventory": { "required": [ "deadline", "label", "storage", "type" ], "type": "object", "properties": { "version": { "type": "string", "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": "Inventurnummer", "readOnly": true }, "label": { "type": "string", "description": "Bezeichnung dieser Inventur" }, "description": { "type": "string", "description": "Beschreibung dieser Inventur" }, "type": { "type": "string", "description": "Inventurarten", "enum": [ "INITIAL", "CLOSING_DATE" ] }, "state": { "type": "string", "description": "Status der Inventur", "readOnly": true, "enum": [ "CREATED", "OPENED", "CLOSED", "FINISHED", "DELETED" ] }, "deadline": { "type": "string", "description": "Stichtag der Inventur", "format": "date" }, "currentRevision": { "type": "integer", "description": "Aktuelle Revision der Inventur", "format": "int32", "readOnly": true }, "storage": { "$ref": "#/components/schemas/erp-wms-InventoryStorage" } }, "description": "Inventurkopf" }, "erp-wms-InventoryStorage": { "required": [ "storageRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "storageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "inventoryStorageAreas": { "type": "array", "description": "Bestimmte Lagerbereiche des Lagers, welche dann nur gez\u00e4hlt werden sollen", "items": { "$ref": "#/components/schemas/erp-wms-InventoryStorageArea" } }, "inventoryStorageBins": { "type": "array", "description": "Bestimmte Lagerpl\u00e4tze des Lagers, welche dann nur gez\u00e4hlt werden sollen", "items": { "$ref": "#/components/schemas/erp-wms-InventoryStorageBin" } }, "areas": { "type": "array", "description": "F\u00fcr diese Inventur definitierte Bereiche im Lager (zur Unterscheidung der Z\u00e4hllisten", "items": { "type": "string", "description": "F\u00fcr diese Inventur definitierte Bereiche im Lager (zur Unterscheidung der Z\u00e4hllisten" } } }, "description": "Lager in der Inventur" }, "erp-wms-InventoryStorageArea": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "storageAreaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Lagerbereich in der Inventur" }, "erp-wms-InventoryStorageBin": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "storageBinRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Lagerplatz in der Inventur" }, "common-api-AdditionalParameter": { "required": [ "key" ], "type": "object", "properties": { "key": { "type": "string", "description": "key for this parameter" }, "value": { "type": "object", "description": "value for this parameter" } }, "description": "Zus\u00e4tzliche Parameter" }, "erp-wms-FoundArticleToBookIntoInventory": { "type": "object", "properties": { "articleId": { "type": "integer", "description": "ID vom nachzubuchenden Artikel", "format": "int64" }, "storageId": { "type": "integer", "description": "Nur ohne Lagerpl\u00e4tze: ID des Lagers, in dem sich der Artikel befinden soll", "format": "int64" }, "storageBinId": { "type": "integer", "description": "Nur bei Lagern mit Lagerpl\u00e4tzen: ID vom Lagerplatz, auf dem sich der Artikel befinden soll", "format": "int64" }, "serialNumberId": { "type": "integer", "description": "Ggf. die nachzubuchende Seriennummer", "format": "int64" }, "quantity": { "type": "number", "description": "Zu buchende Menge" } }, "description": "Gefundener Artikel der noch in eine Inventur gebucht werden soll" }, "erp-wms-InventoryStateTransitionRequest": { "type": "object", "properties": { "transitionId": { "type": "integer", "description": "ID der Transition", "format": "int64" }, "parameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter f\u00fcr die Transition", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } }, "foundArticlesToBookIntoInventory": { "type": "array", "description": "Nur f\u00fcr eine geschlossene Inventur: Liste von nachtr\u00e4glich gefundenen Artikeln, die noch nachgebucht werden sollen", "items": { "$ref": "#/components/schemas/erp-wms-FoundArticleToBookIntoInventory" } } }, "description": "Request zur State-Transition einer Inventur" }, "erp-wms-ArticleWithPurchasePrice": { "required": [ "articleId" ], "type": "object", "properties": { "articleId": { "type": "integer", "description": "Artikel", "format": "int64" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelname", "readOnly": true }, "articleDescription": { "type": "string", "description": "Artikelbeschreibung", "readOnly": true }, "purchasePrice": { "type": "number", "description": "Einkaufspreis des Artikels" } }, "description": "Artikel mit Einkaufspreis" }, "erp-wms-InventoryCounting": { "required": [ "articleId", "inventoryId", "quantity" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "inventoryId": { "type": "integer", "description": "Inventur", "format": "int64" }, "articleId": { "type": "integer", "description": "Artikel", "format": "int64" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelname", "readOnly": true }, "articleDescription": { "type": "string", "description": "Artikelbeschreibung", "readOnly": true }, "storageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "storageBinRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumberRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "areaToCount": { "type": "string", "description": "Bereich im Lager" }, "quantity": { "type": "number", "description": "Gez\u00e4hlte Menge" }, "revision": { "type": "integer", "description": "Revision der Z\u00e4hlung", "format": "int32", "readOnly": true }, "createdByFoundArticle": { "type": "boolean", "description": "Wurde diese Z\u00e4hlung durch einen nachtr\u00e4glich gefundenen Artikel erzeugt?", "readOnly": true } }, "description": "Position der Z\u00e4hllisten der Inventur" }, "common-masterdata-UnitTypeReference": { "required": [ "abbreviation" ], "type": "object", "properties": { "id": { "type": "integer", "description": "unit type id", "format": "int64" }, "name": { "maxLength": 255, "minLength": 0, "type": "string", "description": "descriptive name" }, "abbreviation": { "maxLength": 255, "minLength": 0, "type": "string", "description": "unique abbreviation" } }, "description": "net weight unit" }, "vds-carrier-Carrier": { "required": [ "carrierTypeRef", "label" ], "type": "object", "properties": { "version": { "type": "string", "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/shipment service/api name" }, "parameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "carrierTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "active": { "type": "boolean", "description": "Aktiv?", "default": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "Versender" }, "vds-shipment-CountryRegion": { "type": "object", "properties": { "label": { "type": "string", "description": "Label" }, "abbreviation": { "type": "string", "description": "Abk\u00fcrzung" }, "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\u00fcr die Region" } }, "description": "region of this address" }, "vds-shipment-DeliveryAddress": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "salutation": { "type": "string", "description": "salutation for this address" }, "name1": { "maxLength": 255, "minLength": 0, "type": "string", "description": "name1" }, "name2": { "maxLength": 255, "minLength": 0, "type": "string", "description": "name2" }, "name3": { "maxLength": 255, "minLength": 0, "type": "string", "description": "name3" }, "type": { "type": "string", "description": "kind of address", "enum": [ "CONSIGNEE", "SHIPPER" ] }, "additionalAddressLine1": { "maxLength": 255, "minLength": 0, "type": "string", "description": "additional address information 1" }, "additionalAddressLine2": { "maxLength": 255, "minLength": 0, "type": "string", "description": "additional address information 2" }, "street": { "maxLength": 255, "minLength": 0, "type": "string", "description": "streetname of this address" }, "streetAddressNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "house number or street address number of this address" }, "city": { "maxLength": 255, "minLength": 0, "type": "string", "description": "city of this address" }, "region": { "$ref": "#/components/schemas/vds-shipment-CountryRegion" }, "postcode": { "maxLength": 255, "minLength": 0, "type": "string", "description": "postcode of this address" }, "country": { "maxLength": 255, "minLength": 0, "type": "string", "description": "country of this address" }, "countryIso3": { "maxLength": 255, "minLength": 0, "type": "string", "description": "country-iso-alpha-3 of this address" }, "taxId": { "maxLength": 255, "minLength": 0, "type": "string", "description": "tax id of this address" }, "phone": { "maxLength": 255, "minLength": 0, "type": "string", "description": "phone number of this address" }, "fax": { "maxLength": 255, "minLength": 0, "type": "string", "description": "fax number of this address" }, "email": { "maxLength": 255, "minLength": 0, "type": "string", "description": "email of this address" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "receiver address of this order" }, "vds-shipment-Parcel": { "required": [ "parcelState" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "width": { "type": "number", "description": "width of the parcel" }, "height": { "type": "number", "description": "height of the parcel" }, "dimensionUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "length": { "type": "number", "description": "length of the parcel" }, "weight": { "type": "number", "description": "weight of the parcel" }, "weightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "trackingNumber": { "type": "string", "description": "tracking number of the parcel" }, "lines": { "type": "array", "description": "parcel position lines", "items": { "$ref": "#/components/schemas/vds-shipment-ParcelLine" } }, "trackingDetails": { "type": "array", "description": "tracking details lines", "items": { "$ref": "#/components/schemas/vds-shipment-ParcelTrackingDetail" } }, "packageParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "shipmentId": { "type": "integer", "description": "The ID of the linked shipment", "format": "int64" }, "parcelState": { "type": "string", "description": "Paket-Status", "enum": [ "OPEN", "REQUESTED", "COMPLETED", "ERROR", "MANUAL", "CANCELLED" ] }, "carrierResponse": { "type": "string", "description": "carrier response information (e.g. error message)" }, "validationErrors": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "the parcels sent within this shipping order" }, "vds-shipment-ParcelLine": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "parcelId": { "type": "integer", "description": "ID of the linked parcel", "format": "int64" }, "number": { "type": "string", "description": "position within the parcel" }, "description": { "type": "string", "description": "position description" }, "amount": { "type": "number", "description": "amount of position within the parcel" }, "grossWeight": { "type": "number", "description": "gross weight of single position" }, "grossWeightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "netWeight": { "type": "number", "description": "nett weight of single position" }, "netWeightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "grossPrice": { "type": "number", "description": "gross price of single position" }, "netPrice": { "type": "number", "description": "net price of single position" }, "internationalParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "dangerousGoodsParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "parcel position lines" }, "vds-shipment-ParcelTrackingDetail": { "required": [ "statusCode" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "statusCode": { "type": "string", "description": "Tracking-Status-Code", "enum": [ "CREATED", "PICKUP", "TRANSIT", "DELIVERED", "RETURN", "EXCEPTION" ] }, "carrierStatusCode": { "type": "string", "description": "deliverer status code" }, "statusLabel": { "type": "string", "description": "Status-Label" }, "statusDetails": { "type": "string", "description": "Status-Details" }, "location": { "type": "string", "description": "Ort" }, "trackingCreatedAt": { "type": "string", "description": "Zeitpunkt Tracking erstellt ", "format": "date-time" }, "trackingUpdatedAt": { "type": "string", "description": "Zeitpunkt Tracking ge\u00e4ndert", "format": "date-time" } }, "description": "tracking details lines" }, "vds-shipment-Shipment": { "required": [ "carrier", "documentId", "receiverAddress", "shipperAddress" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "shippingDate": { "type": "string", "description": "shipping date", "format": "date" }, "shipperAddress": { "$ref": "#/components/schemas/vds-shipment-DeliveryAddress" }, "receiverAddress": { "$ref": "#/components/schemas/vds-shipment-DeliveryAddress" }, "carrier": { "$ref": "#/components/schemas/vds-carrier-Carrier" }, "deliveryMethodId": { "type": "integer", "description": "ID der Versandart", "format": "int64" }, "shipmentParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "parcels": { "type": "array", "description": "the parcels sent within this shipping order", "items": { "$ref": "#/components/schemas/vds-shipment-Parcel" } }, "documentId": { "type": "integer", "description": "document id", "format": "int64" }, "carrierResponse": { "type": "string", "description": "carrier response / warning or error messages" }, "validationErrors": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "textInterpolationData": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "shipmentState": { "type": "string", "description": "state of the shipment", "enum": [ "OPEN", "IN_PROCESS", "COMPLETED" ] } } }, "vds-shipment-PrintLabelRequest": { "type": "object", "properties": { "parameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-user-ErpUserDetail": { "required": [ "accountRef", "parameter", "userRef" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customUserDetailFields": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "parameter": { "type": "string", "description": "parameter" }, "fields": { "type": "string" } } }, "erp-texttemplates-LocalizedTextTemplateContent": { "required": [ "content", "languageCodeIsoAlpha2" ], "type": "object", "properties": { "version": { "type": "string", "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" } }, "description": "Texte in den angebotenen Sprachen" }, "erp-texttemplates-TextTemplate": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Verwendungszweck des Templates", "enum": [ "UI_HINT", "AUTOMATIC", "MANUAL" ], "default": "AUTOMATIC" }, "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", "description": "account f\u00fcr den diese Templates gelten", "format": "int64", "nullable": true }, "articleId": { "type": "integer", "description": "article f\u00fcr den diese Templates gelten", "format": "int64", "nullable": true }, "currentDocumentTypes": { "type": "array", "description": "Zieldokumenttypen. Geben zusammen mit Vorbelegstypen die Transitionen an f\u00fcr die dieses Template gilt", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "baseDocumentTypes": { "type": "array", "description": "Vorbelegtypen. Geben zusammen mit Zieldokumenttypen die Transitionen an f\u00fcr die dieses Template gilt", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "transferableIntoSubsequentDocuments": { "type": "boolean", "description": "Erzeugte DocumentTexts beim \u00dcbergang in Folgebelege \u00fcbernehmen?", "nullable": true, "default": false }, "separateLine": { "type": "boolean", "description": "Wird eine eigene DocumentLine f\u00fcr den Baustein angelegt?", "nullable": true, "default": false }, "position": { "type": "string", "description": "Position f\u00fcr den erzeugten DocumentText", "enum": [ "HEADER_TEXT", "FOOTER_TEXT" ] }, "active": { "type": "boolean", "description": "ist dieser Baustein aktiv?", "readOnly": true, "default": true }, "languageSpecificContents": { "type": "array", "description": "Texte in den angebotenen Sprachen", "items": { "$ref": "#/components/schemas/erp-texttemplates-LocalizedTextTemplateContent" } } } }, "erp-tax-TaxSchema": { "required": [ "defaultCountryCode", "defaultTypeRef", "label" ], "type": "object", "properties": { "version": { "type": "string", "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": "the label for this tax-schema" }, "description": { "type": "string", "description": "a small description" }, "defaultTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defaultCountryCode": { "type": "string", "description": "the country to select for the default tax-rate" }, "countryMappings": { "type": "array", "description": "collection of selectors for the tax-rate", "items": { "$ref": "#/components/schemas/erp-tax-TaxSchemaCountry" } }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true } } }, "erp-tax-TaxSchemaCountry": { "required": [ "countryCode", "typeRef" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "countryCode": { "type": "string", "description": "the country to select for the default tax-rate" } }, "description": "collection of selectors for the tax-rate" }, "core-api-ApiCreatableReference": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier" }, "label": { "type": "string", "description": "a label" }, "description": { "type": "string", "description": "a short description", "readOnly": true } }, "description": "First contact type for this account person" }, "erp-tax-TaxRate": { "required": [ "countryCode", "rate", "typeRef", "validFrom" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "is this tax-rate active (selectable)", "readOnly": true, "default": true }, "countryCode": { "type": "string", "description": "the country code for this tax-rate" }, "rate": { "type": "number", "description": "the rate of this tax-rate", "example": 19.0 }, "validFrom": { "type": "string", "description": "the date, this entry is valid from", "format": "date" } } }, "erp-tax-TaxEwuDeliveryLimit": { "required": [ "exceeded", "validFrom" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "exceeded": { "type": "boolean", "description": "is the limit exeeded", "default": false }, "validFrom": { "type": "string", "description": "the date, this entry is valid from", "format": "date" } } }, "erp-stock-Storage": { "required": [ "number" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Ist das Lager aktiv?", "readOnly": true, "default": true }, "number": { "type": "string", "description": "Lager-Nr." }, "displayName": { "type": "string", "description": "Anzeigename" }, "salesStorage": { "type": "boolean", "description": "Lieferlager?", "default": false }, "purchaseOrderStorage": { "type": "boolean", "description": "Bestelllager?", "default": false }, "useInAvailabilityDetermination": { "type": "boolean", "description": "Soll das Lager in die Summierung der Best\u00e4nde/Verf\u00fcgbarkeiten mit einbezogen werden?", "default": false }, "returnOrderStorage": { "type": "boolean", "description": "Ziel-Lager f\u00fcr Retouren (z.B. aus Rechnungskorrektur mit WR)", "default": false }, "pickingRequired": { "type": "boolean", "description": "Muss in diesem Lager kommissioniert werden?", "default": false }, "withStorageBins": { "type": "boolean", "description": "Sollen in diesem Lager Lagerpl\u00e4tze verwendet werden", "default": false }, "allowNegativeStock": { "type": "boolean", "description": "Darf in diesem Lager negativer Bestand gebucht werden", "default": false }, "transit": { "type": "boolean", "description": "Ist es das Transitlager", "default": false }, "identifier": { "type": "string", "description": "Nur bei Lagern ohne Lagerpl\u00e4tze: Barcode (vom Standard-Lagerplatz)" }, "onlyOneBatchPerStorageBin": { "type": "boolean", "description": "Nur eine Charge je Artikel pro Lagerplatz", "default": false }, "supplyStorage": { "type": "boolean", "description": "Nachschublager", "default": false }, "forFabricationComponents": { "type": "boolean", "description": "Material-Lager", "default": false }, "defaultForFabricationComponents": { "type": "boolean", "description": "Standard-Material-Lager", "default": false }, "fabricationWorkbenchStorage": { "type": "boolean", "description": "Produktion: Werkbank-Lager", "default": false }, "fabricationQualityAssurance": { "type": "boolean", "description": "Produktion: QS-Lager", "default": false }, "fabricationDefectiveStorage": { "type": "boolean", "description": "Produktion: Defekt-Lager", "default": false }, "fabricationTargetStorage": { "type": "boolean", "description": "Produktion: Ziel-Lager", "default": false } }, "description": "Lager" }, "erp-stock-StorageBin": { "required": [ "displayName", "storageId" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 40, "minLength": 0, "type": "string", "description": "Ebene1" }, "level2": { "maxLength": 40, "minLength": 0, "type": "string", "description": "Ebene2" }, "level3": { "maxLength": 40, "minLength": 0, "type": "string", "description": "Ebene3" }, "level4": { "maxLength": 40, "minLength": 0, "type": "string", "description": "Ebene4" }, "level5": { "maxLength": 40, "minLength": 0, "type": "string", "description": "Ebene5" }, "level6": { "maxLength": 40, "minLength": 0, "type": "string", "description": "Ebene6" }, "identifier": { "type": "string", "description": "Barcode" }, "displayName": { "type": "string", "description": "Anzeigename" }, "description": { "type": "string", "description": "Beschreibung" }, "routePosition": { "type": "integer", "description": "Laufwegposition", "format": "int32" }, "shelfSpace": { "type": "boolean", "description": "Normaler Regalplatz?", "default": false }, "forIncomingGoods": { "type": "boolean", "description": "F\u00fcr Wareneingang?", "default": false }, "palletSpace": { "type": "boolean", "description": "F\u00fcr Paletten/Nachschubmengen?", "default": false }, "clarifySpace": { "type": "boolean", "description": "Zur Kl\u00e4rung?", "default": false }, "forReturnedGoods": { "type": "boolean", "description": "F\u00fcr Retouren?", "default": false }, "useInAvailabilityDetermination": { "type": "boolean", "description": "Soll der Lagerplatz in der Ermittlung der verf\u00fcgbaren Mengen beachtet werden?", "default": false }, "state": { "type": "string", "description": "Status eines Lagerplatzes", "enum": [ "ACTIVE", "INACTIVE", "SUSPENDED", "BLOCKED_FOR_INVENTORY" ], "default": "ACTIVE" }, "maxAllowedWeight": { "type": "number", "description": "Maximal zul\u00e4ssiges Gewicht" }, "heightInCM": { "type": "number", "description": "H\u00f6he in CM" }, "widthInCM": { "type": "number", "description": "Breite in CM" }, "depthInCM": { "type": "number", "description": "Tiefe in CM" }, "color": { "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string", "description": "Farbe zur Anzeige" }, "comment": { "type": "string", "description": "Kommentar" }, "storageAreaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Lagerplatz" }, "erp-stock-StorageChangeNameAndNumberRequest": { "required": [ "number" ], "type": "object", "properties": { "number": { "type": "string", "description": "Nummer f\u00fcr das Lager" }, "name": { "type": "string", "description": "der Name f\u00fcr das Lager" } } }, "common-cunit-QueryPresetPredicate": { "required": [ "operator", "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "die Operation f\u00fcr 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", "description": "Sichtbarkeit bei Variablen", "default": true }, "functions": { "type": "array", "description": "Eine SQL-Funktion, die im Predicate angewendet wird", "items": { "type": "string", "description": "Eine SQL-Funktion, die im Predicate angewendet wird" } } }, "description": "Bedingungen zur Selektion von Lagerpl\u00e4tzen" }, "common-cunit-QueryPresetVariable": { "type": "object", "properties": { "path": { "type": "string", "description": "Der pfad, der dieses Attribut eindeutig beschreibt" }, "definition": { "readOnly": true, "oneOf": [ { "$ref": "#/components/schemas/core-cunit-CuAttribute" }, { "$ref": "#/components/schemas/core-cunit-CuMeta" } ] }, "mandatory": { "type": "boolean", "description": "Ob die Variable ein Pflichtfeld ist oder nicht" }, "variableName": { "type": "string", "description": "Name der Variablen" }, "visible": { "type": "boolean", "description": "Handelt es sich um eine sichtbare Variable?", "default": true }, "alignX": { "type": "integer", "description": "Anordnung im UI - X-Koordinate", "format": "int32" }, "alignY": { "type": "integer", "description": "Anordnung im UI - Y-Koordinate", "format": "int32" }, "alignWidth": { "type": "integer", "description": "Anordnung im UI - Breite", "format": "int32" }, "searchDialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "allowDialogMultipleChoice": { "type": "boolean", "description": "Kann eine Mehrfachauswahl erfolgen?", "default": false } }, "description": "Die zu ersetzende Variable" }, "common-cunit-QueryPresetVariableSubstitution": { "type": "object", "properties": { "variable": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariable" }, "values": { "type": "array", "description": "Die einzusetzenden Werte", "items": { "type": "string", "description": "Die einzusetzenden Werte" } } }, "description": "Die Variablenbelegungen" }, "common-cunit-QueryPresetVariableSubstitutionList": { "type": "object", "properties": { "variableSubstitutions": { "type": "array", "description": "Die Variablenbelegungen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitution" } } }, "description": "Werte von Variablen" }, "core-cunit-CuAttribute": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/core-cunit-MetaContent" }, { "type": "object", "properties": { "attribute": { "type": "string", "description": "name des attributes der das ergebnis enth\u00e4lt" }, "path": { "type": "string", "description": "der pfad, der dieses attribut eindeutig beschreibt" }, "displayName": { "type": "string", "description": "der Name dieses Feldes" }, "displayNameOverride": { "type": "boolean", "description": "der Name dieses Feldes wurde \u00fcberschrieben (alias oder funktion)", "default": false }, "groupDisplayName": { "type": "string", "description": "der Name der Gruppe, dieses Feldes" }, "parentDisplayName": { "type": "string", "description": "der Name des Referenzierenden Feldes" }, "resultable": { "type": "boolean", "description": "kann dieses Feld ein Ergebnisfeld sein", "default": true }, "filterable": { "type": "boolean", "description": "kann nach diesem feld gefiltert werden", "default": true }, "sortable": { "type": "boolean", "description": "ist dieses Feld sortierbar", "default": true }, "visible": { "type": "boolean", "description": "soll dieses Feld angezeigt werden", "default": true }, "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\u00fcr dieses Attribut (falls dataType leer ist)", "readOnly": true }, "modelType": { "type": "string", "description": "Attribut geh\u00f6rt zum Modelltyp 'statisch' oder 'dynamisch'", "readOnly": true, "enum": [ "STATIC", "DYNAMIC" ] }, "headers": { "type": "array", "description": "bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben", "readOnly": true, "items": { "$ref": "#/components/schemas/core-cunit-HeaderGroup" } } } } ] }, "core-cunit-CuAttributeConstraint": { "type": "object", "properties": { "minLength": { "type": "integer", "description": "Minimal-L\u00e4nge (von Zeichenketten oder Arrays)", "format": "int32", "readOnly": true }, "maxLength": { "type": "integer", "description": "Maximal-L\u00e4nge (von Zeichenketten oder Arrays)", "format": "int32", "readOnly": true }, "minValue": { "type": "integer", "description": "minimaler Wert", "format": "int64", "readOnly": true }, "includeMinValue": { "type": "boolean", "description": "ist der minimale Wert inklusive?", "readOnly": true }, "maxValue": { "type": "integer", "description": "maximaler Wert", "format": "int64", "readOnly": true }, "includeMaxValue": { "type": "boolean", "description": "ist der maximale Wert inklusive?", "readOnly": true }, "notNull": { "type": "boolean", "description": "ist der Wert 'null' verboten?", "readOnly": true, "default": false }, "notBlank": { "type": "boolean", "description": "Bei Strings: ist ein String nur aus Whitespace verboten?", "readOnly": true } }, "description": "constraints f\u00fcr dieses Attribut" }, "core-cunit-CuAttributeDataType": { "type": "object", "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?", "readOnly": true, "items": { "type": "string", "description": "welche Funktionen sind erlaubt?" } }, "predicateOperations": { "type": "array", "description": "welche Operations sind erlaubt?", "readOnly": true, "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" ] } } }, "description": "data-type f\u00fcr dieses Attribut (falls dataTypeIdentifier leer ist)" }, "core-cunit-CuAttributeFilterOptions": { "type": "object", "properties": { "filterValues": { "type": "array", "description": "M\u00f6gliche Filterwerte", "items": { "type": "string", "description": "M\u00f6gliche Filterwerte" } }, "filterDialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "multipleChoice": { "type": "boolean", "description": "Kann eine Mehrfachauswahl erfolgen?", "default": false } }, "description": "CUnit Attribut Filter Optionen" }, "core-cunit-CuMeta": { "type": "object", "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-HeaderGroup": { "type": "object", "properties": { "displayName": { "type": "string", "description": "der Name dieses Feldes" }, "displayNameOverride": { "type": "boolean", "description": "der Name dieses Feldes wurde \u00fcberschrieben (alias oder funktion)", "default": false }, "dataType": { "$ref": "#/components/schemas/core-cunit-CuAttributeDataType" }, "dataTypeIdentifier": { "type": "string", "description": "data-type-identifier f\u00fcr 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" } }, "description": "bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben" }, "core-cunit-MetaContent": { "required": [ "_type" ], "type": "object", "properties": { "_type": { "type": "string" } }, "description": "Definition dieser Variable", "discriminator": { "propertyName": "_type" }, "oneOf": [ { "$ref": "#/components/schemas/core-cunit-CuMeta" }, { "$ref": "#/components/schemas/core-cunit-CuAttribute" } ] }, "erp-stock-StorageBinLabelPrintRequest": { "type": "object", "properties": { "variables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "exportFilename": { "type": "string", "description": "Dateiname des Ausdrucks" } }, "description": "Request zur Durchf\u00fchrung des Etikettendrucks von Lagerpl\u00e4tzen" }, "erp-stock-StorageArea": { "required": [ "label", "storageId" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Storage-ID", "format": "int64" }, "label": { "type": "string", "description": "Kurzbezeichnung" }, "description": { "type": "string", "description": "Beschreibung" } }, "description": "Lagerbereich" }, "erp-stock-BookLastPurchasePriceCorrectionRequest": { "required": [ "articleId", "purchasePrice" ], "type": "object", "properties": { "articleId": { "type": "integer", "description": "Artikel-Id", "format": "int64" }, "purchasePrice": { "type": "number", "description": "Der neue letzte EK" }, "serialNumberId": { "type": "integer", "description": "Die ID der Seriennummer des Artikels", "format": "int64" }, "note": { "type": "string", "description": "Notiz zur \u00c4nderung" } } }, "erp-stock-BookAveragePurchasePriceCorrectionRequest": { "required": [ "articleId", "purchasePrice" ], "type": "object", "properties": { "articleId": { "type": "integer", "description": "Artikel-Id", "format": "int64" }, "purchasePrice": { "type": "number", "description": "Der neue DEK" }, "note": { "type": "string", "description": "Notiz zur \u00c4nderung" } } }, "erp-sales_channel-SalesChannelStorage": { "required": [ "storageRef" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maximum": 100, "type": "number", "description": "Verf\u00fcgbarkeit in Prozent" }, "defaultSalesStorage": { "type": "boolean", "description": "Standard-Verkaufslager" }, "defaultPurchaseStorage": { "type": "boolean", "description": "Standard-Einkaufslager" }, "modifiedByUser": { "type": "boolean", "description": "Durch Benutzer bearbeitet", "readOnly": true } }, "description": "Lagerzuordnungen" }, "erp-sales_channel-SalesChannelStorageSchema": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Aktiv?", "readOnly": true, "default": true } } }, "common-masterdata-CountryReference": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID des Landes", "format": "int64" }, "isoAlpha2": { "type": "string", "description": "IsoAlpha2-Code des Landes" }, "label": { "type": "string", "description": "Bezeichnung des Landes", "readOnly": true } }, "description": "Country code" }, "common-sequencer-SequencerConfiguration": { "required": [ "configurationDetail" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Sequencer aktiv?", "default": true } }, "description": "Eigener Z\u00e4hlerkreis f\u00fcr Seriennummern" }, "common-sequencer-SequencerConfigurationDetail": { "required": [ "assignmentMode", "initialValue", "length", "padChar", "type" ], "type": "object", "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", "description": "L\u00e4nge", "format": "int32" }, "padChar": { "maxLength": 1, "minLength": 1, "pattern": "^[0-9]*$", "type": "string", "description": "Auff\u00fcllzeichen" }, "expression": { "type": "string", "description": "Pr\u00e4fix-Ausdruck" }, "postExpression": { "type": "string", "description": "Postfix-Ausdruck" }, "initialValue": { "type": "integer", "description": "Initialer Wert", "format": "int64" }, "numberUnique": { "type": "boolean", "description": "Eindeutigkeitspr\u00fcfung", "default": true } }, "description": "Contains details about the sequencer configuration" }, "erp-product-ArticleAvailabilityDetermination": { "type": "object", "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\u00e4nde behandelt", "enum": [ "IGNORE", "ADD", "SUBTRACT" ] } }, "description": "Verf\u00fcgbarkeitsermittlung f\u00fcr die Artikelstammdaten/Bestandsansicht" }, "erp-product-Product": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Handelt es sich um ein Gebinde?", "default": false }, "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\u00f6ren", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" } }, "availabilityDetermination": { "$ref": "#/components/schemas/erp-product-ArticleAvailabilityDetermination" }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "DOUBLE_SERIAL_NUMBER" ] }, "expiryDateType": { "type": "string", "description": "Art des Haltbarkeitsdatums bei Serienartikeln", "enum": [ "NONE", "BEST_BEFORE_DATE", "EXPIRATION_DATE" ] }, "warrantyInMonths": { "type": "integer", "description": "Garantie in Monaten", "format": "int32" }, "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": { "maxLength": 15, "minLength": 0, "type": "string", "description": "Zolltarifnummer" }, "countryOfOrigin": { "$ref": "#/components/schemas/common-masterdata-CountryReference" }, "regionOfOrigin": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "useSerialSequencerConfiguration": { "type": "boolean", "description": "Soll ein eigener Z\u00e4hlerkreis f\u00fcr Seriennummern verwendet werden?" }, "serialSequencerConfiguration": { "$ref": "#/components/schemas/common-sequencer-SequencerConfiguration" }, "variantValues": { "type": "array", "description": "Product-Varianten-Werte", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantValueReference" } }, "productVariantRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "mainVariantProductRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-product-ProductArticleRef": { "required": [ "unit" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Article ID", "format": "int64" }, "number": { "type": "string", "description": "Article number" }, "unit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" } }, "description": "alle artikel, die zu diesem Produkt geh\u00f6ren" }, "erp-product-ProductVariantValueReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Identifier" }, "label": { "type": "string", "description": "a label", "readOnly": true }, "description": { "type": "string", "description": "a short description", "readOnly": true }, "productVariantAttributeRefs": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Product-Varianten-Werte" }, "common-masterdata-CurrencyReference": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID der W\u00e4hrung", "format": "int64" }, "isoAlpha3": { "type": "string", "description": "IsoAlpha3-Code der W\u00e4hrung" }, "label": { "type": "string", "description": "Bezeichnung der W\u00e4hrung", "readOnly": true }, "symbol": { "type": "string", "description": "Symbol der W\u00e4hrung", "readOnly": true } }, "description": "W\u00e4hrung" }, "erp-product-ProductPrice": { "required": [ "priceBase" ], "type": "object", "properties": { "version": { "type": "string", "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" ] }, "priceUnit": { "type": "number", "description": "Preiseinheit" }, "usedTaxRate": { "$ref": "#/components/schemas/erp-tax-TaxRate" }, "qualifier": { "type": "string", "description": "Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt", "readOnly": true, "enum": [ "SALES", "PURCHASE" ] }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "productGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priceGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "manufacturerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "discountGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "currencyRef": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" }, "fromQuantity": { "type": "number", "description": "Bestimmt ab welcher Menge dieser Preis g\u00fcltig ist" }, "validFrom": { "type": "string", "description": "G\u00fcltig von", "format": "date" }, "validUntil": { "type": "string", "description": "G\u00fcltig bis", "format": "date" }, "specialOfferPrice": { "type": "boolean", "description": "Aktionpreis", "default": false }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customerGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "supplierGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Enth\u00e4lt einen Verkaufs- oder Einkaufspreis zu einem Produkt" }, "erp-product-ProductDiscount": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "qualifier": { "type": "string", "description": "Bestimmt, ob es sich um einen Verkaufs- oder Einkaufsrabatt handelt", "readOnly": true, "enum": [ "SALES", "PURCHASE" ] }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "productGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priceGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "manufacturerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "discountGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "fromQuantity": { "type": "number", "description": "Bestimmt ab welcher Menge dieser Rabatt g\u00fcltig ist" }, "modifierName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name des Rabatts" }, "modifierType": { "type": "string", "description": "Bestimmt die Art des Rabatts", "enum": [ "DISCOUNT", "SURCHARGE" ] }, "valueType": { "type": "string", "description": "Typ von Werten", "enum": [ "PERCENT", "FIX" ] }, "currencyRef": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" }, "modifierValue": { "type": "number", "description": "Wert des Rabatts" }, "validFrom": { "type": "string", "description": "G\u00fcltig von", "format": "date" }, "validUntil": { "type": "string", "description": "G\u00fcltig bis", "format": "date" }, "specialOfferPrice": { "type": "boolean", "description": "Aktionpreis", "default": false }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customerGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "supplierGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Enth\u00e4lt eine Preisregel bzw. einen Verkaufs- oder Einkaufsrabatt zu einem Produkt" }, "erp-product-Manufacturer": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": "Hersteller" }, "description": { "type": "string", "description": "Bezeichnung" }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "accountId": { "type": "string", "description": "Referenz auf den Account" } }, "description": "Produkt-Hersteller" }, "erp-product-ProductVariant": { "required": [ "attributeRefs", "description" ], "type": "object", "properties": { "version": { "type": "string", "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": "Beschreibung" }, "attributeRefs": { "type": "array", "description": "Variant-Attribute-Ids", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "variantValueRefs": { "type": "array", "description": "Variantenwerte", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true } } }, "erp-product-ProductVariantAttribute": { "required": [ "labels" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "labels": { "type": "array", "description": "displaytext", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeDescription" } }, "listings": { "type": "array", "description": "Listings", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeListing" } } } }, "erp-product-ProductVariantAttributeDescription": { "type": "object", "properties": { "version": { "type": "string", "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" }, "languageCode": { "type": "string", "description": "language code" } }, "description": "displaytext" }, "erp-product-ProductVariantAttributeListing": { "required": [ "salesChannelRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "attributeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "Produktvariantenattribut-Listing" }, "erp-product-ProductVariantAttributeValue": { "required": [ "abbreviation", "labels" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "productVariantAttributeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "sortOrder": { "type": "integer", "description": "sortierung", "format": "int64", "nullable": true }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "abbreviation": { "type": "string", "description": "Abk\u00fcrzung" }, "labels": { "type": "array", "description": "Anzeige Text", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValueDescription" } }, "listings": { "type": "array", "description": "Listings", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValueListing" } } } }, "erp-product-ProductVariantAttributeValueDescription": { "type": "object", "properties": { "version": { "type": "string", "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" }, "languageCode": { "type": "string", "description": "language code" } }, "description": "Anzeige Text" }, "erp-product-ProductVariantAttributeValueListing": { "required": [ "salesChannelRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "attributeValueRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "Produktvariantenattributwert-Listing" }, "erp-product-ProductPriceGroup": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": "Kurzbezeichnung" }, "description": { "type": "string", "description": "Beschreibung" } }, "description": "Enth\u00e4lt eine Preisgruppe" }, "erp-product-ProductGroup": { "required": [ "description", "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 50, "minLength": 0, "type": "string", "description": "product group name" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "product group description" }, "externalReference": { "maxLength": 255, "minLength": 0, "type": "string", "description": "needed for data migration from third party applications" }, "mainGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customsTariffNumber": { "maxLength": 15, "minLength": 0, "type": "string", "description": "Zolltarifnummer" }, "active": { "type": "boolean", "description": "warengruppe aktiv ja/nein", "readOnly": true, "default": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-product-ProductMainGroup": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 50, "minLength": 0, "type": "string", "description": "Hauptwarengruppe" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung der Hauptwarengruppe" }, "active": { "type": "boolean", "description": "Hauptwarengruppe aktiv ja/nein", "readOnly": true, "default": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-product-IdentifierType": { "required": [ "name" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "produkt-nummern-typ" }, "active": { "type": "boolean", "description": "is active", "readOnly": true, "default": true } } }, "erp-product-DiscountGroup": { "required": [ "label", "type" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name der Rabattgruppe" }, "description": { "type": "string", "description": "Rabattgruppenbeschreibung" }, "type": { "type": "string", "description": "Typ", "enum": [ "DISCOUNT", "SURCHARGE" ] }, "rules": { "type": "array", "description": "List of discount group rules", "items": { "$ref": "#/components/schemas/erp-product-DiscountGroupRule" } } } }, "erp-product-DiscountGroupRule": { "required": [ "name", "value", "valueType" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "discountGroupId": { "type": "integer", "description": "Referenz zur Rabattgruppe", "format": "int64" }, "name": { "type": "string", "description": "Name der Regel" }, "valueType": { "type": "string", "description": "Typ von Werten", "enum": [ "PERCENT", "FIX" ] }, "value": { "type": "number", "description": "Rabattwert" }, "fromQuantity": { "type": "number", "description": "Ab Menge" }, "priceGroupId": { "type": "integer", "description": "Referenz zu einer Preisgruppe", "format": "int64" }, "currencyRef": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" } }, "description": "List of discount group rules" }, "erp-document-PriceModifierTemplate": { "required": [ "label", "modifierType" ], "type": "object", "properties": { "version": { "type": "string", "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" ] } } }, "erp-pos-TssAdminPin": { "required": [ "adminPin" ], "type": "object", "properties": { "adminPin": { "type": "string", "description": "Admin-PIN f\u00fcr die TSS" } }, "description": "Request f\u00fcr TSS-Admin-Operationen" }, "erp-pos-PosRegister": { "required": [ "description", "label" ], "type": "object", "properties": { "version": { "type": "string", "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 Kasse" }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv?", "default": true }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "cashDrawerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethods": { "uniqueItems": true, "type": "array", "description": "Payment Methods", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "uiSettings": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "externalReference": { "type": "string", "description": "Externe Referenz", "readOnly": true } } }, "erp-pos-FiscalizationBackend": { "required": [ "backendType", "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Bezeichnung" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "externalReference": { "type": "string", "description": "Externe Referenz", "readOnly": true }, "backendType": { "type": "string", "description": "Backend-Typ", "enum": [ "FISKALY" ] } } }, "erp-pos-PosDepositExpenseType": { "required": [ "description", "label" ], "type": "object", "properties": { "version": { "type": "string", "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 Einlage/Ausgabe" }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv?", "default": true }, "taxRateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "type": { "type": "string", "description": "Typ der Einlage/Auszahlung", "enum": [ "DEPOSIT", "EXPENSE" ] } } }, "erp-pos-CashDrawer": { "required": [ "description", "label" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Aktiv?", "default": true }, "drawerState": { "type": "string", "description": "Schubladenstatus", "readOnly": true, "enum": [ "OPEN", "CLOSED" ] } } }, "erp-document-DocumentTypeTerm": { "required": [ "content", "languageCode" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "documentType": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "content": { "type": "string", "description": "content" }, "languageCode": { "type": "string", "description": "sprache" } }, "description": "translations" }, "erp-payment-PaymentTerm": { "required": [ "description", "label", "paymentType" ], "type": "object", "properties": { "version": { "type": "string", "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 for this payment term" }, "description": { "type": "string", "description": "description" }, "paymentType": { "type": "string", "description": "payment type", "enum": [ "PREPAYMENT", "PAYMENT", "DEPOSIT" ] }, "paymentDays1": { "type": "integer", "description": "Days for Discount 1 ", "format": "int32", "default": 0 }, "paymentDiscount1": { "type": "number", "description": "Percent for Discount 1 ", "default": 0.0 }, "paymentDays2": { "type": "integer", "description": "Days for Discount 2 ", "format": "int32", "default": 0 }, "paymentDiscount2": { "type": "number", "description": "Percent for Discount 2 ", "default": 0.0 }, "paymentDaysNet": { "type": "integer", "description": "Days for net payment ", "format": "int32", "default": 0 }, "remainingTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "printDescription": { "type": "string", "description": "printDescription" }, "dunningBlock": { "type": "boolean", "description": "Mahnsperre", "default": false }, "active": { "type": "boolean", "description": "Aktiv?", "default": true }, "considerForCreditLimit": { "type": "boolean", "description": "F\u00fcr Kreditlimit ber\u00fccksichtigen?", "default": true }, "translations": { "type": "array", "description": "translations", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeTerm" } } } }, "erp-payment-PaymentTemplate": { "required": [ "label", "paymentTemplateType" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Standard-Zahlungsvorlage", "default": false }, "batchPayment": { "type": "boolean", "description": "Sammelauftrag m\u00f6glich", "default": false }, "paymentTemplateType": { "type": "string", "description": "Typ der Zahlungsvorlage", "enum": [ "PAYMENT_INVOICE", "PAYMENT_CREDIT_NOTE", "PAYMENT_NOT_BOUND", "DIRECT_DEBIT" ], "default": "PAYMENT_NOT_BOUND" }, "paymentTemplateEntries": { "type": "array", "description": "Die einzelnen Feldvorbelegungen der Zahlungsvorlage", "items": { "$ref": "#/components/schemas/erp-payment-PaymentTemplateEntry" } } }, "description": "Zahlungsvorlage zur Vorbelegung von Feldern in einer Zahlung" }, "erp-payment-PaymentTemplateEntry": { "type": "object", "properties": { "version": { "type": "string", "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\u00fcr Vorbelegung" }, "value": { "type": "string", "description": "Wert f\u00fcr Vorbelegung" } }, "description": "Eintrag f\u00fcr eine Feldvorbelegung einer Zahlungsvorlage" }, "erp-payment-PaymentMethod": { "required": [ "description", "label", "paymentType" ], "type": "object", "properties": { "version": { "type": "string", "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 for this payment method" }, "description": { "type": "string", "description": "description" }, "dunnable": { "type": "boolean", "description": "dunnable", "default": true }, "externalPaymentId": { "type": "string", "description": "external Payment Id" }, "paymentType": { "type": "string", "description": "Payment Type", "enum": [ "MONEY_TRANSFER", "REALTIME_MONEY_TRANSFER", "SEPA_CORE_DIRECT_DEBIT", "SEPA_B2B_DIRECT_DEBIT", "CLEARING", "CLEARING_WITH_PREDECESSOR_DOCUMENT", "OTHER" ], "default": "MONEY_TRANSFER" }, "active": { "type": "boolean", "description": "Aktiv?", "default": true }, "printDescription": { "type": "string", "description": "printDescription" }, "translations": { "type": "array", "description": "translations", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeTerm" } }, "closePayable": { "type": "boolean", "description": "Verbindlichkeiten-OP abschlie\u00dfen?", "default": false }, "closeReceivable": { "type": "boolean", "description": "Forderungs-OP abschlie\u00dfen?", "default": false }, "businessTransaction": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "daysToAddForDirectDebit": { "type": "integer", "description": "+Tage f\u00fcr Erstlastschrift", "format": "int32" }, "daysToAddForFollowup": { "type": "integer", "description": "+Tage f\u00fcr Folgelastschrift", "format": "int32" } } }, "erp-stock-OrderProposal": { "required": [ "needsAssessmentPreference", "supplierPreference" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "purchaseOrderStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "givenSupplierAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "supplierPreference": { "type": "string", "description": "Bevorzugte Lieferantenfindung", "enum": [ "CHEAPEST", "FASTEST", "SPECIFIC_SUPPLIER", "MAIN_SUPPLIER" ] }, "needsAssessmentPreference": { "type": "string", "description": "Bevorzugte Bedarfsermittlung", "enum": [ "MINIMUM_TARGET_STOCK", "SALES" ] }, "addStockQuantity": { "type": "boolean", "description": "Soll Lagerbestand zur Bestellmenge addiert werden", "default": false }, "addReservedQuantity": { "type": "boolean", "description": "Soll reservierter Lagerbestand zur Bestellmenge addiert werden", "default": false }, "subtractOrderedQuantity": { "type": "boolean", "description": "Soll bestellter Lagerbestand von Bestellmenge abgezogen werden", "default": false }, "priceRequestInsteadOfOrder": { "type": "boolean", "description": "Soll eine Preisanfrage erstellt werden anstatt einer Bestellung", "default": false }, "triggerMailOutputAfterDocumentCreation": { "type": "boolean", "description": "Soll die erstellte Bestellung direkt per Mail versandt werden", "default": false }, "processed": { "type": "boolean", "description": "Wurde der Bestellvorschlag verarbeitet", "default": false }, "orderProposalSuppliers": { "type": "array", "description": "Bestellvorschlag-Lieferanten-Beziehungen", "items": { "$ref": "#/components/schemas/erp-stock-OrderProposalSupplier" } } } }, "erp-stock-OrderProposalSupplier": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "supplierId": { "type": "string", "description": "ID des Lieferanten" }, "priceRequestInsteadOfOrder": { "type": "boolean", "description": "Soll eine Preisanfrage erstellt werden anstatt einer Bestellung", "nullable": true }, "triggerMailOutputAfterDocumentCreation": { "type": "boolean", "description": "Soll die erstellte Bestellung direkt per Mail versandt werden", "nullable": true }, "createdDocument": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "toBeOrdered": { "type": "boolean" } }, "description": "Bestellvorschlag-Lieferanten-Beziehungen" }, "erp-stock-OrderProposalLine": { "required": [ "articleRef", "proposedOrderAmount", "supplierAccountRef", "toBeOrderedAmount" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "orderProposalId": { "type": "string", "description": "Bestellvorschlag", "readOnly": true }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "supplierAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "proposedOrderAmount": { "type": "number", "description": "vorgeschlagene zu bestellende Menge", "example": 19.0 }, "toBeOrderedAmount": { "type": "number", "description": "tats\u00e4chlich zu bestellende Menge", "example": 18.0 }, "priceTotal": { "type": "number", "description": "kalkulierter Gesamtpreis", "readOnly": true }, "productPrices": { "type": "array", "description": "Lieferanten-Preise", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-product-ProductPrice" } }, "productDiscounts": { "type": "array", "description": "Lieferanten-Preisregeln", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-product-ProductDiscount" } }, "determinedUnitPrice": { "type": "number", "description": "ermittelter Einzelpreis", "readOnly": true }, "negotiatedUnitPrice": { "type": "number", "description": "verhandelter Einzelpreis" }, "totalPrice": { "type": "number", "description": "Gesamtpreis", "readOnly": true }, "deliveryTime": { "type": "integer", "description": "Lieferzeit", "format": "int32", "readOnly": true }, "orderDocumentLineRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "toBeOrdered": { "type": "boolean" } } }, "erp-finance-OpenItemChangeRequest": { "type": "object", "properties": { "manualPaymentDueDate": { "type": "string", "description": "manuelles vorrangiges F\u00e4lligkeitsdatum", "format": "date", "nullable": true }, "dunningBlock": { "type": "boolean", "description": "Mahnsperre", "nullable": true }, "inReview": { "type": "boolean", "description": "In Kl\u00e4rung setzen", "nullable": true }, "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", "nullable": true }, "valueDate": { "type": "string", "description": "Valutadatum", "format": "date", "nullable": true }, "clearValueDate": { "type": "boolean", "description": "Valutadatum l\u00f6schen", "nullable": true }, "comment": { "type": "string", "description": "Kommentar", "nullable": true }, "paymentBlock": { "type": "boolean", "description": "Zahlungssperre", "nullable": true } } }, "common-tag-TagDto": { "required": [ "label", "type" ], "type": "object", "properties": { "version": { "type": "string", "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\u00fcr 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" } }, "description": "List of tags" }, "erp-finance-OpenItem": { "required": [ "number" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "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", "description": "agreed Deposit payment date", "format": "date", "readOnly": true }, "depositPayed": { "type": "boolean", "description": "is the agreed deposit payed?", "readOnly": true, "default": false }, "balancedDate": { "type": "string", "description": "balanced date of this open item (calculated)", "format": "date", "readOnly": true }, "balanceState": { "type": "string", "description": "whether this open item is balanced, partially paid or open", "readOnly": true, "enum": [ "OPEN", "PARTIALLY_BALANCED", "BALANCED", "OVERPAID" ] }, "balance": { "type": "number", "description": "saldo", "readOnly": true }, "sumPayments": { "type": "number", "description": "Summe gebuchte Zahlungen", "readOnly": true }, "sumDunnings": { "type": "number", "description": "Summe Mahngeb\u00fchren 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\u00fchren", "readOnly": true }, "records": { "type": "array", "description": "free payments", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-finance-OpenItemRecord" } }, "basisPaymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentDays1": { "type": "integer", "description": "How many days are given for using the first discount rule", "format": "int32", "readOnly": true }, "paymentDiscount1": { "type": "number", "description": "How much discount can be given for speedy payment, rule 1", "readOnly": true }, "paymentDiscount1DueDate": { "type": "string", "description": "F\u00e4lligkeitsdatum (Skonto1)", "format": "date", "readOnly": true }, "paymentDays2": { "type": "integer", "description": "How many days are given for using the second discount rule", "format": "int32", "readOnly": true }, "paymentDiscount2": { "type": "number", "description": "How much discount can be given for speedy payment, rule 2", "readOnly": true }, "paymentDiscount2DueDate": { "type": "string", "description": "F\u00e4lligkeitsdatum (Skonto2)", "format": "date", "readOnly": true }, "qualifier": { "type": "string", "description": "Does this open item belong to accounts payable or accounts receivable", "readOnly": true, "enum": [ "PAYABLE", "RECEIVABLE" ] }, "fullPaymentAmount": { "type": "number", "description": "The full amount of the payment", "readOnly": true }, "paymentAmount": { "type": "number", "description": "Der momentan g\u00fcltige zu zahlende Betrag", "readOnly": true }, "paymentKind": { "type": "string", "description": "The kind of payment", "readOnly": true, "enum": [ "PREPAYMENT", "PAYMENT" ] }, "refundType": { "type": "string", "description": "how should a refund be done?", "enum": [ "DISBURSE", "OFFSET_LATER" ] }, "dunningBlock": { "type": "boolean", "description": "Mahnsperre", "default": false }, "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", "description": "Die Mahnstufe", "format": "int32", "readOnly": true }, "dunningCount": { "type": "integer", "description": "Anzahl Mahnpositionen/Mahnungen f\u00fcr diesen OP", "format": "int32", "readOnly": true }, "originalPaymentDueDate": { "type": "string", "description": "Urspr\u00fcngliches F\u00e4lligkeitsdatum", "format": "date", "readOnly": true }, "paymentDaysNet": { "type": "integer", "description": "F\u00e4lligkeit in Tagen", "format": "int32" }, "paymentDueDate": { "type": "string", "description": "F\u00e4lligkeitsdatum", "format": "date" }, "valueDate": { "type": "string", "description": "Valutadatum", "format": "date" }, "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", "description": "Zahlungssperre", "default": false }, "endToEndId": { "type": "string", "description": "End-To-End-ID", "deprecated": true }, "tags": { "type": "array", "description": "List of tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "paymentPlan": { "$ref": "#/components/schemas/erp-finance-OpenItemPaymentPlan" }, "valueDateReadOnly": { "type": "boolean", "description": "Valutadatum schreibgesch\u00fctzt", "default": false }, "canBeReopened": { "type": "boolean", "description": "kann wiederer\u00f6ffet werden", "default": false }, "currencyCode": { "type": "string", "description": "W\u00e4hrung des offenen Postens (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der W\u00e4hrung zu Basisw\u00e4hrung" }, "baseCurrencyCode": { "type": "string", "description": "Basisw\u00e4hrung des offenen Postens (ISO-A3)" }, "baseDepositPaymentAmount": { "type": "number", "description": "Vereinbarter Anzahlungsbetrag in Basisw\u00e4hrung" }, "baseSumPayments": { "type": "number", "description": "Summe der Zahlungen in Basisw\u00e4hrung" }, "baseSumDiscount": { "type": "number", "description": "Summe der Abz\u00fcge (Skonto usw.) in Basisw\u00e4hrung" }, "baseSumDunnings": { "type": "number", "description": "Summe der Mahngeb\u00fchren und Zinsen in Basisw\u00e4hrung" }, "baseSumTotalAmount": { "type": "number", "description": "Gesamtsumme der Rechnungsbetr\u00e4ge in Basisw\u00e4hrung" }, "baseSumDiscountableAmount": { "type": "number", "description": "Summe der skontierbaren Rechnungsbetr\u00e4ge in Basisw\u00e4hrung" }, "baseBalance": { "type": "number", "description": "Offener Betrag (Saldo) in Basisw\u00e4hrung" }, "baseSumFee": { "type": "number", "description": "allgemeine Geb\u00fchren in Basisw\u00e4hrung" }, "blockedByDocument": { "type": "boolean", "description": "Ist der OP durch ein Dokument geblockt?", "default": false }, "balanced": { "type": "boolean" } } }, "erp-finance-OpenItemPaymentPlan": { "type": "object", "properties": { "version": { "type": "string", "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\u00e4lligkeitsregel" }, "amount": { "type": "number", "description": "Betrag" }, "startDate": { "type": "string", "description": "Startdatum", "format": "date" }, "endDate": { "type": "string", "description": "Enddatum", "format": "date" }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv" }, "dueDate": { "type": "string", "description": "F\u00e4lligkeitsdatum", "format": "date" }, "manualRuleEntries": { "type": "array", "description": "manuelle Buchungsvorgaben", "items": { "$ref": "#/components/schemas/erp-finance-PaymentPlanManualRule" } }, "currencyCode": { "type": "string", "description": "W\u00e4hrung des Zahlungsplans (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der W\u00e4hrung zu Basisw\u00e4hrung" }, "baseCurrencyCode": { "type": "string", "description": "Basisw\u00e4hrung des Zahlungsplans (ISO-A3)" }, "baseAmount": { "type": "number", "description": "Betrag in Basisw\u00e4hrung" } }, "description": "Zahlungsplan" }, "erp-finance-OpenItemRecord": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "record date", "format": "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", "description": "ref to the financialBookingRecord", "format": "int64", "nullable": true, "readOnly": true }, "origin": { "type": "string", "description": "origin for this record", "readOnly": true, "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", "DEPOSIT", "CREDIT_NOTE", "BALANCE_ADJUSTMENT", "FEE", "DUNNING_PAYMENT", "DUNNING_PAYMENT_DISSOLVED", "POS_PAYMENT" ] }, "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", "description": "id des records, der diesen storniert hat", "format": "int64", "nullable": true, "readOnly": true }, "transactionId": { "type": "integer", "description": "id der transaction, die diesen record hervorgerufen hat", "format": "int64", "nullable": true, "readOnly": true }, "qualifier": { "type": "string", "description": "qualifier of open item", "readOnly": true, "enum": [ "PAYABLE", "RECEIVABLE", "PAYMENT_RECEIVED", "PAYMENT_SENT", "PAYMENT_RECEIVED_REVERTED", "PAYMENT_SENT_REVERTED", "DUNNING_RECEIVABLE", "DUNNING_PAYABLE", "DUNNING_RECEIVABLE_REVERTED", "DUNNING_PAYABLE_REVERTED" ] }, "number": { "type": "string", "description": "Eine Vorgangsnummer die zur Buchung f\u00fchrte", "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", "description": "Mahnstufe", "format": "int32", "readOnly": true }, "currencyCode": { "type": "string", "description": "W\u00e4hrung des offenen Postens (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der W\u00e4hrung zu Basisw\u00e4hrung" }, "baseCurrencyCode": { "type": "string", "description": "Basisw\u00e4hrung des offenen Postens (ISO-A3)" }, "baseAmount": { "type": "number", "description": "Buchungsbetrag in Basisw\u00e4hrung" }, "baseDiscountAmount": { "type": "number", "description": "Abzugsbetrag in Basisw\u00e4hrung" }, "baseTotalAmount": { "type": "number", "description": "Gesamtbetrag in Basisw\u00e4hrung" }, "baseDiscountableAmount": { "type": "number", "description": "Skontierbarer Gesamtbetrag in Basisw\u00e4hrung" }, "baseDunningFee": { "type": "number", "description": "Mahngeb\u00fchren in Basisw\u00e4hrung" }, "baseDunningInterest": { "type": "number", "description": "Mahnzinsen in Basisw\u00e4hrung" } }, "description": "free payments" }, "erp-finance-PaymentPlanManualRule": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "F\u00e4lligkeit", "format": "date" }, "amount": { "type": "number", "description": "Betrag" }, "processed": { "type": "boolean", "description": "bereits verarbeitet", "readOnly": true }, "currencyCode": { "type": "string", "description": "W\u00e4hrung (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der W\u00e4hrung zu Basisw\u00e4hrung" }, "baseCurrencyCode": { "type": "string", "description": "Basisw\u00e4hrung (ISO-A3)" }, "baseAmount": { "type": "number", "description": "Betrag in Basisw\u00e4hrung" } }, "description": "manuelle Buchungsvorgaben" }, "erp-finance-PaymentPlanChangeRequest": { "type": "object", "properties": { "paymentPlanType": { "type": "string", "description": "Zahlungsplantyp", "enum": [ "RULE", "MANUAL" ] }, "dueDateCalculation": { "type": "string", "description": "F\u00e4lligkeitsregel" }, "clearDueDateCalculation": { "type": "boolean", "description": "F\u00e4lligkeitsregel l\u00f6schen" }, "amount": { "type": "number", "description": "Betrag" }, "clearAmount": { "type": "boolean", "description": "Betrag l\u00f6schen" }, "startDate": { "type": "string", "description": "Startdatum", "format": "date" }, "clearStartDate": { "type": "boolean", "description": "Startdatum l\u00f6schen" }, "endDate": { "type": "string", "description": "Enddatum", "format": "date" }, "clearEndDate": { "type": "boolean", "description": "Enddatum l\u00f6schen" }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv" }, "dueDate": { "type": "string", "description": "F\u00e4lligkeitsdatum", "format": "date" }, "clearDueDate": { "type": "boolean", "description": "F\u00e4lligkeitsdatum l\u00f6schen" }, "manualRuleEntries": { "type": "array", "description": "manuelle Buchungsvorgaben", "items": { "$ref": "#/components/schemas/erp-finance-PaymentPlanManualRule" } } } }, "erp-finance-OpenItemMatchingRule": { "type": "object", "properties": { "version": { "type": "string", "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", "NAME", "CUSTOMER_NUMBER", "SUPPLIER_NUMBER", "AMOUNT", "EXTERNAL_NUMBER" ] }, "points": { "type": "integer", "description": "The number of points to award for fit", "format": "int32" } } }, "erp-finance-Ledger": { "required": [ "ledgerNumber" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "ledgerNumber": { "type": "string", "description": "Ledger number" }, "label": { "type": "string", "description": "label for this account number" } } }, "erp-finance-LedgerAssignment": { "required": [ "assignmentType", "taxPerformanceLocation" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "assignmentType": { "type": "string", "description": "Assignment Type", "enum": [ "SALES_POSITION_LEDGER", "PURCHASE_POSITION_LEDGER", "COMMISSION_POSITION_LEDGER", "BANK_LEDGER", "RECEIVABLE_DUNNING_FEE_LEDGER", "RECEIVABLE_DUNNING_INTEREST_LEDGER", "OPEN_ITEM_MANUAL_CLOSURE", "SALES_PREPAYMENT_TAX_LEDGER", "SALES_PREPAYMENT_TAX_INTERIM_LEDGER", "SALES_PREPAYMENT_DOCUMENTFIELD1_INTERIM_LEDGER", "FINANCIAL_SETTLEMENT_LEDGER", "LEDGER_NOT_RELEVANT_FOR_BUSINESS", "PAYMENT_FEE_LEDGER", "DISCOUNT_GRANTED", "DISCOUNT_RECEIVED", "BANK_TRANSACTION", "POS_PAYMENT_LEDGER", "CASH_JOURNAL_BALANCE_DIFFERENCE", "POS_DEPOSIT_EXPENSE" ] }, "productGroup": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "article": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "validFrom": { "type": "string", "description": "Valid From", "format": "date" }, "validUntil": { "type": "string", "description": "Valid Until", "format": "date" }, "taxRate": { "type": "number", "description": "Tax Rate" }, "taxState": { "type": "string", "description": "Tax State", "enum": [ "TAX_FREE", "TAX_ABLE" ] }, "taxPerformanceLocation": { "type": "string", "description": "Tax Performance Location", "enum": [ "DOMESTIC", "EUROPEAN_COMMUNITY", "INTERNATIONAL" ] }, "sourceCountry": { "type": "string", "description": "Source Country of performance" }, "performanceCountry": { "type": "string", "description": "Performance country" }, "accountNumber": { "maxLength": 20, "type": "string", "description": "Resulting Account Number / Ledger" }, "transactionKey": { "maxLength": 4, "type": "string", "description": "Resulting Transaction Key" }, "comment": { "type": "string", "description": "User comment" }, "costCenter1": { "type": "string", "description": "Cost center 1" }, "taxLiabilityReversedState": { "type": "string", "description": "Tax Liability Reverse Charge State", "enum": [ "IGNORE", "REVERSED", "NOT_REVERSED" ] }, "bankAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "posRegisterRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "posPaymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "posDepositExpenseTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "businessTransactionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "suppressBookings": { "type": "boolean", "description": "Buchungen unterdr\u00fccken", "default": false }, "description": { "type": "string", "description": "Buchungstext" } } }, "core-api-OperationMessage": { "type": "object", "properties": { "context": { "type": "string", "description": "message context" }, "messageValue": { "type": "string", "description": " message" } } }, "erp-finance-DunningLevel": { "required": [ "currencyCode", "description", "dunningAfterDays", "dunningLvl", "fee", "interest", "nextDue" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "dunningLvl": { "type": "integer", "description": "Mahnstufen", "format": "int32" }, "description": { "type": "string", "description": "Beschreibung" }, "nextDue": { "type": "integer", "description": "Zahlungsf\u00e4lligkeit nach Mahnung in Tagen", "format": "int32" }, "dunningTexts": { "type": "array", "description": "Texte in den angebotenen Sprachen f\u00fcr Einzel- und Sammelmahnung", "items": { "$ref": "#/components/schemas/erp-finance-LocalizedContentTemplate" } }, "dunningAfterDays": { "type": "integer", "description": "Karenzzeit nach OP-F\u00e4lligkeit in Tagen", "format": "int32" }, "fee": { "type": "number", "description": "Mahngeb\u00fchr" }, "interest": { "type": "number", "description": "Zinsen" }, "currencyCode": { "type": "string", "description": "W\u00e4hrung", "readOnly": true } } }, "erp-finance-LocalizedContentTemplate": { "required": [ "footerContent", "headerContent", "languageCode", "subjectLine" ], "type": "object", "properties": { "version": { "type": "string", "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": "Sprache des Textes" }, "headerContent": { "type": "string", "description": "Kopftext" }, "footerContent": { "type": "string", "description": "Fu\u00dftext" }, "subjectLine": { "type": "string", "description": "Betreff" }, "dunningLevel": { "type": "integer", "description": "Mahnungs-ID", "format": "int64" } }, "description": "Texte in den angebotenen Sprachen f\u00fcr Einzel- und Sammelmahnung" }, "erp-finance-CostCenter": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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\u00fcr die Kostenstelle" } } }, "erp-finance-BusinessTransaction": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "sortOrder": { "type": "integer", "description": "Sortierung des Gesch\u00e4ftsvorfall", "format": "int64" }, "label": { "type": "string", "description": "Kurze Beschreibung" }, "description": { "type": "string", "description": "Beschreibung des Gesch\u00e4ftsvorfall" } } }, "erp-document-Document": { "required": [ "accountId", "billingType", "calculationMode", "currencyCode", "defaultAddress", "deliveryApproved", "documentDate", "number" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Belegnummer" }, "accountNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Kontonummer der zugeh\u00f6rigen Organisationseinheit", "readOnly": true }, "customerNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Kundennummer", "readOnly": true }, "supplierNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Lieferantennummer", "readOnly": true }, "salesAgentNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Vertreternummer", "readOnly": true }, "externalIdentifier": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Externe Kennung" }, "externalNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Externe Belegnummer" }, "published": { "type": "boolean", "description": "Ist der Beleg ver\u00f6ffentlicht (gedruckt, per Mail versendet)?", "readOnly": true, "default": false }, "qualifier": { "type": "string", "description": "Art des Belegs", "readOnly": true, "enum": [ "SALE", "PURCHASE", "COMMISSION", "SALES_CONTRACT", "PURCHASE_CONTRACT", "POINT_OF_SALE", "FABRICATION" ] }, "accountId": { "type": "string", "description": "ID der Organisationseinheit" }, "billingAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "documentDate": { "type": "string", "description": "Belegdatum", "format": "date" }, "performanceDate": { "type": "string", "description": "Leistungsdatum", "format": "date" }, "valueDate": { "type": "string", "description": "Valutadatum", "format": "date" }, "taxable": { "type": "boolean", "description": "Steuerpflichtig oder steuerfrei", "default": true }, "taxIdentificationNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Umsatzsteuer-Identifikationsnummer" }, "taxIdVerificationState": { "type": "string", "description": "\u00dcberpr\u00fcfungsstatus der Steueridentifikationsnummer", "readOnly": true, "enum": [ "NOT_YET_VERIFIED", "VALID", "VALID_WITH_INVALID_ADDRESS", "INVALID", "NOT_NEEDED" ] }, "valitoolValidationState": { "type": "string", "description": "Validierungsstatus bei elektronischen Rechnungen", "readOnly": true, "enum": [ "NOT_VALIDATED", "VALID", "NOT_VALID" ] }, "billingType": { "type": "string", "description": "Abrechnungstyp", "enum": [ "GROSS", "NET" ] }, "documentType": { "type": "string", "description": "Belegtyp (intern)", "readOnly": true }, "documentTypeId": { "type": "integer", "description": "ID des Belegtyps", "format": "int64", "readOnly": true }, "documentTypeCategory": { "type": "string", "description": "Dokumenttypen", "readOnly": true, "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_CASH_RECEIPT_CANCELLATION", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ] }, "documentState": { "$ref": "#/components/schemas/erp-document-DocumentTypeState" }, "currencyCode": { "type": "string", "description": "W\u00e4hrung (ISO-Code, Alpha-3)" }, "exchangeRate": { "type": "number", "description": "Wechselkurs" }, "exchangeRateOrigin": { "type": "string", "description": "Ursprung f\u00fcr W\u00e4hrungskursermittlung", "enum": [ "AUTOMATIC", "AUTOMATIC_FOR_CURRENT_DATE", "USER_DEFINED" ], "default": "AUTOMATIC" }, "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 }, "paymentTermRef": { "$ref": "#/components/schemas/erp-document-PaymentTermRef" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "depositPaymentAmount": { "type": "number", "description": "Vereinbarter Anzahlungsbetrag" }, "depositPaymentDate": { "type": "string", "description": "Vereinbartes Anzahlungsdatum", "format": "date", "readOnly": true }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryDate": { "type": "string", "description": "Voraussichtliches Lieferdatum", "format": "date" }, "deliveryDateEnd": { "type": "string", "description": "Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)", "format": "date" }, "confirmedDeliveryDate": { "type": "string", "description": "Best\u00e4tigtes Lieferdatum", "format": "date" }, "confirmedDeliveryDateEnd": { "type": "string", "description": "Best\u00e4tigtes Lieferende (nur wenn best\u00e4tigtes Lieferdatum gesetzt)", "format": "date" }, "shippingDate": { "type": "string", "description": "Versanddatum", "format": "date" }, "deliveryQuantityPackages": { "type": "integer", "description": "Voraussichtliche Paketanzahl (nur Info)", "format": "int32" }, "deliveryText": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Zus\u00e4tzlicher Liefertext" }, "deliveryApproved": { "type": "boolean", "description": "Ist der Beleg zur Lieferung freigegeben?", "default": true }, "dropShippingInvoiceApproved": { "type": "boolean", "description": "Ist der Streckengesch\u00e4fts-Beleg zur Rechnung freigegeben?", "readOnly": true }, "orderedOn": { "type": "string", "description": "Bestelldatum", "format": "date" }, "orderedByPersonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "orderedBy": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name der bestellenden Person" }, "taxLiabilityReversed": { "type": "boolean", "description": "Reverse-Charge-Verfahren nach \u00a713b UStG?", "default": false }, "collectiveInvoice": { "type": "boolean", "description": "Sammelrechnung?", "default": false }, "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\u00e4nderungen (z.B. Rabatte)", "items": { "$ref": "#/components/schemas/erp-document-DocumentPriceModifier" } }, "taxes": { "type": "array", "description": "Steuerzusammenfassung f\u00fcr diesen Beleg", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-document-DocumentTax" } }, "defaultAddress": { "$ref": "#/components/schemas/erp-document-DocumentAddress" }, "billingAddress": { "$ref": "#/components/schemas/erp-document-DocumentAddress" }, "deliveryAddress": { "$ref": "#/components/schemas/erp-document-DocumentAddress" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "stackProcessingType": { "type": "string", "description": "Stapelverarbeitungsinformationen f\u00fcr Auftr\u00e4ge", "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", "description": "Priorit\u00e4t in der Stapelverarbeitung", "format": "int32" }, "maxDeliveries": { "type": "integer", "description": "Maximal m\u00f6gliche Lieferungen", "format": "int32" }, "taxPerformanceLocation": { "type": "string", "description": "Ort der steuerlichen Leistungserbringung", "enum": [ "DOMESTIC", "EUROPEAN_COMMUNITY", "INTERNATIONAL" ] }, "performanceCountryCode": { "type": "string", "description": "L\u00e4nderkennzeichen Leistungsland (ISO Alpha-3)" }, "sourceCountryCode": { "type": "string", "description": "L\u00e4nderkennzeichen 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", "description": "Gesamtgewicht wurde manuell gesetzt", "default": false }, "tags": { "type": "array", "description": "Tags f\u00fcr 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\u00e4higer 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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Leitweg-ID" }, "en16931Profile": { "type": "string", "description": "EN16931-Profil f\u00fcr elektronische Rechnungen", "enum": [ "ZUGFERD", "XRECHNUNG", "NO_EN_PROFILE" ] }, "importType": { "type": "string", "description": "Importmodus des Belegs", "readOnly": true, "enum": [ "NOT_IMPORTED", "TRANSFERABLE", "TRANSFERABLE_AND_EDITABLE", "HISTORICAL_DATA", "E_INVOICE" ] }, "paymentPlan": { "type": "boolean", "description": "Zahlungsplan vorhanden?", "default": false }, "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\u00e4hrung des Belegs" }, "baseTotalNetPrice": { "type": "number", "description": "Gesamtpreis - Netto Basisw\u00e4hrung" }, "baseTotalLinePriceModifier": { "type": "number", "description": "Preisanpassungen - Belegpositionssumme Basisw\u00e4hrung" }, "baseTotalDocumentPriceModifier": { "type": "number", "description": "Preisanpassungen - Beleg Basisw\u00e4hrung" }, "baseTotalGrossPrice": { "type": "number", "description": "Gesamtpreis - Brutto Basisw\u00e4hrung" }, "baseDepositPaymentAmount": { "type": "number", "description": "Vorkassebetrag Basisw\u00e4hrung" }, "baseCashDiscountableTotalGrossPrice": { "type": "number", "description": "skontierbarer Rechnungsbetrag Basisw\u00e4hrung" }, "forwardEmailToShipper": { "type": "boolean", "description": "E-Mail an Versender \u00fcbergeben", "default": false }, "forwardPhoneToShipper": { "type": "boolean", "description": "Telefon an Versender \u00fcbergeben", "default": false }, "posReceiptPaymentSum": { "type": "number", "description": "Quittung: Summe Zahlbetrag" }, "posReceiptBalance": { "type": "number", "description": "Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: \u00fcberzahlter Betrag / R\u00fcckgeld\n" }, "posReceiptChangeAmount": { "type": "number", "description": "R\u00fcckgeld" }, "posReceiptBalanced": { "type": "boolean", "description": "Ist die Quittung ausbalanciert, also bezahlt und kein R\u00fcckgeld\ntrue wenn die Quittung ausbalanciert ist\n", "default": false }, "posReceiptPayed": { "type": "boolean", "description": "Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n", "default": false }, "dropShipping": { "type": "boolean", "description": "Streckengesch\u00e4ft", "readOnly": true }, "totalGrossVolumeInCubicMeters": { "type": "number", "description": "total gross Volume in cubic meters", "readOnly": true } }, "description": "document to update" }, "erp-document-DocumentAdditionalInfo": { "type": "object", "properties": { "calculationModeOrigin": { "type": "string", "description": "Herkunft des Berechnungsmodus", "readOnly": true, "enum": [ "FROM_BILLING_ADDRESS", "FROM_DEFAULT_ADDRESS", "FROM_ACCOUNT", "FROM_SALES_CHANNEL", "FROM_DOCUMENT_PARAMS", "USER_DEFINED" ] }, "en16931Origin": { "type": "string", "description": "Herkunft des E-Rechnungs-Profils", "readOnly": true, "enum": [ "FROM_BILLING_ADDRESS", "FROM_DEFAULT_ADDRESS", "FROM_ACCOUNT_PARAMS", "USER_DEFINED" ] }, "buyerReferenceOrigin": { "type": "string", "description": "Herkunft der K\u00e4ufer-Referenz", "readOnly": true, "enum": [ "FROM_BILLING_ADDRESS", "FROM_DEFAULT_ADDRESS", "USER_DEFINED" ] }, "previousDecisions": { "type": "string", "description": "Enth\u00e4lt 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_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-IncomingGoodsTarget" }, "translations": { "type": "array", "description": "\u00dcbersetzungen", "items": { "$ref": "#/components/schemas/erp-document-PrintedTranslatedField" } }, "incomingGoodsTargetsPerLine": { "type": "array", "description": "Ziele f\u00fcr den Wareneingang je Belegposition", "items": { "$ref": "#/components/schemas/erp-document-IncomingGoodsTargetOfLine" } }, "orderIntoPickingConvertResults": { "type": "array", "description": "Ergebnisse zu \u00dcbernahme \"Auftrag in Kommissionierung\"", "items": { "$ref": "#/components/schemas/erp-document-OrderIntoPickingConvertResult" } } }, "description": "Zus\u00e4tzliche Infos zu Entscheidungen im Belegkontext" }, "erp-document-DocumentAddress": { "type": "object", "properties": { "version": { "type": "string", "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" }, "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" } }, "description": "Lieferadresse" }, "erp-document-DocumentContractDetail": { "required": [ "dueDateCalculation" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Vertragsstart (nur Kopf)", "format": "date" }, "endDate": { "type": "string", "description": "Vertragsende (nur Kopf)", "format": "date" }, "runtimeFromDate": { "type": "string", "description": "Laufzeit von", "format": "date" }, "runtimeToDate": { "type": "string", "description": "Laufzeit bis", "format": "date" }, "lastCustomerCancellationDate": { "type": "string", "description": "Letztm\u00f6glicher k\u00fcndigungstermin des Kunden", "format": "date" }, "lastProviderCancellationDate": { "type": "string", "description": "Letztm\u00f6glicher k\u00fcndigungstermin des Anbieters", "format": "date" }, "dueDateCalculation": { "type": "string", "description": "Cron-Ausdruck zur Berechnung der F\u00e4lligkeit" }, "dueDate": { "type": "string", "description": "F\u00e4lligkeit", "format": "date" }, "nextDueDate": { "type": "string", "description": "N\u00e4chste F\u00e4lligkeit", "format": "date" }, "calculateDirectly": { "type": "boolean", "description": "Direkt abrechnen?" }, "active": { "type": "boolean", "description": "Vertrag aktiv?", "default": true }, "publishInPortal": { "type": "boolean", "description": "Portal anzeigen?", "default": false } }, "description": "Vertragsdetails" }, "erp-document-DocumentFinanceBooking": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Id der Dokumentzeile", "format": "int64" }, "ledgerNumber": { "type": "string", "description": "FiBu-Kontonummer" }, "transactionKey": { "type": "string", "description": "Buchungsschl\u00fcssel" }, "costCenter1": { "type": "string", "description": "Kostenstelle" }, "comment": { "type": "string", "description": "Kommentar" }, "description": { "type": "string", "description": "Buchungstext" } }, "description": "FiBu-Buchung" }, "erp-document-DocumentLine": { "required": [ "lineType" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Positions-Nummer", "format": "int32", "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" ] }, "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", "readOnly": true, "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "DOUBLE_SERIAL_NUMBER" ] }, "number": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Artikelnummer" }, "name": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name des Artikels" }, "description": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "Beschreibung des Artikels" }, "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", "readOnly": true, "enum": [ "USER_DEFINED", "PRODUCT", "PREDECESSOR_DOCUMENT", "PICKLIST" ] }, "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", "description": "ist diese Position komplett verarbeitet?", "readOnly": true, "default": false }, "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\u00e4nderungen [Brutto, Netto]", "readOnly": true }, "totalDocumentPriceModifier": { "type": "number", "description": "Summe Dokumentpreis\u00e4nderungen [Brutto, Netto]", "readOnly": true }, "priceModifiers": { "type": "array", "description": "angewendete Preis\u00e4nderungen", "items": { "$ref": "#/components/schemas/erp-document-DocumentPriceModifier" } }, "salesValueNet": { "type": "number", "description": "Netto-Gesamtpreis (nach Preis\u00e4nderungen)", "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" } }, "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": { "maxLength": 15, "minLength": 0, "type": "string", "description": "Zolltarifnummer" }, "deliveryDate": { "type": "string", "description": "Lieferdatum", "format": "date" }, "deliveryDateEnd": { "type": "string", "description": "vorr. Ende des Lieferzeitraums (nur notwendig f\u00fcr Lieferzeitr\u00e4ume, wenn Lieferdatum gesetzt)", "format": "date" }, "confirmedDeliveryDate": { "type": "string", "description": "best\u00e4tigtes Lieferdatum", "format": "date" }, "confirmedDeliveryDateEnd": { "type": "string", "description": "best\u00e4tigtes Ende des Lieferzeitraums (nur notwendig f\u00fcr Lieferrzeitr\u00e4ume, wenn Lieferdatum gesetzt)", "format": "date" }, "shippingDate": { "type": "string", "description": "Versanddatum", "format": "date" }, "deliveryText": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Liefertext" }, "packageOptions": { "type": "string", "description": "Versenderspezifische Informationen" }, "externalReferenceVds": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Externe Referenz zum VDS-Paket" }, "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" }, "sourceLineRef": { "$ref": "#/components/schemas/erp-document-DocumentLineRef" }, "baseLineId": { "type": "integer", "description": "Referenz zur Basiszeile", "format": "int64" }, "customerOrderLineRef": { "$ref": "#/components/schemas/erp-document-DocumentLineRef" }, "supplierOrderLineIds": { "type": "array", "description": "Referenz zur Lieferantenbestellungszeile", "items": { "type": "integer", "description": "Referenz zur Lieferantenbestellungszeile", "format": "int64" } }, "storage": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "components": { "type": "array", "description": "Komponenten", "items": { "$ref": "#/components/schemas/erp-document-DocumentLineComponent" } }, "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", "description": "Vorgabe \u00a713b UStG Artikel", "readOnly": true, "default": false }, "taxLiabilityReversed": { "type": "boolean", "description": "wird \u00a713b UStG angewendet?", "readOnly": true, "default": false }, "presetPrice": { "type": "number", "description": "Vorgabewert f\u00fcr 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", "description": "skontierbare Position?", "default": true }, "discountable": { "type": "boolean", "description": "rabattierbare Position?", "default": true }, "commissionable": { "type": "boolean", "description": "provisionierbare Position?", "default": false }, "warrantyInMonths": { "type": "integer", "description": "Garantie in Monaten", "format": "int32" }, "contractDetail": { "$ref": "#/components/schemas/erp-document-DocumentContractDetail" }, "posDetail": { "$ref": "#/components/schemas/erp-document-DocumentLinePosDetail" }, "fabricationDetail": { "$ref": "#/components/schemas/erp-fabrication-DocumentLineFabricationDetail" }, "financeBooking": { "$ref": "#/components/schemas/erp-document-DocumentFinanceBooking" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "variantValues": { "type": "array", "description": "Produktvariantenwerte", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "performanceDate": { "type": "string", "description": "Leistungsdatum", "format": "date" }, "basePrice": { "type": "number", "description": "Preis pro Einheit in Basisw\u00e4hrung" }, "baseTotalLinePriceModifier": { "type": "number", "description": "Preisanpassungen - Position Basisw\u00e4hrung" }, "baseTotalDocumentPriceModifier": { "type": "number", "description": "Preisanpassungen - anteilig durch Beleg Basisw\u00e4hrung" }, "baseTotalLinePrice": { "type": "number", "description": "Gesamtpreis Position in Basisw\u00e4hrung" }, "baseSalesValueNet": { "type": "number", "description": "Nettoverkaufswert der Position in Basisw\u00e4hrung" }, "partialInvoice": { "type": "boolean", "description": "Abschlagsposition?", "default": false }, "dropShippingPolicy": { "type": "string", "description": "Definiert, ob und wie ein Artikel per Streckengesch\u00e4ft 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" } }, "description": "Liste der Belegpositionen" }, "erp-document-DocumentLineBooking": { "required": [ "quantity", "storageBinRef" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Seriennummer 1" }, "serialNumber2": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Seriennummer 2" }, "expiryDate": { "type": "string", "description": "Haltbarkeitsdatum", "format": "date" }, "note": { "type": "string", "description": "Notiz" }, "udi": { "type": "string", "description": "Unique Device Identifier (UDI)" } }, "description": "Buchungen" }, "erp-document-DocumentLineCommission": { "required": [ "origin", "salesAgentAccountRef", "value", "valueType" ], "type": "object", "properties": { "version": { "type": "string", "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" } }, "description": "Provisionen" }, "erp-document-DocumentLineComponent": { "required": [ "quantity" ], "type": "object", "properties": { "version": { "type": "string", "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", "readOnly": true, "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "DOUBLE_SERIAL_NUMBER" ] }, "quantity": { "type": "number", "description": "Menge" }, "quantityCommitted": { "type": "number", "description": "Gelieferte Menge" }, "pickingQuantity": { "type": "number", "description": "Menge in Kommissionierung" }, "quantityPerAssemblyGroup": { "type": "number", "description": "Menge pro Baugruppe" }, "name": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name des Artikels" }, "description": { "maxLength": 2048, "minLength": 0, "type": "string", "description": "Beschreibung des Artikels" }, "position": { "type": "integer", "description": "Position der Komponente in der Baugruppe", "format": "int32" }, "sourceDocumentLineComponentId": { "type": "integer", "description": "Referenz auf die Komponente im Quell-Document", "format": "int64" }, "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" } }, "description": "Komponenten" }, "erp-document-DocumentLinePosDetail": { "type": "object", "properties": { "version": { "type": "string", "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" ] }, "depositExpenseTypeId": { "type": "integer", "description": "Typ der Einlage/Ausgabe", "format": "int64" }, "paymentMethodId": { "type": "integer", "description": "Zahlungsart", "format": "int64" } }, "description": "Kasseninformationen" }, "erp-document-DocumentLineRef": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Id der Dokumentzeile", "format": "int64" }, "documentId": { "type": "integer", "description": "Id des Dokuments", "format": "int64" }, "category": { "type": "string", "description": "Dokumenttypen", "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_CASH_RECEIPT_CANCELLATION", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "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", "description": "Positions-Nummer", "format": "int32" }, "name": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "Artikelbezeichnung" }, "quantity": { "type": "number", "description": "quantity" }, "price": { "type": "number", "description": "price per quantity [GROSS, NET]" }, "displayName": { "type": "string", "description": "Kurzbezeichnung des Kunden" } }, "description": "Referenz auf eine Documentline" }, "erp-document-DocumentPosDetail": { "type": "object", "properties": { "version": { "type": "string", "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" }, "tssSignature": { "$ref": "#/components/schemas/erp-pos-TssSignature" } }, "description": "Quittungsdetails" }, "erp-document-DocumentPosPayment": { "required": [ "amount", "posLineType" ], "type": "object", "properties": { "version": { "type": "string", "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" ] }, "depositExpenseTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "posPaymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Kassen-Zahlung im Beleg" }, "erp-document-DocumentPriceModifier": { "required": [ "modifierType", "value", "valueType" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "ID of Source entity of price modifier", "format": "int64" }, "modifierType": { "type": "string", "description": "modifierType", "enum": [ "DISCOUNT", "SURCHARGE" ] }, "baseValue": { "type": "number", "description": "Wert des Modifiers in Basisw\u00e4hrung" }, "baseCalculatedValue": { "type": "number", "description": "Berechneter Wert des Modifiers in Basisw\u00e4hrung" } }, "description": "Preis\u00e4nderungen (z.B. Rabatte)" }, "erp-document-DocumentShippingCost": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Wurden die Versandkosten manuell eingetragen?", "default": false }, "freeShipping": { "type": "boolean", "description": "Keine Versandkosten (freier Versand)", "default": false }, "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" } }, "description": "Versandkosten im Beleg" }, "erp-document-DocumentTax": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Steuerfrei?", "default": false }, "baseTaxableAmount": { "type": "number", "description": "Besteuerbarer Betrag in Basisw\u00e4hrung" }, "baseTaxValue": { "type": "number", "description": "Steuerbetrag in Basisw\u00e4hrung" }, "baseGrossAmount": { "type": "number", "description": "Bruttobetrag in Basisw\u00e4hrung" } }, "description": "Steuerzusammenfassung f\u00fcr diesen Beleg" }, "erp-document-DocumentText": { "required": [ "deleted" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "position relative to the product line OR Document. For usage within text-line, this position is irrelevant", "enum": [ "HEADER_TEXT", "FOOTER_TEXT" ], "default": "HEADER_TEXT" }, "content": { "type": "string", "description": "if this attribute is used, the text is used as free-text" }, "transferableIntoSubsequentDocuments": { "type": "boolean", "description": "Does this text remain after transfer into a subsequent document", "default": true }, "deleted": { "type": "boolean", "description": "Wurde entfernt und soll deshalb nicht mehr angezeigt werden.", "default": false } }, "description": "Texte" }, "erp-document-DocumentTypeState": { "required": [ "key", "label" ], "type": "object", "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" ] } }, "description": "Statusinstanz des Belegs" }, "erp-document-DocumentUpdateRequest": { "required": [ "document" ], "type": "object", "properties": { "document": { "$ref": "#/components/schemas/erp-document-Document" }, "parameters": { "type": "array", "description": "additional parameters for transition", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-document-IncomingGoodsTarget": { "type": "object", "properties": { "storageBinId": { "type": "integer", "description": "Lagerplatz f\u00fcr den Wareneingang", "format": "int64" }, "pickTrolleyId": { "type": "integer", "description": "Pickwagen f\u00fcr den Wareneingang", "format": "int64" } }, "description": "Ziele f\u00fcr den Wareneingang" }, "erp-document-IncomingGoodsTargetOfLine": { "type": "object", "properties": { "storageBinId": { "type": "integer", "description": "Lagerplatz f\u00fcr den Wareneingang", "format": "int64" }, "pickTrolleyId": { "type": "integer", "description": "Pickwagen f\u00fcr den Wareneingang", "format": "int64" }, "lineId": { "type": "integer", "description": "ID einer Belegposition", "format": "int64" }, "sourceLineId": { "type": "integer", "description": "ID einer Vorbelegposition", "format": "int64" } }, "description": "Ziele f\u00fcr den Wareneingang" }, "erp-document-OrderIntoPickingConvertResult": { "type": "object", "properties": { "testRun": { "type": "boolean", "description": "War es eine Test\u00fcbernahme?", "default": false }, "success": { "type": "boolean", "description": "War die \u00dcbernahme erfolgreich?", "default": false }, "logText": { "type": "string", "description": "Protokoll der \u00dcbernahme" } }, "description": "Ergebnis der \u00dcbernahme eines Auftrags in Kommissionierung" }, "erp-document-PaymentTermRef": { "required": [ "id", "paymentType" ], "type": "object", "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" ] } }, "description": "Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse" }, "erp-document-PrintedTranslatedField": { "type": "object", "properties": { "entityName": { "type": "string", "description": "zur welcher Entity?" }, "fieldName": { "type": "string", "description": "name des Feldes" }, "content": { "type": "string", "description": "\u00dcbersetzung" } }, "description": "\u00dcbersetzungen" }, "erp-document-RevenueCalculation": { "type": "object", "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 } }, "description": "Rohertragsermittlung" }, "erp-fabrication-DocumentFabricationDetail": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Startdatum", "format": "date" }, "minimumDegreeOfFulfillment": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Minimaler Erf\u00fcllungsgrad", "format": "int32" }, "note": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "Notiz" }, "componentsStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "workbenchStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "qualityAssuranceStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defectiveStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "Produktionsdetails" }, "erp-fabrication-DocumentLineComponentFabricationDetail": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "F\u00fcr S/N-Vererbung verwenden", "default": false }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "Produktionsdetails zu einer Komponente" }, "erp-fabrication-DocumentLineFabricationDetail": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "Produktionsdetails zu einer Position" }, "erp-pos-TssSignature": { "type": "object", "properties": { "status": { "type": "string", "description": "Status der Signierung", "enum": [ "OK", "ERROR" ] }, "responseData": { "type": "string", "description": "Antwortdaten der TSS" }, "externalReference": { "type": "string", "description": "Externe Referenz", "readOnly": true }, "revision": { "type": "integer", "description": "Revision", "format": "int32", "readOnly": true } }, "description": "TSS Signatur" }, "erp-product-PriceSelectionCriteria": { "type": "object", "properties": { "qualifier": { "type": "string", "description": "ein qualifier", "enum": [ "SALES", "PURCHASE" ] }, "articleIds": { "type": "array", "description": "Liste von Artikel-IDs", "items": { "type": "integer", "description": "Liste von Artikel-IDs", "format": "int64" } }, "selectOnlyDefaultPrice": { "type": "boolean", "description": "soll nur der Standardpreis selektiert werden?", "default": false }, "accountIds": { "type": "array", "description": "Liste von Account-IDs", "items": { "type": "integer", "description": "Liste von Account-IDs", "format": "int64" } }, "productGroupId": { "type": "integer", "description": "Die Warengruppe", "format": "int64" }, "priceGroupId": { "type": "integer", "description": "Die Preisgruppe", "format": "int64" }, "manufacturerId": { "type": "integer", "description": "Ein Herstellet", "format": "int64" }, "date": { "type": "string", "description": "Ein Datum", "format": "date" }, "quantity": { "type": "number", "description": "Eine Menge" }, "noteSpecialOfferPrice": { "type": "boolean", "description": "Aktionspreis beachten?" }, "discountGroupId": { "type": "integer", "description": "Die Rabattgruppe", "format": "int64" } }, "description": "Preisermittlungskriterien" }, "erp-account-AccountLoanValue": { "required": [ "accountId" ], "type": "object", "properties": { "accountId": { "type": "integer", "description": "Account", "format": "int64" }, "maximalLoan": { "type": "number", "description": "Kreditlimit" }, "currentLoan": { "type": "number", "description": "Aktueller Kredit" }, "nonInvoicedDocumentLoan": { "type": "number", "description": "Betrag aus Auftr\u00e4gen" }, "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": "\u00dcbriger Betrag bis zum Erreichen des Kreditlimits" }, "exceededLoan": { "type": "number", "description": "\u00dcberschrittener Kreditbetrag" }, "unconsideredAmount": { "type": "number", "description": "Nicht ber\u00fccksichtigter Betrag" } }, "description": "Aktuell berechnete Werte zum Kreditlimit eines Accounts" }, "erp-document-DocumentResponse": { "type": "object", "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": { "type": "object", "properties": { "details": { "type": "array", "description": "Hinweise aus der Validierung im Error-Format", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } } }, "description": "Hinweise" }, "erp-document-DocumentViewOptions": { "type": "object", "properties": { "revenueCalculation": { "$ref": "#/components/schemas/erp-document-RevenueCalculation" }, "loanValue": { "$ref": "#/components/schemas/erp-account-AccountLoanValue" }, "considerForCreditLimit": { "type": "boolean", "description": "Wird dieser Beleg f\u00fcr das Kreditlimit ber\u00fccksichtigt", "readOnly": true }, "financeJournalAccountingInformation": { "$ref": "#/components/schemas/erp-finance-FinanceJournalAccountingInformation" }, "possiblePredecessorTypes": { "type": "array", "description": "m\u00f6gliche Vorbeleg-Typen", "items": { "type": "string", "description": "m\u00f6gliche Vorbeleg-Typen" } }, "sumAmountOfPartialInvoices": { "type": "number", "description": "Gesamtbetrag der Abschlagsrechnungen" }, "sumOpenAmountForPartialInvoices": { "type": "number", "description": "offener Gesamtbetrag f\u00fcr Abschlagsrechnungen" }, "totalAmountDependingFromBillingType": { "type": "number", "description": "Gesamtbetrag abh. von der Fakturierungsart" } }, "description": "Extra-Anzeigen" }, "erp-finance-FinanceJournalAccountingInformation": { "type": "object", "properties": { "accountingStatus": { "type": "string", "description": "Fibu-Status Dokumenten-Journaleintrag", "readOnly": true, "enum": [ "PROCESSING", "OPEN", "IGNORED", "COMMITTED", "COMMITTED_REVERTABLE" ] }, "financeBookingRunRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accountingStatusUpdatedDate": { "type": "string", "description": "Fibu-\u00dcbergabedatum", "format": "date-time", "readOnly": true }, "runState": { "type": "string", "description": "Verarbeitungsstatus", "readOnly": true, "enum": [ "PROCESSING", "OPEN", "COMMITTABLE", "COMMITTED", "REVERTED" ] } }, "description": "Fibu-Informationen" }, "erp-account-Account": { "required": [ "address", "businessRelationType" ], "type": "object", "properties": { "version": { "type": "string", "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", "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", "description": "Is account active?", "readOnly": true, "default": true }, "taxNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "tax number/ Steuernummer" }, "remark": { "maxLength": 1024, "minLength": 0, "type": "string", "description": "Sonderbemerkung" }, "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\u00dfer 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" }, "tags": { "type": "array", "description": "List of tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "localCourt": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Zust\u00e4ndiges Amtsgericht" }, "companyRegister": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Handelsregister-Kennung" }, "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", "description": "Erstkontakt am", "format": "date" }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "taxLiabilityReversed": { "type": "boolean", "description": "Umkehrung der Steuerschuld nach \u00a713b UStG?", "default": false }, "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", "description": "Mahnsperre", "default": false }, "payablesSum": { "type": "number", "description": "Summe Verbindlichkeiten", "readOnly": true }, "payablesSumCurrencyCode": { "type": "string", "description": "W\u00e4hrung 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\u00e4hrung Summe Forderungen IsoAlpha3", "readOnly": true }, "loanValue": { "$ref": "#/components/schemas/erp-account-AccountLoanValue" }, "loanCurrencyCode": { "type": "string", "description": "W\u00e4hrung 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", "description": "Has this Account a possible duplicate", "default": false }, "businessRelationType": { "type": "string", "description": "Gesch\u00e4ftsbeziehungs-Typen f\u00fcr Gesch\u00e4ftspartner", "enum": [ "B2B", "B2C", "B2G" ] } } }, "erp-account-AccountAddress": { "required": [ "name1" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name1" }, "name2": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name2" }, "name3": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name3" }, "defaultAddress": { "type": "boolean", "description": "is this the default address of the account", "readOnly": true, "default": false }, "types": { "type": "array", "description": "the kind of usages for this address", "items": { "type": "string", "description": "the kind of usages for this address", "enum": [ "DELIVERY_ADDRESS", "BRANCH_ADDRESS", "RETURNED_ITEM_ADDRESS", "BILLING_ADDRESS", "OTHER" ] } }, "street": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Street" }, "globalLocationNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "GLN/ILN as location identifier for this address" }, "streetAddressNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Street address number" }, "additionalAddressLine1": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Additional address line1" }, "additionalAddressLine2": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Additional address line2" }, "city": { "maxLength": 255, "minLength": 0, "type": "string", "description": "City" }, "postcode": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Postcode" }, "en16931Profile": { "type": "string", "description": "EN16931 Profil", "enum": [ "ZUGFERD", "XRECHNUNG", "NO_EN_PROFILE" ] }, "taxIdentificationNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "tax identification number/ UST-ID-Nr." }, "taxIdVerificationState": { "type": "string", "description": "\u00dcberpr\u00fcfungsstatus der Steueridentifikationsnummer", "readOnly": true, "enum": [ "NOT_YET_VERIFIED", "VALID", "VALID_WITH_INVALID_ADDRESS", "INVALID", "NOT_NEEDED" ] }, "homepageUrl": { "type": "string", "description": "Homepage URL" }, "regionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "countryCode": { "type": "string", "description": "Country code" }, "longitude": { "type": "number", "description": "Longitude", "format": "double" }, "latitude": { "type": "number", "description": "latitude", "format": "double" }, "remark": { "maxLength": 1024, "minLength": 0, "type": "string", "description": "Sonderbemerkung" }, "postOfficeBox": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Post office box" }, "buyerReference": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Leitweg-ID" }, "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" } }, "description": "Alle Adressen au\u00dfer der Standard-Adresse" }, "erp-account-AccountPerson": { "required": [ "lastName" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Label" }, "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "First name" }, "middleName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Middle name" }, "lastName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Lastname" }, "gender": { "type": "string", "description": "Gender", "enum": [ "MALE", "FEMALE", "ETC" ] }, "locale": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Locale" }, "jobArea": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Job area" }, "jobTypeRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date" }, "sortOrder": { "type": "integer", "description": "sortierreihenfolge", "format": "int64" }, "remark": { "maxLength": 1024, "minLength": 0, "type": "string", "description": "Sonderbemerkung" }, "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", "description": "Erstkontakt am", "format": "date" }, "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "defaultPerson": { "type": "boolean", "description": "Standard-Ansprechpartner", "readOnly": true, "default": false } }, "description": "Ansprechpartner" }, "erp-account-AccountRelation": { "required": [ "relatedAccountRef", "relationType" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "customRelatedTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "comment": { "type": "string", "description": "Comment" }, "relationType": { "type": "string", "description": "Relation type", "enum": [ "CUSTOM", "SALES_AGENT", "BILLING_ACCOUNT" ] } }, "description": "Account-Beziehungen" }, "erp-account-Contact": { "required": [ "value" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "A Value" }, "typeId": { "type": "string", "description": "Type identifier" }, "type": { "type": "string", "description": "Contact type", "enum": [ "PHONE", "SOCIAL", "EMAIL", "FAX", "SKYPE", "MS_TEAMS", "CUSTOM", "MOBILE" ] }, "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Contact label" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "default": { "type": "boolean", "description": "Is default contact?", "default": false } }, "description": "List of contacts" }, "erp-account-Customer": { "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "number of customer" }, "active": { "type": "boolean", "description": "active true/false", "readOnly": true, "default": true }, "accountingNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "finance account-number of customer" }, "taxable": { "type": "boolean", "description": "tax able or tax free", "default": true }, "deliveryBlocked": { "type": "boolean", "description": "Hat der Kunde eine Liefersperre?", "default": false }, "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\u00fcr Auftr\u00e4ge", "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", "description": "Priorit\u00e4t f\u00fcr die Stapelverarbeitung", "format": "int32" }, "maxDeliveries": { "type": "integer", "description": "Maximal m\u00f6gliche Lieferungen", "format": "int32" }, "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", "description": "collective billable", "default": false }, "collectiveInvoicePeriodicity": { "type": "string", "description": "periodicity of collective invoice", "enum": [ "MANUAL" ], "default": "MANUAL" } }, "description": "Customer of this account" }, "erp-account-SalesAgent": { "required": [ "billingType", "commissionType", "deliveryMethodRef", "deliveryTermRef", "paymentMethodRef", "paymentTermRef", "taxRateRef", "taxable" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "active true/false", "readOnly": true, "default": true }, "number": { "maxLength": 255, "minLength": 0, "type": "string", "description": "number of sales agent" }, "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" } }, "description": "Sales Agent of this account" }, "erp-account-Supplier": { "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "finance account-number of supplier" }, "active": { "type": "boolean", "description": "active true/false", "readOnly": true, "default": true }, "dunning": { "type": "boolean", "description": "Mahnen?", "default": false }, "number": { "maxLength": 255, "minLength": 0, "type": "string", "description": "number of supplier" }, "ourNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "suppliers number for us" }, "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" }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defaultDeliveryTime": { "type": "integer", "description": "Lieferzeit in (Werk-)Tagen", "format": "int32" }, "performanceCountryCode": { "type": "string", "description": "country code performance country IsoAlpha3" }, "taxable": { "type": "boolean", "description": "tax able or tax free", "default": true }, "currencyCode": { "type": "string", "description": "currency code IsoAlpha3" }, "permissibleForOrderProposal": { "type": "boolean", "description": "zul\u00e4ssig f\u00fcr Aufnahme in Bestellvorschl\u00e4ge", "default": true }, "minimumOrderValue": { "type": "number", "description": "Mindestbestellwert" }, "freeShippingValue": { "type": "number", "description": "Frachtkostenfrei ab" }, "supplierGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "createCustomerDeliveryWhenDropShipping": { "type": "boolean", "description": "Erzeugung Ausgangs-Lieferschein bei Streckengesch\u00e4ft-Bestellung", "default": false }, "dropShippingAllowed": { "type": "boolean", "description": "Kennzeichen, ob Streckengesch\u00e4ft erlaubt", "default": false } }, "description": "Supplier of this account" }, "erp-account-TaxIdForeignCountry": { "type": "object", "properties": { "version": { "type": "string", "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" } }, "description": "Eine List von Steuernummern" }, "erp-document-DocumentStateTransitionRequest": { "required": [ "transitionId" ], "type": "object", "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" } } }, "erp-document-DocumentType": { "required": [ "category" ], "type": "object", "properties": { "version": { "type": "string", "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_DELIVERY_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_CASH_RECEIPT_CANCELLATION", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ] }, "showForManualDocumentCreation": { "type": "boolean", "description": "Darf dieser Typ zur Neuanlage von Belegen verwendet werden?", "default": true }, "nextNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "n\u00e4chste Belegnummer", "readOnly": true }, "followUpDocumentTypes": { "type": "array", "description": "follow up document types", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" } }, "defaultTypeOfCategory": { "type": "boolean", "description": "ist diese Belegart die Standard-Belegart f\u00fcr ihre Kategorie?", "default": false }, "active": { "type": "boolean", "description": "ist diese Belegart aktiv", "default": true }, "shelfDocumentTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "sequencerConfiguration": { "$ref": "#/components/schemas/common-sequencer-SequencerConfiguration" }, "requiresBusinessRelationship": { "type": "boolean", "description": "Gesch\u00e4ftsbeziehung verpflichtend", "default": true }, "sortOrder": { "type": "integer", "description": "Sortierung", "format": "int32" } }, "description": "target document type for document copy" }, "erp-document-DocumentTypeFollowUp": { "required": [ "sourceDocumentTypeRef", "targetDocumentTypeRef" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "ist diese Folge-Belegart aktiv", "readOnly": true, "default": true } }, "description": "follow up document types" }, "erp-document-DocumentTypeLabel": { "required": [ "label", "labelPrintout", "languageCode" ], "type": "object", "properties": { "version": { "type": "string", "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)" } }, "description": "label/name of this type" }, "erp-document-RequestDocument": { "type": "object", "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" }, "billingType": { "type": "string", "description": "billing type", "enum": [ "GROSS", "NET" ] }, "calculationMode": { "type": "string", "description": "calculation mode", "enum": [ "HORIZONTAL", "VERTICAL" ] }, "documentDate": { "type": "string", "description": "Belegdatum", "format": "date" }, "performanceDate": { "type": "string", "description": "Leistungsdatum", "format": "date" }, "lines": { "type": "array", "description": "Dokumentzeilen", "items": { "$ref": "#/components/schemas/erp-document-RequestDocumentLine" } }, "targetDocumentType": { "$ref": "#/components/schemas/erp-document-DocumentType" }, "incomingGoodsPickTrolleyId": { "type": "integer", "description": "ID vom Pickwagen f\u00fcr den Wareneingang (wenn incomingGoodsStorageBinId = null)", "format": "int64" }, "incomingGoodsStorageBinId": { "type": "integer", "description": "ID vom Lagerplatz f\u00fcr den Wareneingang (wenn incomingGoodsPickTrolleyId = null)", "format": "int64" }, "priceModifiers": { "type": "array", "description": "Die Rabatte des Beleges", "items": { "$ref": "#/components/schemas/erp-document-RequestDocumentPriceModifier" } }, "posRegisterId": { "type": "integer", "description": "ID der Kasse (bei POS)", "format": "int64" }, "cashDrawerId": { "type": "integer", "description": "ID der Kassenschublade (bei POS)", "format": "int64" }, "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" } }, "einvoice": { "type": "boolean" } }, "description": "Details zum zu erstellenden oder zu bearbeitenden Beleg" }, "erp-document-RequestDocumentLine": { "type": "object", "properties": { "name": { "type": "string", "description": "Artikelname" }, "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\u00f6rige Position in einem externen System" }, "productPrice": { "type": "number", "description": "(optional) Preis des Artikels dieser Position" }, "priceModifiers": { "type": "array", "description": "(optional) Liste von Preismodifikatoren f\u00fcr diese Position", "items": { "$ref": "#/components/schemas/erp-document-RequestDocumentPriceModifier" } }, "texts": { "type": "array", "description": "(optional) Liste von Texten f\u00fcr 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", "description": "Soll die Quellposition nach erfolgreicher Verarbeitung als abgeschlossen markiert werden?", "default": false }, "supplierAccountId": { "type": "integer", "description": "Wird f\u00fcr die Umwandlung von Kundenauftrag in Lieferantenauftrag ben\u00f6tigt", "format": "int64" }, "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" ] }, "financeBooking": { "$ref": "#/components/schemas/erp-document-DocumentFinanceBooking" }, "contractDetail": { "$ref": "#/components/schemas/erp-document-DocumentContractDetail" }, "posDetail": { "$ref": "#/components/schemas/erp-document-DocumentLinePosDetail" }, "incomingGoodsPickTrolleyId": { "type": "integer", "description": "ID des Pickwagens f\u00fcr den Wareneingang (wenn `incomingGoodsStorageBinId` = null)", "format": "int64" }, "incomingGoodsStorageBinId": { "type": "integer", "description": "ID des Lagerplatzes f\u00fcr den Wareneingang (wenn `incomingGoodsPickTrolleyId` = null)", "format": "int64" }, "dropShippingPolicy": { "type": "string", "description": "Definiert, ob und wie ein Artikel per Streckengesch\u00e4ft verkauft werden darf", "enum": [ "ANY", "DROP_SHIPPING", "STORAGE", "STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING" ] } }, "description": "Details zum zu erstellenden oder zu bearbeitenden Beleg" }, "erp-document-RequestDocumentLineBooking": { "required": [ "quantity", "sourceComponentId", "storageBinId" ], "type": "object", "properties": { "sourceComponentId": { "type": "integer", "description": "ID der bebuchten Quell-DocumentLineComponent", "format": "int64" }, "quantity": { "type": "number", "description": "Gebuchte Menge" }, "storageBinId": { "type": "integer", "description": "ID vom bebuchten Lagerplatz", "format": "int64" }, "serialNumberId": { "type": "integer", "description": "Ggf. ID einer zu buchenden Seriennummer", "format": "int64" } }, "description": "Buchungen zu dieser Belegposition" }, "erp-document-RequestDocumentLineCommission": { "required": [ "origin", "salesAgentAccountRef", "value", "valueType" ], "type": "object", "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" ] } }, "description": "Provisionen zu dieser Belegposition" }, "erp-document-RequestDocumentPriceModifier": { "required": [ "modifierType", "modifierValue", "valueType" ], "type": "object", "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" ] } }, "description": "Die Rabatte des Beleges" }, "erp-document-RequestDocumentText": { "type": "object", "properties": { "textPosition": { "type": "string", "description": "header or footer text", "enum": [ "HEADER_TEXT", "FOOTER_TEXT" ] }, "content": { "type": "string", "description": "text content" } }, "description": "(optional) Liste von Texten f\u00fcr diese Position" }, "erp-document-CreateOrUpdateManualDocumentProtocolRequest": { "required": [ "customMessage" ], "type": "object", "properties": { "customMessage": { "type": "string", "description": "Text f\u00fcr das Belegprotokoll" } }, "description": "Request zur Anlage eines manuellen Eintrags ins Belegprotokoll" }, "erp-document-DocumentProtocol": { "required": [ "type" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Typ des Dokuments zu diesem Protokolleintrag", "format": "int64", "readOnly": true }, "documentTypeLabels": { "type": "array", "description": "Label vom Typ des Dokuments zu diesem Protokolleintrag", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeLabel" } }, "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", "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", "REVERT_AFTER_WORKFLOW_FAILURE", "ORDER_DELIVERY_APPROVED", "ORDER_DELIVERY_UNAPPROVED", "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" ] }, "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", "description": "Zeitstempel dieses Protokolleintrags", "format": "date-time" } }, "description": "Belegprotokoll" }, "core-unknownmodule-LeasableLock": { "required": [ "key", "token" ], "type": "object", "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, "example": "1" } } }, "erp-document-DocumentParcel": { "required": [ "documentRef" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Position des Pakets", "format": "int32" }, "weight": { "type": "number", "description": "Gewicht des Pakets" }, "weightUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "length": { "type": "number", "description": "L\u00e4nge" }, "width": { "type": "number", "description": "Breite" }, "height": { "type": "number", "description": "H\u00f6he" }, "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" } } }, "description": "Pakete zu Belegen" }, "erp-document-DocumentParcelLine": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Referenz zur Belegpositionsbuchung", "format": "int64" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "quantity": { "type": "number", "description": "Menge" } }, "description": "Inhalt der Pakete zu Belegen" }, "erp-document-DocumentPartialUpdateRequest": { "type": "object", "properties": { "documentLine": { "$ref": "#/components/schemas/erp-document-DocumentLine" }, "additionalParameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter und Benutzerentscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-document-ContractDueDates": { "required": [ "dueDate" ], "type": "object", "properties": { "dueDate": { "type": "string", "description": "Aktuelle F\u00e4lligkeit", "format": "date" }, "nextDueDate": { "type": "string", "description": "N\u00e4chste F\u00e4lligkeit", "format": "date" } }, "description": "Zu \u00e4ndernde F\u00e4lligkeiten in einem Vertrag" }, "erp-document-DocumentTypeChain": { "required": [ "predecessorId", "successorId" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "predecessorId": { "type": "integer", "description": "Vorg\u00e4nger-DocumentType", "format": "int64" }, "successorId": { "type": "integer", "description": "Nachfolger-DocumentType", "format": "int64" } }, "description": "Verwaltung zur Pflege der Belegketten" }, "erp-delivery-DeliveryTerm": { "required": [ "calculateFreightChargesFromType", "calculateFreightChargesWithType", "description", "label", "shippingCostArticleRef" ], "type": "object", "properties": { "version": { "type": "string", "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 for this delivery term" }, "description": { "type": "string", "description": "description" }, "printDescription": { "type": "string", "description": "printDescription" }, "deliveryMethodRefs": { "type": "array", "description": "Lieferarten", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "languageCode": { "type": "string", "description": "Sprache des Accounts" }, "freeShippingGrossValue": { "type": "number", "description": "free shipping gross value" }, "freeShippingNetValue": { "type": "number", "description": "free shipping net value" }, "codNetFee": { "type": "number", "description": "cod net fee to charge on document" }, "codGrossFee": { "type": "number", "description": "cod gross fee to charge on document" }, "freightChargesPerParcel": { "type": "boolean", "description": "calculate shipping charges per parcel", "default": false }, "calculateFreightChargesWithType": { "type": "string", "description": "information, when the shipping charges should be calculated", "enum": [ "EVERY_SHIPPING", "FIRST_SHIPPING" ] }, "calculateFreightChargesFromType": { "type": "string", "description": "information, how the shipping charges should be calculated", "enum": [ "CHARGES_FROM_ORDER", "RECALCULATE" ] }, "shippingCostArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "active": { "type": "boolean", "description": "Aktiv?", "default": true }, "translations": { "type": "array", "description": "translations", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeTerm" } } } }, "erp-delivery-ShippingCost": { "required": [ "currencyCode", "netPrice" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "countryCode": { "type": "string", "description": "L\u00e4ndercode" }, "fromPostcode": { "type": "string", "description": "Postleitzahl von" }, "toPostcode": { "type": "string", "description": "Postleitzahl bis" }, "fromParcelCount": { "type": "integer", "description": "Ab Anzahl Pakete", "format": "int32" }, "fromShipmentWeight": { "type": "number", "description": "Ab Gewicht (Sendungsgewicht)" }, "fromShipmentWeightUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "netPrice": { "type": "number", "description": "Kosten netto" }, "grossPrice": { "type": "number", "description": "Kosten brutto" }, "purchasePrice": { "type": "boolean", "description": "Einkaufspreis?", "default": false }, "currencyCode": { "type": "string", "description": "W\u00e4hrung (ISO-A3)" } }, "description": "Versandkosten mit Bedingungen" }, "erp-account-CustomAccountRelationType": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": "Relation-Label" } } }, "erp-crm-CrmSubType": { "required": [ "label", "sortOrder" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Sortierreihenfolge", "format": "int32" }, "active": { "type": "boolean", "description": "aktiv", "readOnly": true } }, "description": "Spezialisierter Typ einer CRM-Objekt-Implementierung" }, "erp-crm-CrmState": { "required": [ "label", "sortOrder" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Sortierreihenfolge", "format": "int32" }, "startState": { "type": "boolean", "description": "Handelt es sich um einen Anfang-Status", "default": false }, "finishState": { "type": "boolean", "description": "Handelt es sich um einen End-Status", "default": false }, "readyToBill": { "type": "boolean", "description": "Handelt es sich um einen \"Bereit zur Abrechnung\"-Status", "default": false }, "needsCommentOnPositiveFinish": { "type": "boolean", "description": "Kommentar bei positivem Abschlu\u00df erforderlich", "default": false }, "needsCommentOnNegativeFinish": { "type": "boolean", "description": "Kommentar bei negativem Abschlu\u00df erforderlich", "default": false }, "active": { "type": "boolean", "description": "active", "readOnly": true }, "portalEnumRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" } }, "description": "Status eines CRM-Objekts" }, "erp-crm-CrmPriority": { "required": [ "crmPriorityType", "sortOrder" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "crmPriorityType": { "type": "string", "description": "Priorit\u00e4t", "enum": [ "CRITICAL", "NORMAL", "LOW" ] }, "sortOrder": { "type": "integer", "description": "Sortierreihenfolge", "format": "int32" }, "portalEnumRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" } }, "description": "Priorit\u00e4t eines CRM-Objekts" }, "erp-crm-CrmProjectPhase": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "sortOrder": { "type": "integer", "description": "Sortierreihenfolge", "format": "int32" }, "active": { "type": "boolean", "description": "aktiv", "readOnly": true } }, "description": "CRM Projekt-Phasen" }, "erp-crm-CrmDealVisibility": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "dealUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readPermittedUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Sichtbarkeit von CRM-Deals" }, "erp-crm-CrmDealTopic": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Sortierreihenfolge", "format": "int32" }, "active": { "type": "boolean", "description": "aktiv", "readOnly": true } }, "description": "Thema von CRM-Deals" }, "erp-crm-CrmDealClosingReason": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "closingType": { "type": "string", "description": "Art des Abschlu\u00df eines Deals", "enum": [ "POSITIVE", "NEGATIVE" ] }, "sortOrder": { "type": "integer", "description": "Sortierreihenfolge", "format": "int32" }, "active": { "type": "boolean", "description": "aktiv", "readOnly": true } }, "description": "Abschlussgrund von CRM-Deals" }, "erp-crm-CrmActivity": { "required": [ "type" ], "type": "object", "properties": { "version": { "type": "string", "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": { "$ref": "#/components/schemas/erp-crm-CrmActivityType" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "crmParent": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" }, "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "system": { "type": "boolean", "description": "Handelt es sich um eine System-Aktivit\u00e4t?", "readOnly": true }, "comment": { "type": "string", "description": "Inhalt dieser Aktivit\u00e4t" }, "notes": { "type": "string", "description": "Notizen" }, "startDateTime": { "type": "string", "description": "Zeitpunkt der Aktivit\u00e4t", "format": "date-time" }, "durationInSeconds": { "type": "integer", "description": "Dauer der Aktivit\u00e4t in Sekunden", "format": "int32" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "billable": { "type": "boolean", "description": "Abrechenbar?", "readOnly": true, "default": false }, "billingType": { "type": "string", "description": "Abrechungsart von Aktivit\u00e4ten", "enum": [ "LIKE_TASK", "UNCLEAR", "CUSTOMER", "INTERNAL" ] }, "billingDocumentLineRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "internalBilled": { "type": "boolean", "description": "Aktivit\u00e4t intern abgerechnet?", "readOnly": true, "default": false }, "billingDiscount": { "type": "number", "description": "Rabatt zur Abrechnung" }, "durationToBillInSeconds": { "type": "integer", "description": "Abzurechnende Dauer in Sekunden", "format": "int32" }, "published": { "type": "boolean", "description": "Ist die Aktivit\u00e4t ver\u00f6ffentlicht", "default": false }, "accountPersonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "email": { "type": "boolean", "description": "Handelt es sich bei der Aktivit\u00e4t um eine E-Mail", "readOnly": true, "default": false } }, "description": "CRM Aktivit\u00e4ten" }, "erp-crm-CrmActivityType": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "sortOrder": { "type": "integer", "description": "Sortierreihenfolge", "format": "int32" }, "defaultBillingType": { "type": "string", "description": "Abrechungsart von Aktivit\u00e4ten", "enum": [ "LIKE_TASK", "UNCLEAR", "CUSTOMER", "INTERNAL" ] }, "billable": { "type": "boolean", "description": "Abrechenbar?", "default": false }, "possibleUsingTypes": { "type": "array", "description": "M\u00f6gliche Typen, wo diese Aktivit\u00e4tsart verwendet werden kann", "items": { "type": "string", "description": "M\u00f6gliche Typen, zu denen Aktivit\u00e4ten erfasst werden k\u00f6nnen", "enum": [ "ACCOUNT", "CRM_DEAL", "CRM_PROJECT", "CRM_TASK" ] } }, "defaultForComments": { "type": "boolean", "description": "Standard f\u00fcr Kommentare?", "default": false }, "emailArchiving": { "type": "boolean", "description": "F\u00fcr \"E-Mail-Archivieren\"?", "default": false }, "emailProcessing": { "type": "boolean", "description": "F\u00fcr \"E-Mail-Bearbeitung\"?", "default": false }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "descriptionTemplate": { "type": "string", "description": "Text f\u00fcr Aktivit\u00e4tstyp der im Editor eingetragen wird" }, "canBePublished": { "type": "boolean", "description": "Darf die Aktivit\u00e4t ver\u00f6ffentlicht werden?", "default": true } }, "description": "CRM Aktivit\u00e4tsarten" }, "erp-crm-CrmObjectRef": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64" }, "type": { "type": "string", "description": "M\u00f6glich 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" } }, "description": "Referenz auf ein CRM-Objekt" }, "erp-crm-CrmActivityTypePerUser": { "required": [ "activityTypeRef", "defaultBillingType", "userRef" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Standard f\u00fcr Benutzer", "default": false }, "defaultBillingType": { "type": "string", "description": "Abrechungsart von Aktivit\u00e4ten", "enum": [ "LIKE_TASK", "UNCLEAR", "CUSTOMER", "INTERNAL" ] } }, "description": "CRM Aktivit\u00e4tstypen pro Benutzer" }, "erp-crm-SetActivitiesBilledRequest": { "required": [ "activityIds", "billingDocumentId" ], "type": "object", "properties": { "activityIds": { "type": "array", "description": "IDs der Aktivit\u00e4ten, welche als abgerechnet markiert werden sollen", "items": { "type": "integer", "description": "IDs der Aktivit\u00e4ten, welche als abgerechnet markiert werden sollen", "format": "int64" } }, "billingDocumentId": { "type": "integer", "description": "ID des Abrechnungsbelegs, der mit den Aktivit\u00e4ten verkn\u00fcpft werden soll", "format": "int64" } }, "description": "Request markieren von Aktivit\u00e4ten als \"abgerechnet\"" }, "erp-crm-CrmActivityBillingRule": { "required": [ "activityType", "billingArticleRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "activityUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "activityUserGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "activityType": { "$ref": "#/components/schemas/erp-crm-CrmActivityType" }, "billingArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Abrechnungsregeln zu CRM Aktivit\u00e4ten" }, "erp-account-ContactType": { "required": [ "label", "type" ], "type": "object", "properties": { "version": { "type": "string", "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": "type label" }, "type": { "type": "string", "description": "type", "enum": [ "PHONE", "SOCIAL", "EMAIL", "FAX", "SKYPE", "MS_TEAMS", "CUSTOM", "MOBILE" ] }, "active": { "type": "boolean", "description": "active", "default": true } } }, "erp-commission-CommissionAssignment": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "qualifier": { "type": "string", "description": "Qualifier", "enum": [ "SALES" ] }, "salesAgentAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "productGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "validFrom": { "type": "string", "description": "Valid From", "format": "date" }, "validUntil": { "type": "string", "description": "Valid Until", "format": "date" }, "commissionValue": { "type": "number", "description": "Commission Value" }, "commissionValueType": { "type": "string", "description": "Typ von Werten", "enum": [ "PERCENT", "FIX" ] }, "valueCurrencyCode": { "type": "string", "description": "the currency-code IsoAlpha3" }, "comment": { "type": "string", "description": "User comment" }, "description": { "type": "string", "description": "Description" } } }, "erp-product-BundleSchema": { "required": [ "baseTypeRef", "label" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "baseTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "ratios": { "type": "array", "description": "Umrechnungen f\u00fcr Artikel des zugeh\u00f6rigen Produkts", "items": { "$ref": "#/components/schemas/erp-product-BundleUnitTypeRatio" } }, "productId": { "type": "integer", "description": "Produkt, zu dem dieses Schema geh\u00f6rt", "format": "int64", "readOnly": true }, "label": { "type": "string", "description": "Name" } } }, "erp-product-BundleUnitTypeRatio": { "required": [ "baseUnitTypeRef", "factor", "relationUnitTypeRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "baseUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "relationUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "factor": { "type": "number", "description": "Faktor", "format": "double" } }, "description": "Umrechnungen f\u00fcr Artikel des zugeh\u00f6rigen Produkts" }, "erp-bank-Bank": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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\u00e4ubiger-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", "description": "ID of the banking provider", "format": "int64" }, "active": { "type": "boolean", "description": "Ist die Bank aktiv", "readOnly": true, "default": true }, "logoUrl": { "type": "string", "description": "URL des Bank-Logos" } } }, "erp-bank-BankAccount": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "id of the bank", "format": "int64" }, "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", "description": "Konto-Position", "format": "int32" }, "defaultBankAccount": { "type": "boolean", "description": "Standard-Konto", "default": false }, "active": { "type": "boolean", "description": "Aktiv?" }, "externalReferenceId": { "type": "string", "description": "Referenz ID aus externem System", "readOnly": true } }, "description": "accounts" }, "erp-bank-BankTransaction": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "id of the account", "format": "int64" }, "parentId": { "type": "integer", "description": "id of the parent transaction", "format": "int64" }, "valueDate": { "type": "string", "description": "value date", "format": "date-time" }, "bookingDate": { "type": "string", "description": "booking date", "format": "date-time" }, "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" }, "matchingState": { "type": "string", "description": "whether the transaction has been completely or partially matched with open items or not matched at all", "readOnly": true, "enum": [ "MATCHED", "PARTIALLY_MATCHED", "NOT_MATCHED", "NOT_RELEVANT" ] }, "direction": { "type": "string", "description": "whether this transaction was incoming or outgoing", "enum": [ "INCOMING", "OUTGOING" ] }, "openItemRecordRefs": { "type": "array", "description": "openItem record reference", "nullable": true, "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } } }, "erp-bank-BankPayment": { "required": [ "accountRef", "type" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "type": { "type": "string", "description": "payment type", "enum": [ "MONEY_TRANSFER", "REALTIME_MONEY_TRANSFER", "SEPA_CORE_DIRECT_DEBIT", "SEPA_B2B_DIRECT_DEBIT", "CLEARING", "CLEARING_WITH_PREDECESSOR_DOCUMENT", "OTHER" ] }, "status": { "type": "string", "description": "payment status", "readOnly": true, "enum": [ "CREATED", "PREPARED", "SENT", "CANCELLED" ] }, "batchBookingPreferred": { "type": "boolean", "description": "batch booked preferred" }, "directDebitSequenceType": { "type": "string", "description": "direct debit sequence type", "enum": [ "OOFF", "FRST", "RCUR", "FNAL" ] }, "executionDate": { "type": "string", "description": "execution date", "format": "date" }, "requestDate": { "type": "string", "description": "request date", "format": "date-time" }, "endToEndId": { "type": "string", "description": "End-To-End-Id", "deprecated": true }, "records": { "type": "array", "description": "payment records", "items": { "$ref": "#/components/schemas/erp-bank-BankPaymentRecord" } } } }, "erp-bank-BankPaymentRecord": { "required": [ "amount", "iban", "name", "purpose" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "paymentId": { "type": "integer", "description": "id of the payment", "format": "int64" }, "name": { "type": "string", "description": "counterpart name" }, "iban": { "type": "string", "description": "counterpart IBAN" }, "bic": { "type": "string", "description": "counterpart BIC" }, "amount": { "type": "number", "description": "payment/debit amount" }, "purpose": { "type": "string", "description": "purpose" }, "purposeCode": { "type": "string", "description": "purpose code" }, "mandateReference": { "type": "string", "description": "mandate reference number (for direct debit)" }, "mandateDate": { "type": "string", "description": "mandate date (for direct debit)", "format": "date" }, "creditorId": { "type": "string", "description": "creditor id (for direct debit)" }, "address": { "type": "string", "description": "address of counterpart (only for direct debit outside EU)" }, "country": { "type": "string", "description": "country code of counterpart (only for direct debit outside EU)" }, "comment": { "type": "string", "description": "\u00c4nderungsgrund" }, "openItem": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "payment records" }, "erp-bank-BankingBackend": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Aktiv", "readOnly": true, "default": true }, "appId": { "type": "string", "description": "externe App-ID", "format": "uuid" }, "backendType": { "type": "string", "description": "Backend-Typ", "enum": [ "OFFLINE", "FINAPI", "FINAPI_SANDBOX", "MOCKBANK" ] } } }, "erp-product-Article": { "required": [ "deliverable", "dropShippingPolicy", "number", "productGroupRef" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "active", "readOnly": true, "default": true }, "baseArticle": { "type": "boolean", "description": "Ist das der Basis-Artikel des Produkts?", "readOnly": true, "default": true }, "productType": { "type": "string", "description": "Artikelarten", "readOnly": true, "enum": [ "WITH_STOCK", "WITHOUT_STOCK", "SERVICE_ARTICLE", "SERVICE_CONTINGENT", "ASSEMBLY_GROUP", "JUMBO", "SHIPPING_COSTS", "VARIANT_MAIN_ARTICLE" ] }, "priceBase": { "type": "string", "description": "Preisbasis", "enum": [ "NET_PRICE", "GROSS_PRICE" ] }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "readOnly": true, "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "DOUBLE_SERIAL_NUMBER" ] }, "expiryDateType": { "type": "string", "description": "Art des Haltbarkeitsdatums bei Serienartikeln", "readOnly": true, "enum": [ "NONE", "BEST_BEFORE_DATE", "EXPIRATION_DATE" ] }, "warrantyInMonths": { "type": "integer", "description": "Garantie in Monaten", "format": "int32", "readOnly": true }, "serialNumberLabelingType": { "type": "string", "description": "Seriennummer Auszeichnungsart", "readOnly": true, "enum": [ "MANUAL", "AUTOMATIC_ON_SUPPLIER_ORDER", "AUTOMATIC_ON_SUPPLIER_DELIVERY" ] }, "number": { "maxLength": 255, "minLength": 0, "type": "string", "description": "unique product number" }, "sellable": { "type": "boolean", "description": "is this product sellable", "default": true }, "purchasable": { "type": "boolean", "description": "is this product purchasable", "default": true }, "solvable": { "type": "boolean", "description": "is this product solvable to another package-variant", "default": false }, "mergeable": { "type": "boolean", "description": "is this product mergeable to another package-variant", "default": false }, "salesUnit": { "type": "number", "description": "Verkaufseinheit" }, "grossMetric": { "$ref": "#/components/schemas/erp-product-Metric" }, "netMetric": { "$ref": "#/components/schemas/erp-product-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", "description": "Ist der Artikel noch lieferbar?", "default": true }, "customsTariffNumber": { "maxLength": 15, "minLength": 0, "type": "string", "description": "Zolltarifnummer" }, "countryOfOriginRef": { "$ref": "#/components/schemas/common-masterdata-CountryReference" }, "manufacturerId": { "type": "string", "description": "Hersteller des Produkts" }, "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", "description": "Umkehrung der Steuerschuld nach \u00a713b UStG?", "default": false }, "sellableWithoutStock": { "type": "boolean", "description": "is this product sellable without any quantity at the stock", "default": false }, "listed": { "type": "boolean", "description": "soll der Artikel gelistet werden", "default": true }, "listingState": { "type": "string", "description": "Synchronisationsstatus eines Listings", "readOnly": true, "enum": [ "DISABLED", "NEED_SYNCHRONIZE", "QUEUED_FOR_SYNCHRONIZE", "SYNCHRONIZED", "ERRONEOUS", "NEED_DELETION", "QUEUED_FOR_DELETION" ] }, "listingStateChangeTime": { "type": "string", "description": "die letzte Aktualisierung des listingStates", "format": "date-time", "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" }, "languageCode": { "type": "string", "description": "Einschr\u00e4nkung auf Land" }, "dangerousGoodInformationRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "isDangerousGood": { "type": "boolean", "description": "Artikel ist Gefahrgut", "default": false }, "availableAlone": { "type": "boolean", "description": "alleine lieferbarer Artikel?", "default": true }, "pickingType": { "type": "string", "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" ], "default": "ACCORDING_TO_TEMPLATE" }, "workUnitInMinutes": { "type": "integer", "description": "Arbeitseinheit in Minuten", "format": "int32" }, "initialLastPurchasePrice": { "type": "number", "description": "Letzter EKP (Startwert)" }, "initialAvgPurchasePrice": { "type": "number", "description": "Durchschnittl. EKP (Startwert)" }, "determineAvgPurchasePrice": { "type": "boolean", "description": "dEK berechnen?", "default": true }, "commissionable": { "type": "boolean", "description": "provisionsberechtiger Artikel?", "default": true }, "cashDiscountable": { "type": "boolean", "description": "skontierbarer Artikel?", "default": true }, "discountable": { "type": "boolean", "description": "rabattierbarer Artikel?", "default": true }, "contingentArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "printWarningIfNoContingentAvailable": { "type": "boolean", "description": "Nur f\u00fcr Kontingentartikel: soll bei der Abrechnung angedruckt werden, dass kein Kontingent vorhanden ist?", "default": true }, "freelyPickable": { "type": "boolean", "description": "Frei kommissionierbar", "default": false }, "shippingLabelPrinting": { "type": "boolean", "description": "Versandlabeldruck", "default": false }, "permissibleForOrderProposal": { "type": "boolean", "description": "zul\u00e4ssig f\u00fcr Aufnahme in Bestellvorschl\u00e4ge", "default": true }, "dropShippingPolicy": { "type": "string", "description": "Definiert, ob und wie ein Artikel per Streckengesch\u00e4ft verkauft werden darf", "enum": [ "ANY", "DROP_SHIPPING", "STORAGE", "STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING" ], "default": "STORAGE" }, "fabrication": { "type": "boolean", "description": "Produktion", "default": false }, "onlyManualFabrication": { "type": "boolean", "description": "Nur manuelle Produktion", "default": false }, "fabricationOfComponents": { "type": "string", "description": "Produktion von Komponenten", "enum": [ "NEVER", "COMPLETELY_IF_NECESSARY", "REQUIRED_QUANTITY_IF_NECESSARY", "ALWAYS" ] }, "printLabelSettings": { "$ref": "#/components/schemas/erp-product-ArticlePrintLabelSettings" }, "needsAssessmentOnlyOnReservationBasis": { "type": "boolean", "description": "Bedarfsermittlung nur \u00fcber Reservierungen", "default": false }, "onGoodsArrivalConvertIntoBundleArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "remark": { "type": "string", "description": "Sonderbemerkung" }, "note": { "type": "string", "description": "Notiz" } } }, "erp-product-ArticleIdentifier": { "required": [ "name", "value" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "identifier" }, "name": { "maxLength": 255, "minLength": 0, "type": "string", "description": "identifier type" } }, "description": "all (external) product numbers (SKU, EAN, ...)" }, "erp-product-ArticlePrintLabelSettings": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Wareneingang: Druckmenge", "format": "int32" }, "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", "description": "Warenausgang: Druckmenge", "format": "int32" } }, "description": "Etikettdruck-Einstellungen" }, "erp-product-Metric": { "type": "object", "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" } }, "description": "weight and size w.o. packaging" }, "erp-product-ArticleTax": { "required": [ "countryCode", "typeRef", "validFrom" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "countryCode": { "type": "string", "description": "the country, this entry is valid for" }, "validFrom": { "type": "string", "description": "the date, this entry is valid from", "format": "date" }, "articleId": { "type": "integer", "description": "the date, this entry is valid from", "format": "int64", "readOnly": true } }, "description": "steuerzuordnung eines artikels" }, "erp-stock-ArticleStorage": { "required": [ "articleId", "storageRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "articleId": { "type": "string", "description": "Das Produkt, dessen Lagerinfos hier ausgegeben werden" }, "storageRef": { "type": "string", "description": "Das Lager, dessen Infos hier ausgegeben werden" }, "presetStorageBinRefs": { "type": "array", "description": "Vorgabe-Lagerpl\u00e4tze", "items": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" } }, "quantityInStock": { "type": "number", "description": "Bestand im Lager", "readOnly": true }, "stockAvailable": { "type": "number", "description": "Verf\u00fcgbare Menge im Lager gem\u00e4\u00df konfigurierter Verf\u00fcgbarkeitsermittlung", "readOnly": true }, "reservedQuantity": { "type": "number", "description": "Reservierte Menge", "readOnly": true }, "orderedQuantity": { "type": "number", "description": "Bestellte Menge", "readOnly": true }, "quantityInPicking": { "type": "number", "description": "Aktuelle Menge in Kommissionierung", "readOnly": true }, "minimumStock": { "type": "number", "description": "Mindestbestand" }, "targetStock": { "type": "number", "description": "Sollbestand" }, "replenishmentFrom": { "type": "number", "description": "Nachschub ab" }, "replenishmentOn": { "type": "number", "description": "Nachschub auf" }, "storageLocation": { "type": "string", "description": "Lagerort" }, "withStorageBins": { "type": "boolean", "description": "Hat dieses Lager Lagerpl\u00e4tze?", "readOnly": true, "default": false }, "virtualStockAmount": { "type": "number", "description": "Aktueller \"virtueller\" Bestand (wenn gr\u00f6\u00dfere Gebinde in dieses aufgel\u00f6st werden w\u00fcrden)", "readOnly": true }, "virtualStockAvailable": { "type": "number", "description": "Aktuelle \"virtuelle\" verf\u00fcgbare Menge (wenn gr\u00f6\u00dfere Gebinde in dieses aufgel\u00f6st werden w\u00fcrden)", "readOnly": true } }, "description": "Lagerinfos" }, "erp-product-ArticleFabricationComponent": { "required": [ "componentArticleRef", "fabricationArticleRef", "quantity" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "fabricationArticleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "componentArticleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "quantity": { "type": "number", "description": "Menge" }, "deviatingUnitRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "name": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Bezeichnung" }, "description": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "Beschreibung" }, "forSerialInheritance": { "type": "boolean", "description": "Basis f\u00fcr die Vererbung der Seriennummer", "default": false }, "sortOrder": { "type": "integer", "description": "Sortierreihenfolge", "format": "int32" }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true } }, "description": "Komponente eines Produktionsartikels" }, "erp-product-ArticleComponent": { "required": [ "componentArticleId", "containerArticleId" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "containerArticleId": { "type": "integer", "description": "Baugruppen- oder Jumbo-Artikel", "format": "int64" }, "componentArticleId": { "type": "integer", "description": "Artikel dieser Komponente", "format": "int64" }, "number": { "type": "string", "description": "Artikelnummer der Komponente" }, "name": { "type": "string", "description": "Name der Komponente" }, "description": { "type": "string", "description": "Beschreibung der Komponente" }, "quantity": { "type": "number", "description": "Menge der Komponente" }, "position": { "type": "integer", "description": "Position der Komponente innerhalb des Containers", "format": "int32" }, "salesPrice": { "type": "number", "description": "Verkaufspreis der Komponente" }, "purchasePrice": { "type": "number", "description": "Einkaufspreis (DEK) der Komponente" }, "grossWeight": { "type": "number", "description": "Brutto-Gewicht der Komponente" }, "netWeight": { "type": "number", "description": "Netto-Gewicht der Komponente" }, "stockAmount": { "type": "number", "description": "Bestand der Komponente" }, "stockAvailable": { "type": "number", "description": "verf\u00fcgbare Menge der Komponente" } }, "description": "Komponenten eines Baugruppen- oder Jumbo-Artikels" }, "erp-product-ArticleStorageArea": { "required": [ "articleId", "storageAreaId" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Der Artikel, dessen Lagerbereiche hier ausgegeben werden", "format": "int64" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "storageAreaId": { "type": "integer", "description": "In welchem Lager wird der Artikel gelagert", "format": "int64" }, "storageAreaLabel": { "type": "string", "description": "Label des Lagerbereichs", "readOnly": true } } }, "erp-product-ArticleListing": { "required": [ "salesChannelRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "sellableWithoutStock": { "type": "boolean", "description": "is this product sellable without any quantity at the stock", "default": false }, "listed": { "type": "boolean", "description": "soll der Artikel gelistet werden", "default": true }, "listingState": { "type": "string", "description": "Synchronisationsstatus eines Listings", "readOnly": true, "enum": [ "DISABLED", "NEED_SYNCHRONIZE", "QUEUED_FOR_SYNCHRONIZE", "SYNCHRONIZED", "ERRONEOUS", "NEED_DELETION", "QUEUED_FOR_DELETION" ] }, "listingStateChangeTime": { "type": "string", "description": "die letzte aktualisierung des listingStates", "format": "date-time", "readOnly": true }, "identifiers": { "$ref": "#/components/schemas/erp-product-WithDefaultsListArticleIdentifier" }, "name": { "$ref": "#/components/schemas/erp-product-WithDefaultsString" }, "alternativeName": { "$ref": "#/components/schemas/erp-product-WithDefaultsString" }, "description": { "$ref": "#/components/schemas/erp-product-WithDefaultsString" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "descriptionCustom": { "$ref": "#/components/schemas/erp-product-CustomFieldWithDefaults" }, "proposedLowestPriceNet": { "type": "number", "description": "Niedrigster Netto-Preis der letzten 30 Tage (vom System ermittelt)", "readOnly": true }, "proposedLowestPriceGross": { "type": "number", "description": "Niedrigster Brutto-Preis der letzten 30 Tage (vom System ermittelt)", "readOnly": true }, "customLowestPriceNet": { "type": "number", "description": "Niedrigster Netto-Preis der letzten 30 Tage (benutzerdefinierte Eingabe)" }, "customLowestPriceGross": { "type": "number", "description": "Niedrigster Brutto-Preis der letzten 30 Tage (benutzerdefinierte Eingabe)" } } }, "erp-product-CustomFieldWithDefaults": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "defaultValue": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "description custom data" }, "erp-product-WithDefaultsListArticleIdentifier": { "type": "object", "properties": { "value": { "type": "array", "description": "Wert dieses Sales-Channel", "items": { "$ref": "#/components/schemas/erp-product-ArticleIdentifier" } }, "defaultValue": { "type": "array", "description": "Wert des Default-Sales-Channel", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-product-ArticleIdentifier" } } }, "description": "all (external) article numbers (SKU, EAN, ...)" }, "erp-product-WithDefaultsString": { "type": "object", "properties": { "value": { "type": "string", "description": "Wert dieses Sales-Channel" }, "defaultValue": { "type": "string", "description": "Wert des Default-Sales-Channel", "readOnly": true } }, "description": "description of this article" }, "erp-product-ArticleSupplier": { "required": [ "accountId", "active", "articleId" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Aktiv?", "default": true }, "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", "description": "Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)", "default": false }, "useSupplierArticleName": { "type": "boolean", "description": "Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)", "default": false }, "useSupplierArticleDescription": { "type": "boolean", "description": "Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)", "default": false }, "useSupplierArticleIdentifier": { "type": "boolean", "description": "Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)", "default": false }, "purchaseUnit": { "type": "number", "description": "Einkaufseinheit" }, "packagingUnit": { "type": "number", "description": "Verpackungseinheit" }, "productUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "deliveryTime": { "type": "integer", "description": "Lieferzeit in (Werk-)Tagen", "format": "int32" }, "minimumOrderQuantity": { "type": "number", "description": "Mindestbestellmenge" }, "supplierReportingStock": { "type": "number", "description": "Lieferanten-Meldebestand" }, "mainSupplier": { "type": "boolean", "description": "Hauptlieferant", "default": false }, "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", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-product-ProductPrice" } }, "orderOnComponentBase": { "type": "boolean", "description": "Sollen Baugruppen auf Komponenten-Basis bestellt werden?)", "default": true }, "dropShippingAllowed": { "type": "boolean", "description": "Kennzeichen, ob Streckengesch\u00e4ft erlaubt", "nullable": true }, "supplierPrintLabelSettings": { "$ref": "#/components/schemas/erp-product-ArticlePrintLabelSettings" } }, "description": "Article-Supplier-Relation" }, "erp-product-ArticleCustomer": { "required": [ "accountId", "articleId" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Referenced Article", "format": "int64" }, "articleName": { "type": "string", "description": "Referenced Article name" }, "accountId": { "type": "integer", "description": "Referenced Customer-Account", "format": "int64" }, "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\u00fcr den Kunden gesperrt?" }, "defaultNetPrice": { "type": "number", "description": "Standardpreis Netto" }, "defaultGrossPrice": { "type": "number", "description": "Standardpreis Brutto" }, "productPrices": { "type": "array", "description": "Kunden-Preise", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-product-ProductPrice" } }, "customerPrintLabelSettings": { "$ref": "#/components/schemas/erp-product-ArticlePrintLabelSettings" } }, "description": "Article-Customer-Relation" }, "common-output-OutputModuleRef": { "type": "object", "properties": { "key": { "type": "string", "description": "output module key" }, "label": { "type": "string", "description": "output module label" } }, "description": "print module key" }, "erp-account-AccountOutputRule": { "required": [ "moduleRef" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "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" }, "targetReportGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "extensionType": { "type": "string", "description": "Extension Type", "enum": [ "ACCOUNT_MAIL", "ACCOUNT_PHONE" ] }, "ruleContacts": { "type": "array", "description": "Kontaktreferenzen f\u00fcr die OutputRule-Extension", "items": { "$ref": "#/components/schemas/erp-account-AccountOutputRuleContact" } } } }, "erp-account-AccountOutputRuleContact": { "required": [ "contactRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "contactRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "recipientType": { "type": "string", "description": "wie soll der Kontakt verwendet werden", "enum": [ "TO", "CC", "BCC" ] } }, "description": "Kontaktreferenzen f\u00fcr die OutputRule-Extension" }, "erp-account-SupplierGroup": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Bezeichnung" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung der Lieferantengruppe" }, "active": { "type": "boolean", "description": "Aktiv", "default": true } } }, "erp-account-CustomerGroup": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Bezeichnung" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung der Kundengruppe" }, "active": { "type": "boolean", "description": "Aktiv", "default": true } } }, "dms-shelf-ShelfDocument": { "required": [ "entryDate" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "file": { "$ref": "#/components/schemas/dms-shelf-ShelfFile" }, "shares": { "type": "array", "description": "share informations", "readOnly": true, "items": { "$ref": "#/components/schemas/dms-shelf-ShelfShare" } }, "description": { "type": "string", "description": "description of this document" }, "entryDate": { "type": "string", "description": "Date of this Entry/Document", "format": "date" }, "plannedRemovalDate": { "type": "string", "description": "Automatische L\u00f6schung ab", "format": "date", "readOnly": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "tags": { "type": "array", "description": "List of tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "note": { "type": "string", "description": "Notiz" }, "externalId": { "type": "string", "description": "Externe Id", "format": "uuid", "readOnly": true }, "alias": { "type": "string", "description": "Alias" }, "type": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentType" }, "state": { "type": "string", "description": "Status eines Dokuments", "readOnly": true, "enum": [ "DRAFT", "FILE_ATTACHED", "MISSING" ] }, "deletionState": { "type": "string", "description": "L\u00f6schungsstatus", "readOnly": true, "enum": [ "NOT_YET", "PREPARE_DELETE", "FILE_DELETED", "MANUALLY_RETAIN" ], "default": "NOT_YET" }, "active": { "type": "boolean", "description": "is the ShelfDocument active?", "readOnly": true, "default": true }, "translatableTexts": { "type": "array", "description": "Mehrsprachige Bezeichnungen", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfTranslatableText" } } } }, "dms-shelf-ShelfDocumentType": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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 of type", "readOnly": true }, "label": { "type": "string", "description": "label of type" }, "systemPresetting": { "type": "boolean", "description": "system presetting", "readOnly": true, "default": false }, "duration": { "type": "integer", "description": "duration of storage (years)", "format": "int32" }, "revisionStorageRule": { "type": "integer", "description": "storage rule for revisions", "format": "int32" }, "accessLevelRead": { "type": "integer", "description": "access level or reading", "format": "int32" }, "accessLevelWrite": { "type": "integer", "description": "access level for writing", "format": "int32" }, "accessLevelDelete": { "type": "integer", "description": "access level for deleting", "format": "int32" }, "active": { "type": "boolean", "description": "Ist die Dokumentenart aktiv", "default": true } }, "description": "Dokumentenart" }, "dms-shelf-ShelfFile": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "publicFileExtension": { "type": "string", "description": "file-extension of this entry", "readOnly": true }, "publicFileName": { "type": "string", "description": "file-name (without extension) of this entry", "readOnly": true }, "storageHandle": { "type": "string", "description": "current reference of this file in our storage ", "readOnly": true }, "contentType": { "type": "string", "description": "detected content type", "readOnly": true }, "metaDataEntries": { "type": "array", "description": "meta data", "readOnly": true, "items": { "$ref": "#/components/schemas/dms-shelf-ShelfFileMetaData" } }, "fileSize": { "type": "integer", "description": "fileSize", "format": "int64", "nullable": true, "readOnly": true }, "revisionNumber": { "type": "integer", "description": "revision number of this file", "format": "int32", "readOnly": true }, "subFiles": { "type": "array", "description": "subFiles for this file", "readOnly": true, "items": { "$ref": "#/components/schemas/dms-shelf-SubFileInfo" } } }, "description": "file data" }, "dms-shelf-ShelfFileMetaData": { "required": [ "metaKey" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "metaKey": { "type": "string", "description": "metadaten key" }, "metaValue": { "type": "string", "description": "metadaten wert" } }, "description": "meta data" }, "dms-shelf-ShelfShare": { "required": [ "availability" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "publicUrlPath": { "type": "string", "description": "der url-pfadanteil, der \u00f6ffentlichen zugriff auf diese resource gibt", "readOnly": true }, "publicUrlCreatedAt": { "type": "string", "description": "wann die \u00f6ffentliche resource erstellt wurde", "format": "date", "readOnly": true }, "publicUrlDurationInMinutes": { "type": "integer", "description": "wie viele Minuten bleibt dieser resource-pfad zugreifbar (null = unlimited)", "format": "int64" }, "availability": { "type": "string", "description": "Bestimmt, wie oft eine \u00f6ffentliche URL verf\u00fcgbar ist", "enum": [ "UNLIMITED", "ONE_TIME_USE" ] }, "timesUsed": { "type": "integer", "description": "Anzahl der Nutzungen", "format": "int32", "readOnly": true }, "appId": { "type": "string", "description": "App-ID", "format": "uuid" }, "sharedByExternalRef": { "type": "string", "description": "Externer Verweis auf dieses Share" }, "revision": { "type": "integer", "description": "Revision", "format": "int32", "readOnly": true }, "eTag": { "type": "string", "description": "Hash der Revision", "readOnly": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "publishState": { "type": "string", "description": "Ver\u00f6ffentlichungsstatus einer Dokument-Freigabe", "enum": [ "SYNCED", "PENDING", "DRAFT" ] }, "translatableTexts": { "type": "array", "description": "Mehrsprachige Bezeichnungen", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfTranslatableText" } }, "etag": { "type": "string" } }, "description": "share informations" }, "dms-shelf-ShelfTranslatableText": { "required": [ "languageCode" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "alternativeText": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "Alternativer Text" }, "metaTitle": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Meta-Titel" }, "languageCode": { "type": "string", "description": "Sprache" } }, "description": "Mehrsprachige Bezeichnungen" }, "dms-shelf-SubFileInfo": { "type": "object", "properties": { "version": { "type": "string", "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": "fileName" }, "parentPath": { "type": "string", "description": "Parent-Path" }, "fullPath": { "type": "string", "description": "Full-Path" }, "modifiedAt": { "type": "string", "description": "file last modified", "format": "date-time" }, "contentType": { "type": "string", "description": "Inhaltstyp" }, "shelfFile": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "subFiles for this file" }, "dms-shelf-ShelfImageTransformation": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "uiKey": { "type": "string", "description": "zur Unterscheidung verschiedener Transformationen" }, "share": { "$ref": "#/components/schemas/dms-shelf-ShelfShare" }, "sizeX": { "type": "integer", "description": "Breite in pixeln", "format": "int32" }, "sizeY": { "type": "integer", "description": "H\u00f6he in pixeln", "format": "int32" }, "rotation": { "type": "integer", "description": "Rotation in Grad", "format": "int32" }, "watermarkLabel": { "type": "string", "description": "Ein Wasserzeichen" }, "imageFileStorageHandle": { "type": "string", "description": "interne referenz auf die physikalische datei", "readOnly": true }, "imageFileCreatedAt": { "type": "string", "description": "wann wurde die physikalische datei erstellt", "format": "date", "readOnly": true }, "imageFileDuration": { "type": "integer", "description": "wie viele Tage bleibt diese physikalische datei erhalten (0 = unlimited)", "format": "int32" } } }, "dms-shelf-TransferFilePartUpdateRequest": { "required": [ "uploadEtag" ], "type": "object", "properties": { "uploadEtag": { "type": "string", "description": "resulting ETag from UploadPart upload" } }, "description": "Aktualisiert einen FilePart Upload" }, "dms-shelf-ShelfDocumentAttribution": { "required": [ "purpose" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "id of the referenced object", "format": "int64" }, "uiSort": { "type": "integer", "description": "UI-verwaltetes Feld", "format": "int32" }, "uiComment": { "type": "string", "description": "UI-verwaltetes Feld" }, "uiFavorite": { "type": "boolean", "description": "UI-verwaltetes Feld", "default": false }, "mainAttribution": { "type": "boolean", "description": "Hauptverkn\u00fcpfung dieser DMS-Ressource", "readOnly": true }, "transformationKeys": { "type": "array", "description": "Verf\u00fcgbare Transformationen zum Bild", "readOnly": true, "items": { "type": "string", "description": "Verf\u00fcgbare Transformationen zum Bild" } }, "shelfResourceId": { "type": "integer", "description": "ID der verkn\u00fcpften DMS-Ressource", "format": "int64" }, "publish": { "type": "boolean", "description": "Soll das Dokument ver\u00f6ffentlicht werden?" }, "purpose": { "type": "string", "description": "Art der Beziehung / Verwendungszweck" } } }, "vds-unknownmodule-CarrierParameterType": { "type": "object" }, "vds-carrier-CarrierType": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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/shipment service name" }, "description": { "type": "string", "description": "description" }, "appId": { "type": "string", "description": "external App-Id", "format": "uuid" }, "active": { "type": "boolean", "description": "Aktiv?", "default": true }, "backendType": { "type": "string", "description": "carriertype for backend", "enum": [ "APP", "NONE" ] }, "createShipmentSyncUrl": { "type": "string", "description": "App: URL f\u00fcr Versandauftrag" }, "createLabelSyncUrl": { "type": "string", "description": "App: URL f\u00fcr Versandlabel" }, "canPrintLabel": { "type": "boolean", "description": "Label-Druck m\u00f6glich", "default": false }, "trackingUrlTemplate": { "type": "string", "description": "Tracking-URL-Vorlage" } } }, "erp-api-Scenario": { "type": "object", "properties": { "version": { "type": "string", "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": "Identifier f\u00fcr das Scenario", "readOnly": true }, "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "die beschreibung f\u00fcr dieses Scenario" }, "description": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "die beschreibung f\u00fcr dieses Scenario" }, "startDate": { "type": "string", "description": "Start-Datum f\u00fcr die Berechnung (optional)", "format": "date" }, "factDefinitions": { "type": "array", "description": "Fakten/Daten Definition", "items": { "$ref": "#/components/schemas/erp-api-ScenarioFactDef" } }, "dimDefinitions": { "type": "array", "description": "Dimensions Definition", "items": { "$ref": "#/components/schemas/erp-api-ScenarioDimension" } } } }, "erp-api-ScenarioDimension": { "required": [ "key" ], "type": "object", "properties": { "version": { "type": "string", "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": { "pattern": "[a-zA-Z](\\w)*", "type": "string", "description": "Verteilschl\u00fcssel - Key/Gruppe" }, "multiSelect": { "type": "boolean", "description": "k\u00f6nnen mehrere Schl\u00fcssel bei der Verteilung verwendet werden", "default": false }, "definedValues": { "type": "array", "description": "Verteilschl\u00fcssel Auspr\u00e4gungen", "items": { "$ref": "#/components/schemas/erp-api-ScenarioDimensionValue" } } }, "description": "Dimensions Definition" }, "erp-api-ScenarioDimensionValue": { "type": "object", "properties": { "version": { "type": "string", "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": "Auspr\u00e4gung" }, "fallback": { "type": "boolean", "description": "handelt es sich um den Fallback-Value" }, "sortOrder": { "type": "integer", "description": "Sortierreihenfolge", "format": "int64", "readOnly": true }, "active": { "type": "boolean", "description": "ist der Wert weiterhin aktiv/selektierbar", "default": true } }, "description": "Verteilschl\u00fcssel Auspr\u00e4gungen" }, "erp-api-ScenarioFactDef": { "required": [ "attributeType", "factAttribute" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "attributeType": { "type": "string", "description": "Attribut Typ", "enum": [ "DATE_DIM_FACT", "LOOKUP_FACT", "DISTRIBUTE_FACT", "DATA_FACT" ] }, "factAttribute": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Attribut Name" } }, "description": "Fakten/Daten Definition" }, "erp-api-ScenarioDesiredValue": { "required": [ "actualMonth", "actualYear", "desiredValue", "dimValueRefs", "factRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "factRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "dimValueRefs": { "type": "array", "description": "Referenz auf eine Scenario-Dimension-Auspr\u00e4gung", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "actualYear": { "type": "integer", "description": "das Jahr", "format": "int32" }, "actualMonth": { "type": "integer", "description": "der Monat", "format": "int32" }, "desiredValue": { "type": "number", "description": "Soll-Wert" } } }, "erp-api-ScenarioActualValue": { "required": [ "dimValueRef", "referenceId", "scenarioDimRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "scenarioDimRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "referenceId": { "type": "integer", "description": "Referenz auf die LookupReferenz", "format": "int64" }, "dimValueRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "weight": { "type": "number", "description": "gewichtung" } } }, "erp-pos-TssAdminPuk": { "required": [ "adminPuk" ], "type": "object", "properties": { "adminPuk": { "type": "string", "description": "Admin-PUK f\u00fcr die TSS" }, "newAdminPin": { "type": "string", "description": "Neuer Admin-PIN f\u00fcr die TSS" } }, "description": "Request zum \u00c4ndern des TSS-Pins" }, "erp-sales_channel-SalesChannel": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "ist dieser channel aktiv", "default": true }, "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" }, "calculationMode": { "type": "string", "description": "calculation mode of this sales channel", "enum": [ "HORIZONTAL", "VERTICAL" ] }, "salesChannelStorages": { "type": "array", "description": "Lagerzuordnungen", "items": { "$ref": "#/components/schemas/erp-sales_channel-SalesChannelStorage" } }, "defaultSalesChannel": { "type": "boolean", "description": "Standard-Verkaufskanal" }, "businessRelationType": { "type": "string", "description": "Gesch\u00e4ftsbeziehungs-Typen f\u00fcr Gesch\u00e4ftspartner", "enum": [ "B2B", "B2C", "B2G" ] }, "externalReference": { "type": "string", "description": "Externe Referenz", "readOnly": true } } }, "erp-sales_channel-SalesChannelBackend": { "required": [ "label", "type" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Label" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "appId": { "maxLength": 255, "minLength": 0, "type": "string", "description": "App-ID" }, "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" ] } } } }, "erp-pos-PosPaymentMethod": { "required": [ "description", "label" ], "type": "object", "properties": { "version": { "type": "string", "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 Kassenzahlungsart" }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv?", "default": true }, "type": { "type": "string", "description": "Typ der Kassenzahlungsart", "enum": [ "CASH", "CARD" ] }, "paymentBackend": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "countingRequired": { "type": "boolean", "description": "Z\u00e4hlpflicht?" }, "balanceManaged": { "type": "boolean", "description": "Bestandsgef\u00fchrt" } } }, "erp-pos-PosPaymentBackend": { "required": [ "label", "type" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Label" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "appId": { "maxLength": 255, "minLength": 0, "type": "string", "description": "App-ID" }, "type": { "type": "string", "description": "Typ", "enum": [ "SELF", "APP" ] } } }, "erp-finance-FinanceBookingBackend": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Bezeichnung" }, "description": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "appId": { "maxLength": 255, "minLength": 0, "type": "string", "description": "App-ID" }, "usePerformanceDate": { "type": "boolean", "description": "Leistungsdatum beachten" }, "useValueDateForBankTransaction": { "type": "boolean", "description": "Valutadatum bei Banktransaktionen beachten" }, "descriptionOutgoingDocuments": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Buchungstext Ausgangsbelege" }, "descriptionIncomingDocuments": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Buchungstext Eingangsbelege" }, "descriptionPosReceipts": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Buchungstext Kassenquittungen" }, "descriptionPosBalances": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Buchungstext Kassendifferenzen" }, "descriptionPosDepositExpense": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Buchungstext Kasseneinlagen/ausgaben" }, "descriptionPosPayment": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Buchungstext Kassenzahlung Bar/Karte" }, "descriptionCommissionSettlements": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Buchungstext Eingangsbelege (Provisionen)" }, "descriptionPayments": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Buchungstext Zahlungen" }, "descriptionDunnings": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Buchungstext Mahnungen" } }, "description": "Finanzbuchhaltung Backend" }, "erp-delivery-DeliveryMethod": { "required": [ "description", "label", "parcelWeightSource" ], "type": "object", "properties": { "version": { "type": "string", "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 for this delivery method" }, "description": { "type": "string", "description": "description" }, "printDescription": { "type": "string", "description": "printDescription" }, "deliveryTime": { "type": "integer", "description": "Versanddauer in Tagen", "format": "int32" }, "vdsCarrierId": { "type": "integer", "description": "Versand-Anbieter", "format": "int64" }, "defaultWeightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "defaultSizeUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "splitIntoNewDocument": { "type": "boolean", "description": "Soll eine Position mit dieser Liefermethode in einen Lieferbeleg mit dieser Methode \u00fcbernommen werden", "default": false }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "minWeightPerParcel": { "type": "number", "description": "Min. Gewicht pro Paket" }, "maxWeightPerParcel": { "type": "number", "description": "Max. Gewicht pro Paket" }, "parcelWeightSource": { "type": "string", "description": "Woher soll das Gewicht der Pakete bezogen werden", "enum": [ "AUTOMATIC_VIA_DOCUMENT_LINE", "MANUAL_RECORDING" ], "default": "AUTOMATIC_VIA_DOCUMENT_LINE" }, "forwardEmailToShipper": { "type": "boolean", "description": "E-Mail an Versender \u00fcbergeben", "default": false }, "forwardPhoneToShipper": { "type": "boolean", "description": "Telefon an Versender \u00fcbergeben", "default": false }, "validCountryCodes": { "type": "array", "description": "G\u00fcltige L\u00e4ndercodes", "items": { "type": "string", "description": "G\u00fcltige L\u00e4ndercodes" } }, "translations": { "type": "array", "description": "translations", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeTerm" } } } }, "erp-crm-CrmReminder": { "required": [ "crmId", "remindAt", "userRef" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "ID des CRM Objekts", "format": "int64" }, "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "remindAt": { "type": "string", "description": "Erinnerungszeitpunkt", "format": "date-time" }, "note": { "type": "string", "description": "Notiz zur Erinnerung" }, "critical": { "type": "boolean", "description": "Kritische Erinnerung?" } }, "description": "CRM Erinnerungen" }, "erp-crm-CrmChecklistItem": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "memo": { "type": "string", "description": "Text des Checklisten-Elements" }, "checked": { "type": "boolean", "description": "Ist das Element \"angehakt\"?", "default": false } }, "description": "Element einer Checkliste im CRM" }, "erp-crm-CrmParticipant": { "required": [ "accountPersonRef" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung" } }, "description": "Teilnehmer/Ansprechpartner in einem CRM-Objekt" }, "erp-crm-CrmReference": { "required": [ "reference", "referenceType" ], "type": "object", "properties": { "referenceType": { "type": "string", "description": "M\u00f6gliche Typen von Referenzen zu CRM-Objekten", "enum": [ "ARTICLE", "DOCUMENT_LINE", "OPEN_ITEM" ] }, "reference": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Referenzen zu CRM-Objekten" }, "erp-crm-CrmTask": { "required": [ "billingRule", "billingType", "label", "priorityRef", "typeRef" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "parentRef": { "$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" } }, "observerRefs": { "type": "array", "description": "Beobachter", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "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" } }, "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" }, "mainResponsibleGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "label": { "type": "string", "description": "Aufgabentitel" }, "references": { "type": "array", "description": "Referenzen", "items": { "$ref": "#/components/schemas/erp-crm-CrmReference" } }, "purchaseDocumentRefs": { "type": "array", "description": "Einkaufsbelege", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } }, "customerOfferRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "customerOrderRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "billingDocumentRefs": { "type": "array", "description": "Abrechnungen", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } }, "customField": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "checklist": { "type": "array", "description": "Checkliste: Memo + Checked", "items": { "$ref": "#/components/schemas/erp-crm-CrmChecklistItem" } }, "dueDateTime": { "type": "string", "description": "F\u00e4lligkeit", "format": "date-time" }, "reminders": { "type": "array", "description": "Liste von Erinnerungen", "items": { "$ref": "#/components/schemas/erp-crm-CrmReminder" } }, "effortEstimation": { "type": "integer", "description": "Aufwandssch\u00e4tzung in Sekunden", "format": "int32" }, "effortCommissioned": { "type": "integer", "description": "Beauftragte Zeit in Sekunden", "format": "int32" }, "internalRecordedTimes": { "type": "integer", "description": "Erfasste Zeiten in Sekunden (intern)", "format": "int32", "readOnly": true }, "externalRecordedTimes": { "type": "integer", "description": "Erfasste Zeiten in Sekunden (extern)", "format": "int32", "readOnly": true }, "internalBilledTimes": { "type": "integer", "description": "Abgerechnete Zeiten in Sekunden (intern)", "format": "int32", "readOnly": true }, "externalBilledTimes": { "type": "integer", "description": "Abgerechnete Zeiten in Sekunden (extern)", "format": "int32", "readOnly": true }, "progress": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Fortschritt in Prozent", "format": "int32" }, "publish": { "type": "boolean", "description": "Soll die Aufgabe ver\u00f6ffentlicht werden?" }, "billingRule": { "type": "string", "description": "Abrechnungsregel", "enum": [ "ONLY_COMPLETE", "ONLY_BILL_WITH_PARENT_TASK", "ALLOW_ACTIVITIES_INDIVIDUALLY" ], "default": "ONLY_COMPLETE" }, "billingType": { "type": "string", "description": "Abrechnungsart von CRM-Aufgaben", "enum": [ "UNCLEAR", "CUSTOMER", "INTERNAL" ] }, "relatedToTaskRefs": { "type": "array", "description": "Steht mit diesen Aufgaben im Zusammenhang", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "duplicatesTaskRefs": { "type": "array", "description": "Duplizierte Aufgaben", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "duplicatedByTaskRefs": { "type": "array", "description": "Wird von diesen Aufgaben dupliziert", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "blocksTaskRefs": { "type": "array", "description": "Blockiert diese Aufgaben", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "blockedByTaskRefs": { "type": "array", "description": "Wird von diesen Aufgaben blockiert", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "responsibleCustomerPersonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "CRM Aufgaben" }, "erp-crm-CrmTaskCreateOrUpdateRequest": { "type": "object", "properties": { "toCreateOrUpdate": { "$ref": "#/components/schemas/erp-crm-CrmTask" }, "parameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } }, "description": "Request zur Erstellung oder Aktualisierung einer Aufgabe" }, "erp-crm-CrmUpdateParentRequest": { "required": [ "parentId", "parentType" ], "type": "object", "properties": { "parentId": { "type": "integer", "description": "ID vom neuen Parent", "format": "int64" }, "parentType": { "type": "string", "description": "M\u00f6glich CRM-Typen", "enum": [ "TASK", "DEAL", "PROJECT" ] } }, "description": "Request zur aktualisierung vom CRM-Parent" }, "erp-crm-Child": { "required": [ "id", "type" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64" }, "type": { "type": "string", "description": "M\u00f6glich CRM-Typen", "enum": [ "TASK", "DEAL", "PROJECT" ] } }, "description": "Ein abh\u00e4ngiges Objekt" }, "erp-crm-CrmUpdateChildrenRequest": { "required": [ "children" ], "type": "object", "properties": { "children": { "type": "array", "description": "Die abh\u00e4ngigen Objekte", "items": { "$ref": "#/components/schemas/erp-crm-Child" } } }, "description": "Request zur aktualisierung vom CRM-Parent" }, "erp-crm-CrmProject": { "required": [ "priorityRef", "typeRef" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "parentRef": { "$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" } }, "observerRefs": { "type": "array", "description": "Beobachter", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "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" } }, "processedByWorkflow": { "type": "boolean", "description": "In Workflow-Verarbeitung?", "readOnly": true }, "purchaseDocumentRefs": { "type": "array", "description": "Einkaufsbelege", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } }, "customField": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "phaseRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "label": { "type": "string", "description": "Aufgabentitel" }, "effortEstimation": { "type": "integer", "description": "Gesamt Aufwandssch\u00e4tzung in Sekunden", "format": "int32" }, "effortCommissioned": { "type": "integer", "description": "Gesamt beauftragte Zeit in Sekunden", "format": "int32" }, "plannedProjectPeriodFrom": { "type": "string", "description": "Geplanter Projektzeitraum (von)", "format": "date" }, "plannedProjectPeriodTo": { "type": "string", "description": "Geplanter Projektzeitraum (bis)", "format": "date" }, "actualProjectPeriodFrom": { "type": "string", "description": "Tats\u00e4chlicher Projektzeitraum (von)", "format": "date" }, "actualProjectPeriodTo": { "type": "string", "description": "Tats\u00e4chlicher Projektzeitraum (bis)", "format": "date" }, "contractConclusionDate": { "type": "string", "description": "Datum Vertragsabschluss", "format": "date" }, "projectManagerOfCustomer": { "$ref": "#/components/schemas/erp-crm-CrmParticipant" }, "projectManagerOfContractor": { "$ref": "#/components/schemas/erp-crm-CrmParticipant" }, "checklist": { "type": "array", "description": "Checkliste: Memo + Checked", "items": { "$ref": "#/components/schemas/erp-crm-CrmChecklistItem" } }, "recordedTimes": { "type": "integer", "description": "Erfasste Zeiten in Sekunden", "format": "int32", "readOnly": true }, "billedTimes": { "type": "integer", "description": "Abgerechnete Zeiten in Sekunden", "format": "int32", "readOnly": true } }, "description": "CRM Projekte" }, "erp-crm-CrmProjectCreateOrUpdateRequest": { "type": "object", "properties": { "toCreateOrUpdate": { "$ref": "#/components/schemas/erp-crm-CrmProject" }, "parameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } }, "description": "Request zur Erstellung oder Aktualisierung eines Projekts" }, "erp-crm-CrmDeal": { "required": [ "priorityRef", "topicRef", "typeRef" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "parentRef": { "$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" } }, "observerRefs": { "type": "array", "description": "Beobachter", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "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" } }, "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" }, "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", "description": "Geplantes Abschluss-Datum", "format": "date" }, "plannedPerformanceDate": { "type": "string", "description": "Geplantes Leistungs-Datum", "format": "date" }, "plannedInvestmentSum": { "type": "number", "description": "Geplante Investitionssumme" }, "chance": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Chance (in Prozent)", "format": "int32" }, "nextPlannedContactDate": { "type": "string", "description": "N\u00e4chster geplanter Kontakt", "format": "date-time" }, "closingType": { "type": "string", "description": "Art des Abschlu\u00df eines Deals", "enum": [ "POSITIVE", "NEGATIVE" ] }, "closingReasonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "detailedClosingReason": { "type": "string", "description": "Freier/Detaillierter Abschlu\u00dfgrund" } }, "description": "CRM Deals" }, "erp-crm-CrmDealCreateOrUpdateRequest": { "type": "object", "properties": { "toCreateOrUpdate": { "$ref": "#/components/schemas/erp-crm-CrmDeal" }, "parameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } }, "description": "Request zur Erstellung oder Aktualisierung eines Deals" }, "erp-account-SEPAMandate": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "note": { "maxLength": 255, "minLength": 0, "type": "string", "description": "note to identify the mandate" }, "lastUsed": { "type": "string", "description": "last date client-signature was used", "format": "date" }, "clientSignatureFrom": { "type": "string", "description": "date of client-signature (mandatsreferenz)", "format": "date" }, "clientSignatureId": { "maxLength": 255, "minLength": 0, "type": "string", "description": "id of client-signature (mandatsreferenz)" }, "firstDebitDone": { "type": "boolean", "description": "Ist die Erstlastschrift bereits erfolgt?" } } }, "erp-account-AccountBankdetail": { "required": [ "defaultBank", "iban", "originType" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "iban": { "maxLength": 255, "minLength": 0, "type": "string", "description": "IBAN" }, "bic": { "maxLength": 255, "minLength": 0, "type": "string", "description": "BIC" }, "accountFrom": { "maxLength": 255, "minLength": 0, "type": "string", "description": "account from, if differs from account-address" }, "bankName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "name of the bank" }, "bankCity": { "maxLength": 255, "minLength": 0, "type": "string", "description": "city of the bank" }, "bankPostCode": { "maxLength": 255, "minLength": 0, "type": "string", "description": "post-code of the bank" }, "originType": { "type": "string", "description": "origin type", "enum": [ "FRONTEND", "IMPORT" ], "default": "FRONTEND" }, "originInfo": { "maxLength": 255, "minLength": 0, "type": "string", "description": "origin info" }, "defaultBank": { "type": "boolean", "description": "Is default bank?", "default": true }, "mainBankAccountType": { "type": "string", "description": "Hauptbankverbindung f\u00fcr", "enum": [ "DOMESTIC", "EUROPEAN_COMMUNITY", "INTERNATIONAL" ] }, "active": { "type": "boolean", "description": "Is active?", "readOnly": true, "default": true } } }, "erp-account-AccountSalutation": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": "salutation string" }, "active": { "type": "boolean", "description": "active", "readOnly": true, "default": true } } }, "common-api-LogEntry": { "required": [ "loggerName" ], "type": "object", "properties": { "logTime": { "type": "string", "description": "Log-Time", "format": "date-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" } } }, "common-api-LogEntryGet": { "required": [ "loggerName" ], "type": "object", "properties": { "logTime": { "type": "string", "description": "Log-Time", "format": "date-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", "description": "id", "format": "int64", "readOnly": true }, "messageTopic": { "type": "string", "description": "topic of message entry", "readOnly": true } } }, "common-api-AppScriptingProxy": { "required": [ "appIdentifier", "triggerId" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Identifier der App", "format": "uuid" }, "triggerId": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Trigger zur Ausf\u00fchrung des Skripts" }, "script": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "Das auszuf\u00fchrende Skript (wenn scriptModuleRef nicht gesetzt ist)" }, "scriptModuleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "common-api-AppMessageEntry": { "required": [ "destinationQueue", "event" ], "type": "object", "properties": { "event": { "type": "string", "description": "Event/Nachricht" }, "eventTopic": { "type": "string", "description": "Event/Nachricht -Topic/Headline-" }, "destinationOwner": { "type": "string", "description": "owner (optional)" }, "destinationQueue": { "type": "string", "description": "queue" }, "userRef": { "type": "string", "description": "User-ID" } } }, "common-api-AppMessageEntryGet": { "required": [ "destinationQueue", "event" ], "type": "object", "properties": { "event": { "type": "string", "description": "Event/Nachricht" }, "eventTopic": { "type": "string", "description": "Event/Nachricht -Topic/Headline-" }, "destinationOwner": { "type": "string", "description": "owner (optional)" }, "destinationQueue": { "type": "string", "description": "queue" }, "userRef": { "type": "string", "description": "User-ID" }, "id": { "type": "integer", "description": "id", "format": "int64", "readOnly": true }, "recipients": { "uniqueItems": true, "type": "array", "description": "recipients", "readOnly": true, "items": { "$ref": "#/components/schemas/common-api-AppMessageEntryRecipient" } } } }, "common-api-AppMessageEntryRecipient": { "type": "object", "properties": { "response": { "type": "string", "description": "Antwort, falls vorhanden", "readOnly": true }, "state": { "type": "string", "description": "Status der Nachricht", "readOnly": true, "enum": [ "QUEUED", "SENT", "FAILED", "ERRONEOUS", "INACTIVE" ] }, "sentTimestamp": { "type": "string", "description": "Zeitpunkt, wann die Nachricht versendet wurde", "format": "date-time", "readOnly": true }, "sentAttempts": { "type": "integer", "description": "Anzahl der Sendeversuche", "format": "int32", "readOnly": true }, "webhook": { "$ref": "#/components/schemas/common-api-AppMessageWebhookGet" } }, "description": "recipients" }, "common-api-AppMessageWebhookGet": { "required": [ "destinationQueue", "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "url des webhooks. \u00fcblicherweise http(s)://host:port/etc" }, "destinationOwner": { "type": "string", "description": "owner (optional)" }, "destinationQueue": { "type": "string", "description": "queue" }, "appIdentifier": { "type": "string", "description": "appIdentifier (registrar)", "format": "uuid" }, "id": { "type": "integer", "description": "id", "format": "int64", "readOnly": true } }, "description": "Webhook" }, "common-api-OutputConsumer": { "required": [ "label", "outputTypes", "pushMode" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "integer", "description": "id", "format": "int64", "readOnly": true }, "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "label of the print server" }, "outputTypes": { "type": "array", "description": "Output-Types die dieser Consumer unterst\u00fctzt", "items": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" } }, "description": { "maxLength": 2048, "minLength": 0, "type": "string", "description": "description of the print server" }, "pushMode": { "type": "string", "description": "push mode for this consumer", "enum": [ "NONE", "LOCAL_EVENT", "WEBSOCKET", "WEBHOOK" ] }, "systemPresetting": { "type": "boolean", "description": "system einstellung", "readOnly": true, "default": false }, "active": { "type": "boolean", "description": "Aktiv?", "readOnly": true, "default": true }, "lastSeenAt": { "type": "string", "description": "last seen at", "format": "date-time", "readOnly": true }, "ruleValue": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "appIdentifier": { "type": "string", "description": "App-Identifier", "format": "uuid" } } }, "common-api-OutputConsumerRule": { "type": "object", "properties": { "version": { "type": "string", "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" }, "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" }, "systemPresetting": { "type": "boolean", "description": "handelt es sich um den systemreport. Bei diesem darf die selektion nicht ver\u00e4ndert werden", "readOnly": true } } }, "common-api-TextEnum": { "type": "object", "properties": { "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Wert der Aufz\u00e4hlung" }, "active": { "type": "boolean", "description": "active", "readOnly": true, "default": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-api-TextEnumGet": { "type": "object", "properties": { "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Wert der Aufz\u00e4hlung" }, "active": { "type": "boolean", "description": "active", "readOnly": true, "default": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "id": { "type": "integer", "description": "PrimaryKey", "format": "int64", "readOnly": true }, "groupKey": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Gruppe der Text-Aufz\u00e4hlung", "readOnly": true }, "systemPresetting": { "type": "boolean", "description": "System-Vorgabe", "readOnly": true } } }, "common-api-TextEnumGroup": { "type": "object", "properties": { "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung" }, "key": { "maxLength": 255, "minLength": 0, "type": "string", "description": "eindeutiger Key der Gruppe" }, "autoAppend": { "type": "boolean", "description": "automatisches erweitern der Liste aktiv", "default": false } } }, "common-api-TextEnumGroupGet": { "type": "object", "properties": { "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung" }, "key": { "maxLength": 255, "minLength": 0, "type": "string", "description": "eindeutiger Key der Gruppe" }, "autoAppend": { "type": "boolean", "description": "automatisches erweitern der Liste aktiv", "default": false }, "id": { "type": "string", "description": "PrimaryKey", "readOnly": true }, "systemPresetting": { "type": "boolean", "description": "System-Vorgabe", "readOnly": true }, "enumRefs": { "type": "array", "description": "enums die zu dieser gruppe geh\u00f6ren", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } } }, "common-eav-EavAttribute": { "required": [ "label", "type" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "label": { "type": "string", "description": "attribute label" }, "description": { "type": "string", "description": "attribute description" }, "position": { "type": "integer", "description": "position/reihenfolge des attributes (0 based)", "format": "int32", "readOnly": true }, "type": { "type": "string", "description": "attribute type", "enum": [ "BOOLEAN", "INTEGER", "TEXT", "DATE", "DATE_TIME", "JSON", "CURRENCY", "DECIMAL", "MEMO", "SELECT_SINGLE", "SELECT_MULTI" ] }, "textGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "viewMode": { "type": "string", "description": "darstellungsmodus im view", "enum": [ "EDITABLE", "READ_ONLY", "NOT_VISIBLE" ] }, "active": { "type": "boolean", "description": "ist das feld aktiv (ACHTUNG: deaktivieren verschiebt daten in den verbundenen Tabellen)", "default": true }, "fulltextField": { "type": "boolean", "description": "context is full-text-searchable", "default": false }, "searchIndex": { "type": "boolean", "description": "soll ein suchindex (e.g. f\u00fcr cunit) angelegt werden", "default": false }, "appIdentifier": { "type": "string", "description": "appIdentifier", "format": "uuid" } }, "description": "attribute list" }, "common-eav-EavGroup": { "required": [ "attributes", "description", "entities", "label" ], "type": "object", "properties": { "version": { "type": "string", "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": "group key" }, "label": { "type": "string", "description": "group label" }, "description": { "type": "string", "description": "group description" }, "attributes": { "type": "array", "description": "attribute list", "items": { "$ref": "#/components/schemas/common-eav-EavAttribute" } }, "uiSettings": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "entities": { "type": "array", "description": "zugeordnet zu folgenden entities", "items": { "type": "string", "description": "zugeordnet zu folgenden entities" } }, "appIdentifier": { "type": "string", "description": "appIdentifier", "format": "uuid" } } }, "common-workflow-Workflow": { "required": [ "name", "subWorkflow" ], "type": "object", "properties": { "version": { "type": "string", "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 Workflows" }, "description": { "type": "string", "description": "Beschreibung des Workflows", "nullable": true }, "trigger": { "type": "string", "description": "Wann wird dieser Workflow ausgel\u00f6st?" }, "subWorkflow": { "type": "boolean", "description": "Handelt es sich um einen Unter-Workflow?", "default": false }, "state": { "type": "string", "description": "Status des Workflows", "readOnly": true, "enum": [ "DRAFT", "INACTIVE", "ACTIVE" ], "default": "DRAFT" }, "synchronous": { "type": "boolean", "description": "Synchroner Workflow?", "readOnly": true }, "successorRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "predecessorRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "common-workflow-ChoiceOption": { "required": [ "value" ], "type": "object", "properties": { "version": { "type": "string", "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\u00fcr die Auswahloption (Text)" }, "followUpUserDecision": { "$ref": "#/components/schemas/common-workflow-UserDecision" }, "defaultValue": { "type": "boolean" } }, "description": "Vorgegebene Antwortm\u00f6glichkeiten, oder leer, falls offene Frage" }, "common-workflow-UserDecision": { "required": [ "prompt", "resultName", "valueType" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "ID des Work-Items, zu dem die Benutzerentscheidung geh\u00f6rt", "format": "int64", "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\u00f6glichkeiten, oder leer, falls offene Frage", "items": { "$ref": "#/components/schemas/common-workflow-ChoiceOption" } }, "searchDialog": { "type": "string", "description": "Suchdialog zur Suche des Werts (statt den Auswahlm\u00f6glichkeiten)" }, "trySynchronous": { "type": "boolean", "description": "Soll versucht werden, die Benutzerentscheidung synchron abzufragen?", "default": false }, "multipleChoiceAllowed": { "type": "boolean" } }, "description": "Listen f\u00fcr Auswahloptionen" }, "common-workflow-WorkflowElement": { "type": "object", "properties": { "version": { "type": "string", "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 Elements" }, "description": { "type": "string", "description": "Ggf weitere Beschreibung", "nullable": true }, "type": { "type": "string", "description": "Gibt an, um welche Art von Element es sich bei einem WorkflowElement handelt", "enum": [ "START_EVENT", "INTERMEDIATE_EVENT", "END_EVENT_SUCCESS", "END_EVENT_ERROR", "USER_TASK", "SCRIPT_TASK", "EXCLUSIVE_SPLIT_GATEWAY", "EXCLUSIVE_JOIN_GATEWAY", "PARALLEL_JOIN_GATEWAY", "TIMER", "SUB_WORKFLOW" ] }, "script": { "type": "string", "description": "Skript, welches ausgef\u00fchrt werden soll" }, "scriptModuleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "parameters": { "type": "array", "description": "Parameter welche vor der Ausf\u00fchrung von einem Element geladen werden sollen", "items": { "$ref": "#/components/schemas/common-workflow-WorkflowElementParameter" } }, "sequelElementRefs": { "type": "array", "description": "Folge-Elemente", "readOnly": true, "items": { "$ref": "#/components/schemas/common-workflow-WorkflowSequelElementRef" } }, "uiData": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "intermediateEventIdentifiers": { "type": "array", "description": "F\u00fcr INTERMEDIATE_EVENT: wodurch wird dieses Event getriggert?", "items": { "type": "string", "description": "F\u00fcr INTERMEDIATE_EVENT: wodurch wird dieses Event getriggert?" } }, "triggerSingleInstance": { "type": "boolean", "description": "F\u00fcr INTERMEDIATE_EVENT: kann nur in der definierten Instanz getriggert werden", "default": true }, "guardingIntervalInSeconds": { "type": "integer", "description": "F\u00fcr INTERMEDIATE_EVENT: definiert ein Abfrage-Intervall, zu dem das Intermediate-Event \u00fcberpr\u00fcft wird, ob eine Ausf\u00fchrung des Skripts m\u00f6glich ist. Nur in Verbindung mit delayInSeconds", "format": "int32" }, "possibleSplitResults": { "type": "array", "description": "M\u00f6gliche Ergebnisse/Ausg\u00e4nge beim Split", "items": { "type": "string", "description": "M\u00f6gliche Ergebnisse/Ausg\u00e4nge beim Split" } }, "timeoutAfterSeconds": { "type": "integer", "description": "Verz\u00f6gerung von Timern", "format": "int64", "nullable": true }, "responsibleUserRefs": { "type": "array", "description": "Nutzer, die diesen UserTask bearbeiten k\u00f6nnen", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "responsibleUserGroupRefs": { "type": "array", "description": "Nutzergruppen, die diesen UserTask bearbeiten k\u00f6nnen", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "userDecisions": { "type": "array", "description": "Listen f\u00fcr Auswahloptionen", "items": { "$ref": "#/components/schemas/common-workflow-UserDecision" } }, "responsibleUserIsExecutingUser": { "type": "boolean", "description": "Der ausf\u00fchrende Benutzer ist auch der verantwortliche Benutzer", "default": false }, "subWorkflowRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "common-workflow-WorkflowElementParameter": { "required": [ "name" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name des Parameters" }, "requiredValueType": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Typ des Parameters, falls er z.B. durch ein Skript-Modul vorgegeben wurde", "readOnly": true }, "fixedValue": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Fester Wert (nur in Kombination mit fixedValueType)" }, "fixedValueType": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Datentyp vom festen Wert (nur in Kombination mit fixedValue)" }, "queryPresetRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "attributePath": { "type": "string", "description": "Pfad zu einem Attribut innerhalb der Query aus queryPresetRef" } }, "description": "Parameter zu einem Workflow-Element" }, "common-workflow-WorkflowSequelElementRef": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64" }, "name": { "type": "string", "description": "Name", "readOnly": true }, "description": { "type": "string", "description": "Beschreibung", "readOnly": true }, "executeOnSplitResult": { "type": "string", "description": "Wann wird dieses Element ausgef\u00fchrt?" } }, "description": "Folge-Elemente" }, "common-workflow-WorkflowChangeNameAndDescriptionRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "der neue Name f\u00fcr den Workflow" }, "description": { "type": "string", "description": "die neue Beschreibung des Worklflows" } } }, "common-output-OutputSignature": { "required": [ "contentType" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "contentType": { "type": "string", "description": "ContentType", "enum": [ "TEXT", "HTML" ] }, "content": { "type": "string", "description": "Content" } } }, "common-user-UserSubscriptionFavorite": { "required": [ "eventTypes", "refKey" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "refKey": { "type": "string", "description": "Datentyp" }, "eventTypes": { "type": "array", "description": "Event-Types", "items": { "type": "string", "description": "Event-Types" } } } }, "common-user-UserOutputFavorite": { "required": [ "moduleRef", "userRef" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "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" }, "targetReportGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetOutputConsumerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetOutputConsumerResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-user-User": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Is the user active?", "readOnly": true, "default": true }, "username": { "type": "string", "description": "username" }, "firstName": { "type": "string", "description": "first-name" }, "lastName": { "type": "string", "description": "last-name" }, "emailAddress": { "type": "string", "description": "email-address" }, "owner": { "type": "boolean", "description": "Is owner user?", "readOnly": true, "default": false }, "emailVerified": { "type": "boolean", "description": "is the email verified", "readOnly": true, "default": false }, "validTo": { "type": "string", "description": "Valid to", "format": "date-time" }, "type": { "type": "string", "description": "User type", "enum": [ "REGULAR", "SUPPORT", "SYSTEM", "LIMITED_WMS", "LIMITED_DASHBOARD", "APP_BUILTIN_USER" ] }, "roles": { "type": "array", "description": "Rollen", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "groups": { "type": "array", "description": "Gruppen", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "appIdentifier": { "type": "string", "description": "App-Identifier", "format": "uuid", "readOnly": true } } }, "common-user-UserPermission": { "type": "object", "properties": { "roles": { "uniqueItems": true, "type": "array", "description": "Rollen f\u00fcr diesen User", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "groups": { "uniqueItems": true, "type": "array", "description": "Gruppen f\u00fcr diesen User", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } } }, "common-user-RolePermission": { "required": [ "resource", "verb" ], "type": "object", "properties": { "resource": { "type": "string", "description": "the resource to authorize" }, "verb": { "type": "string", "description": "the operation/verb to authorize" }, "description": { "type": "string", "description": "description of permission", "readOnly": true }, "autoAppendable": { "type": "boolean", "description": "ist diese Berechtigung eine, die der Admin-Gruppe automatisch hinzugef\u00fcgt wird", "readOnly": true } }, "description": "the operation" }, "common-user-RolePermissionWithOrigin": { "type": "object", "properties": { "permission": { "$ref": "#/components/schemas/common-user-RolePermission" }, "virtual": { "type": "boolean", "description": "virtual permission?", "readOnly": true, "default": false }, "obtainedByRoles": { "type": "array", "description": "Rollen die dieses Recht mitgebracht haben", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "obtainedByGroups": { "type": "array", "description": "Gruppen die dieses Recht mitgebracht haben", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "description": "list of operations" }, "common-user-UserPermissionRead": { "type": "object", "properties": { "superUser": { "type": "boolean", "description": "is user superuser?", "readOnly": true, "default": false }, "operations": { "type": "array", "description": "list of operations", "readOnly": true, "items": { "$ref": "#/components/schemas/common-user-RolePermissionWithOrigin" } } } }, "common-user-Role": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Is the role active?", "readOnly": true, "default": true }, "label": { "type": "string", "description": "Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "permissions": { "type": "array", "description": "granted authorities for this role", "items": { "$ref": "#/components/schemas/common-user-RolePermission" } }, "dmsAccessLevelRead": { "type": "integer", "description": "access level or reading", "format": "int32" }, "dmsAccessLevelWrite": { "type": "integer", "description": "access level for writing", "format": "int32" }, "dmsAccessLevelDelete": { "type": "integer", "description": "access level for deleting", "format": "int32" }, "systemPresetting": { "type": "boolean", "description": "system presetting", "readOnly": true } } }, "common-user-UserMessage": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "recipientRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "senderRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "senderBotAlias": { "type": "string", "description": "Versender (Bot Name), falls kein user der Sender war", "readOnly": true }, "sendTime": { "type": "string", "description": "Zeitstempel: Gesendet", "format": "date-time", "readOnly": true }, "updateTime": { "type": "string", "description": "Zeitstempel: Aktualisierungszeit", "format": "date-time", "readOnly": true }, "lastRead": { "type": "string", "description": "Zeitstempel: Gelesen", "format": "date-time", "readOnly": true }, "state": { "type": "string", "description": "Status", "readOnly": true, "enum": [ "SEEN", "NOT_SEEN" ] }, "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "priority": { "type": "string", "description": "Priorit\u00e4t der Nachricht", "readOnly": true, "enum": [ "HIGH", "NORMAL", "LOW" ] } }, "description": "Nachricht" }, "common-user-Group": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Is the group active?", "default": true }, "label": { "type": "string", "description": "Label of this Group" }, "description": { "type": "string", "description": "Description of this Group" }, "roles": { "type": "array", "description": "roles associated with this group", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "users": { "type": "array", "description": "users associated with this group", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } } }, "common-masterdata-UnitType": { "required": [ "abbreviation", "name", "type" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "einheiten name" }, "abbreviation": { "maxLength": 255, "minLength": 0, "type": "string", "description": "einheiten abk\u00fcrzung" }, "uneceUnitOfMeasureRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "common-masterdata-UnitTypeRatio": { "required": [ "baseUnitTypeRef", "factor", "relationUnitTypeRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "baseUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "relationUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "factor": { "type": "number", "description": "Faktor", "format": "double" } } }, "common-ui-UiSetting": { "required": [ "category", "key", "mandatoryForGroups", "mandatoryForUsers", "permissionAggregation" ], "type": "object", "properties": { "version": { "type": "string", "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\u00fcssel" }, "token": { "type": "string", "description": "Eindeutiger Import-Schl\u00fcssel", "readOnly": true }, "active": { "type": "boolean", "description": "Sind die Einstellungen aktiv?", "default": true }, "mandatoryForUsers": { "type": "array", "description": "Die Einstellung ist f\u00fcr diese User Pflicht", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "mandatoryForGroups": { "type": "array", "description": "Die Einstellung ist f\u00fcr diese Gruppen Pflicht", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "value": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "permissionAggregation": { "$ref": "#/components/schemas/common-user-ObjectSpecificPermissionAggregation" } } }, "common-user-ObjectSpecificGroupPermission": { "type": "object", "properties": { "version": { "type": "string", "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" ] } }, "description": "Gruppen-Berechtigungen" }, "common-user-ObjectSpecificPermissionAggregation": { "type": "object", "properties": { "version": { "type": "string", "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\u00fcr alle Nutzer", "enum": [ "READ_ONLY", "READ_AND_EDIT" ] } }, "description": "alle Nutzer-/Gruppen-Berechtigungen" }, "common-user-ObjectSpecificUserPermission": { "type": "object", "properties": { "version": { "type": "string", "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" ] } }, "description": "Nutzer-Berechtigungen" }, "common-cunit-Translation": { "type": "object", "properties": { "version": { "type": "string", "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": "die ausgew\u00e4hlte Sprachen f\u00fcr dieses Feld" }, "fieldName": { "type": "string", "description": "Feld Name" }, "content": { "type": "string", "description": "\u00fcbersetzter Text" } } }, "common-cunit-QueryBaseHolderPreset": { "required": [ "templateGroupKey", "templateId" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "templateId": { "type": "string", "description": "Template, dem dieser Filter zugeornet worden ist." }, "templateGroupKey": { "type": "string", "description": "Template-Gruppe, der dieser Filter zugeordnet worden ist." }, "results": { "type": "array", "description": "Ergebnisse", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" } }, "defaultFor": { "type": "string", "description": "Standard-Preset f\u00fcr", "enum": [ "ACCOUNT", "ARTICLE", "BANK", "BANK_TRANSACTION", "DOCUMENT", "DOCUMENT_LINE", "DUNNING", "MANDATE", "OPENITEM", "SHIPPED_DOCUMENT", "POS_REGISTER", "CASH_DRAWER", "POS_PAYMENT_METHOD", "POS_DEPOSIT_EXPENSE_TYPE" ] } } }, "common-cunit-QueryPresetResult": { "required": [ "property" ], "type": "object", "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", "description": "sichtbare Ergebnisspalte", "default": true } }, "description": "Ergebnisse" }, "common-task-Task": { "required": [ "cronExpression", "firstExecutionTime", "jobBeanName", "label", "runAsUserRef" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "last execution date-time", "format": "date-time", "readOnly": true }, "firstExecutionTime": { "type": "string", "description": "first execution date-time", "format": "date-time" }, "nextExecutionAt": { "type": "string", "description": "next execution date-time", "format": "date-time", "readOnly": true }, "nextExecutionOverride": { "type": "string", "description": "Wann eine bevorzugte Abarbeitung angefragt wurde", "format": "date-time", "readOnly": true }, "lastStatus": { "type": "string", "description": "lastStatus", "readOnly": true, "enum": [ "CREATED", "QUEUED", "RUNNING", "TERMINATED", "SUCCESSFUL", "ERRONEOUS", "FATAL" ] }, "jobBeanName": { "type": "string", "description": "bean-name/class-name to execute" }, "state": { "type": "string", "description": "Status", "enum": [ "ACTIVE", "SUSPENDED", "TO_REMOVE" ], "default": "ACTIVE" }, "dataPayloadJson": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "runAsUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "singleton": { "type": "boolean", "description": "Is this task a singleton", "default": true }, "repetitions": { "type": "integer", "description": "How often will this task run? (null -> forever)", "format": "int32" }, "processId": { "type": "string", "description": "process id" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-sequencer-FreeSequence": { "required": [ "active", "key", "label" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "key": { "type": "string", "description": "key" }, "active": { "type": "boolean", "description": "active" }, "sequencerConfiguration": { "$ref": "#/components/schemas/common-sequencer-SequencerConfiguration" }, "nextNumber": { "maxLength": 255, "minLength": 0, "type": "string", "description": "n\u00e4chste Nummer", "readOnly": true } } }, "common-scripting-ScriptModule": { "required": [ "domain", "name", "permissionAggregation", "script" ], "type": "object", "properties": { "version": { "type": "string", "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\u00fcr die Skriptmodule", "enum": [ "UNDEFINED", "LIBRARY", "APP", "IMPORT_BATCH_PROCESSING", "WORKFLOW_INTERMEDIATE_EVENT", "WORKFLOW_SCRIPT", "WORKFLOW_SPLIT_GATEWAY" ] }, "name": { "maxLength": 255, "minLength": 0, "pattern": "[a-zA-Z0-9_-]*", "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Beschreibung" }, "appIdentifier": { "type": "string", "description": "Identifier der App", "format": "uuid" }, "script": { "type": "string", "description": "Skript" }, "sameAsPresettingScript": { "type": "boolean", "description": "Entspricht das Skript dem Presetting-Skript?", "readOnly": true, "default": false }, "withPresettingScript": { "type": "boolean", "description": "Gibt es ein Presetting-Skript?", "readOnly": true, "default": false }, "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" } }, "description": "Skript-Modul" }, "common-scripting-ScriptModuleParameter": { "required": [ "name", "valueType" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name des Parameters" }, "valueType": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Typ des Parameters" } }, "description": "Skript-Modul-Parameter" }, "common-scripting-ScriptModuleGroup": { "required": [ "name" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "pattern": "[a-zA-Z0-9_-]*", "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Beschreibung" }, "appIdentifier": { "type": "string", "description": "Identifier der App", "format": "uuid" }, "moduleRefs": { "type": "array", "description": "Referenzen auf zugeh\u00f6rige Skript-Module", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "description": "Skript-Modul-Gruppe" }, "common-output-OutputReport": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "ist dieser Report aktiv?", "readOnly": true, "default": true }, "groupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "reportTypeRef": { "$ref": "#/components/schemas/common-output-ReportTypeReference" }, "outputTemplateSource": { "type": "string", "description": "Report Quellen", "readOnly": true, "enum": [ "PARAMETER_MODE", "FILE_MODE" ] }, "textTemplates": { "type": "array", "description": "Text als ReportTemplate (Nachrichten)", "items": { "$ref": "#/components/schemas/common-output-OutputTextTemplate" } }, "languages": { "type": "array", "description": "die ausgew\u00e4hlten Sprachen f\u00fcr diesen Report", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "systemPresetting": { "type": "boolean", "description": "handelt es sich um den systemreport. Bei diesem darf die selektion nicht ver\u00e4ndert werden", "readOnly": true }, "moduleRule": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Label" }, "description": { "type": "string", "description": "description" }, "alias": { "type": "string", "description": "Alias Name f\u00fcr die Subreporte" }, "exportFilename": { "type": "string", "description": "Vorgabe f\u00fcr den Dateinamen" }, "reportUrl": { "type": "string", "description": "die vario-report-url", "readOnly": true }, "reportParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "templateFactoryConfiguration": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-output-OutputTextTemplate": { "type": "object", "properties": { "contentType": { "type": "string", "description": "Format", "enum": [ "TEXT", "HTML" ] }, "subjectTemplate": { "type": "string", "description": "template anteil f\u00fcr subject" }, "bodyTemplate": { "type": "string", "description": "template anteil f\u00fcr den body" } }, "description": "Text als ReportTemplate (Nachrichten)" }, "common-output-ReportTypeReference": { "required": [ "id" ], "type": "object", "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 }, "templateEngine": { "type": "string", "description": "Druck-Techniken", "readOnly": true, "enum": [ "VQL_REPORTS", "JSON_REPORTS", "TEXT_ONLY" ] } }, "description": "der Reporttyp" }, "common-output-OutputReportLocalizedText": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "languageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "key": { "type": "string", "description": "Der Key zum finden der \u00dcbersetzung. dieser Key darf nur bei Eintr\u00e4gen ver\u00e4ndert werden, die keinen preset Text haben" }, "presetText": { "type": "string", "description": "original text (Sprache: vario)", "readOnly": true }, "presetParameter": { "type": "array", "description": "m\u00f6gliche parameter bei dem ausdruck", "readOnly": true, "items": { "type": "string", "description": "m\u00f6gliche parameter bei dem ausdruck" } }, "text": { "type": "string", "description": "lokalisierte variante" } } }, "common-output-OutputReportGroup": { "required": [ "identifier", "label" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "moduleKey": { "type": "string", "description": "der ModuleKey des Reports", "readOnly": true }, "reportRefs": { "type": "array", "description": "die Report", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "systemPresetting": { "type": "boolean", "description": "handelt es sich um eine System-Gruppe? diese kann nicht gel\u00f6scht werden", "readOnly": true }, "defaultGroup": { "type": "boolean", "description": "ist das die default Gruppe f\u00fcr dieses OutputModul", "readOnly": true }, "label": { "type": "string", "description": "custom label" }, "identifier": { "type": "string", "description": "Identifier f\u00fcr die Gruppe" }, "exportFilename": { "type": "string", "description": "Vorgabe f\u00fcr den Dateinamen, falls der Report keinen selbst bestimmt" }, "outputFilterScript": { "type": "string", "description": "output-filter-script (if supported)" } } }, "common-locknlease-LeasableLockDto": { "type": "object", "properties": { "key": { "type": "string", "description": "Key des Locks", "readOnly": true }, "token": { "type": "integer", "description": "Token des Locks", "format": "int64", "readOnly": true }, "user": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "lockedBySystem": { "type": "boolean", "description": "Wurde diese Sperre vom System erzeugt?", "readOnly": true, "default": false }, "validUntil": { "type": "string", "description": "Ablaufuhrzeit", "format": "date-time", "readOnly": true } } }, "common-masterdata-LanguageCode": { "required": [ "isoAlpha2", "isoAlpha3", "isoName", "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 1, "type": "string" }, "isoName": { "maxLength": 255, "minLength": 1, "type": "string" }, "isoAlpha2": { "type": "string", "description": "ISO 369-1 alpha-2 code" }, "isoAlpha3": { "type": "string", "description": "ISO 369-2 alpha-3 code" }, "active": { "type": "boolean", "description": "is active", "readOnly": true, "default": true } }, "description": "ISO 369 language codes" }, "common-cunit-ArithmeticQueryTerm": { "type": "object", "properties": { "termName": { "type": "string", "description": "Der Name des Terms f\u00fcr 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\u00fchrt werden sollen mit den Termen", "items": { "type": "string", "description": "Die Operationen, die ausgef\u00fchrt werden sollen mit den Termen", "enum": [ "PLUS", "MINUS", "MULTIPLY", "DIVIDE" ] } } }, "description": "Arithmetische Terme - hier kommt die tats\u00e4chliche Berechnung rein" }, "common-cunit-ArithmeticQueryTermFragment": { "type": "object", "properties": { "operations": { "type": "array", "description": "Die Operationen, die ausgef\u00fchrt werden sollen mit den Termen", "items": { "type": "string", "description": "Die Operationen, die ausgef\u00fchrt werden sollen mit den Termen", "enum": [ "PLUS", "MINUS", "MULTIPLY", "DIVIDE" ] } } }, "description": "Das Termfragment - eine weitere Verschachtelung mit eigenen Operationen" }, "common-cunit-ArithmeticQueryTermInner": { "type": "object", "properties": { "fragment": { "$ref": "#/components/schemas/common-cunit-ArithmeticQueryTermFragment" }, "attribute": { "type": "string", "description": "Ein echtes Attribut aus dem Template" }, "fixedValue": { "type": "number", "description": "Ein Fixwert" } }, "description": "Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung" }, "common-cunit-QueryPreset": { "required": [ "forWorkflow", "label", "mode", "permissionAggregation", "templateGroupKey", "templateId" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT", "enum": [ "QUERY", "STATEMENT" ], "default": "QUERY" }, "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\u00fcr diesen filter" }, "uiPayload": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "variables": { "type": "array", "description": "Variablen f\u00fcr 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\u00e4tzliche konfigurationen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetTransformation" } }, "arithmeticQueryTerms": { "type": "array", "description": "Arithmetische Terme - hier kommt die tats\u00e4chliche Berechnung rein", "items": { "$ref": "#/components/schemas/common-cunit-ArithmeticQueryTerm" } }, "definition": { "type": "array", "description": "spaltenbeschreibung dieser zelle (bei verschachtelung)", "readOnly": true, "items": { "oneOf": [ { "$ref": "#/components/schemas/core-cunit-CuAttribute" }, { "$ref": "#/components/schemas/core-cunit-CuMeta" } ] } }, "permissionAggregation": { "$ref": "#/components/schemas/common-user-ObjectSpecificPermissionAggregation" }, "forWorkflow": { "type": "boolean", "description": "f\u00fcr Workflows vorgesehen", "default": false }, "userOptions": { "$ref": "#/components/schemas/common-cunit-QueryPresetUserOptions" } }, "description": "Adhoc Preset" }, "common-cunit-QueryPresetCrossTableCell": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" }, "cellView": { "type": "string", "description": "darstellung der werte", "enum": [ "AS_IS", "PERCENT_COL" ] }, "sumColumn": { "type": "boolean", "description": "soll eine spaltensumme erzeugt werden", "default": false }, "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" } }, "description": "enth\u00e4lt die felder, die pro rowSpec-Kombination je nach Spaltenauspr\u00e4gung ermittelt werden sollen" }, "common-cunit-QueryPresetCrossTableTransformation": { "required": [ "columnSpecs", "results", "rowSpecs" ], "type": "object", "properties": { "rowSpecs": { "type": "array", "description": "enth\u00e4lt die felder, die in einer cross-table f\u00fcr die reihenbildung verantwortlich sind (im grunde -> der group-key)", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" } }, "columnSpecs": { "type": "array", "description": "enth\u00e4lt 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\u00e4lt die felder, die pro rowSpec-Kombination je nach Spaltenauspr\u00e4gung ermittelt werden sollen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetCrossTableCell" } } }, "description": "enth\u00e4lt die felder, die in einer cross-table f\u00fcr die reihenbildung verantwortlich sind (im grunde -> der group-key)" }, "common-cunit-QueryPresetOption": { "type": "object", "properties": { "distinctResult": { "type": "boolean", "description": "soll der Query mit einem Distinct durchgef\u00fchrt werden" } }, "description": "options" }, "common-cunit-QueryPresetPageable": { "type": "object", "properties": { "limit": { "type": "integer", "description": "das Limit (MaxRecordCount) f\u00fcr diesen Query", "format": "int64" } }, "description": "pageable" }, "common-cunit-QueryPresetRequest": { "type": "object", "properties": { "mode": { "type": "string", "description": "Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT", "enum": [ "QUERY", "STATEMENT" ], "default": "QUERY" }, "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 (\u00fcberschreiben QueryPreset#results)", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" } }, "arithmeticQueryTerms": { "type": "array", "description": "Arithmetische Terme - hier kommt die tats\u00e4chliche 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" } }, "description": "CUnit-Vorlage zum erzeugen des Imports" }, "common-cunit-QueryPresetRequestPageable": { "type": "object", "properties": { "start": { "type": "integer", "description": "Start-Offset", "format": "int64" }, "limit": { "type": "integer", "description": "Ergebnis-Limit", "format": "int32" }, "sortOrders": { "type": "array", "description": "sort and order anweisungen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetSortOrder" } } }, "description": "Paging- und Sortierinformationen" }, "common-cunit-QueryPresetSortOrder": { "required": [ "direction", "property" ], "type": "object", "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" ] } }, "description": "sort and order anweisungen" }, "common-cunit-QueryPresetTransformation": { "type": "object", "properties": { "crossTable": { "$ref": "#/components/schemas/common-cunit-QueryPresetCrossTableTransformation" } }, "description": "zus\u00e4tzliche konfigurationen" }, "common-cunit-QueryPresetUserOptions": { "required": [ "pinned" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "angepinnt?", "default": false } }, "description": "nutzerbezogene Einstellungen" }, "common-data_import-ScheduledImport": { "required": [ "inputType" ], "type": "object", "properties": { "version": { "type": "string", "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\u00fcr 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" ] } } }, "common-data_import-DataImportRun": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "importMappingRuleSetRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "state": { "type": "string", "description": "Status dieses Import-Vorgangs", "readOnly": true, "enum": [ "CREATED", "EXTRACTING_DATA", "DATA_EXTRACTED", "RUNNING", "ERRONEOUS", "COMPLETED", "IGNORED", "DUMMY" ] }, "headers": { "type": "array", "description": "Spaltenzuordnungen", "items": { "$ref": "#/components/schemas/common-data_import-ImportHeader" } }, "label": { "type": "string", "description": "Label" }, "validatedSinceLastRuleChange": { "type": "boolean", "description": "Wurden die Daten seit der letzten \u00c4nderung am Regelwerk validiert?", "readOnly": true, "default": false }, "lastImportProcess": { "type": "string", "description": "Prozess-ID der letzten Tasks zu diesem Import-Vorgang", "format": "uuid" }, "inputType": { "type": "string", "description": "Typ der Eingabedaten", "enum": [ "FILE", "QUERY" ] }, "queryPresetRequest": { "$ref": "#/components/schemas/common-cunit-QueryPresetRequest" }, "scheduledImportRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "common-data_import-ImportHeader": { "required": [ "array", "caption", "columnRef" ], "type": "object", "properties": { "id": { "type": "integer", "description": "id", "format": "int64", "readOnly": true }, "caption": { "type": "string", "description": "eigener Name der Spalte" }, "columnRef": { "type": "string", "description": "physikalischer Spaltenname" }, "array": { "type": "boolean", "description": "handelt es sich um ein Array?" } }, "description": "Spaltenzuordnungen" }, "common-data_import-DataImportEntry": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "index": { "type": "integer", "description": "1-basierter Index", "format": "int64", "readOnly": true }, "state": { "type": "string", "description": "Status dieses Eintrags", "readOnly": true, "enum": [ "NOT_YET_RUN", "ERRONEOUS", "SUCCESSFUL", "IGNORED", "OUT_OF_BOUNDS", "MANUALLY_IGNORED", "MANUALLY_COMPLETED" ] }, "content": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "transformationResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "violations": { "type": "array", "description": "ggf. aufgetretene Fehlermeldungen", "readOnly": true, "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } }, "validationState": { "type": "string", "description": "Ergebnis der Validierung", "readOnly": true, "enum": [ "NOT_YET_RUN", "ERRONEOUS", "SUCCESSFUL", "IGNORED", "OUT_OF_BOUNDS", "MANUALLY_IGNORED", "MANUALLY_COMPLETED" ] }, "lastValidatedAt": { "type": "string", "description": "Zeitpunkt der letzten Validierung", "format": "date-time", "readOnly": true } } }, "common-data_import-CsvExportSetting": { "required": [ "columnSeparator", "quotingChar", "targetFieldDefinitions" ], "type": "object", "properties": { "targetFieldDefinitions": { "type": "array", "description": "Spaltendefinitionen (in korrekter Reihenfolge)", "items": { "type": "string", "description": "Spaltendefinitionen (in korrekter Reihenfolge)" } }, "columnSeparator": { "maxLength": 1, "minLength": 1, "type": "string", "description": "Spaltentrenner", "default": ";" }, "quotingChar": { "maxLength": 1, "minLength": 1, "type": "string", "description": "Quotierungszeichen", "default": "\"" }, "writeHeaderLine": { "type": "boolean", "description": "Kopfzeile schreiben?", "default": true }, "linebreakType": { "type": "string", "description": "Art des Zeilenumbruchs", "enum": [ "CR_LF", "CR", "LF" ], "default": "CR_LF" } }, "description": "Einstellungen f\u00fcr CSV-Export" }, "common-data_import-ExportSetting": { "required": [ "charset", "fileName" ], "type": "object", "properties": { "fileName": { "type": "string", "description": "Dateiname ohne Dateinamenserweiterung" }, "charset": { "type": "string", "description": "Zeichensatz", "enum": [ "UTF_8", "UTF_8_BOM", "ASCII", "LATIN_1" ], "default": "UTF_8_BOM" }, "csvSetting": { "$ref": "#/components/schemas/common-data_import-CsvExportSetting" } }, "description": "Wenn ein Dateiexport-Modul ausgew\u00e4hlt wurde: Export-Einstellungen" }, "common-data_import-FormatDirective": { "required": [ "formatType" ], "type": "object", "properties": { "formatType": { "type": "string", "description": "F\u00fcr welchen Datentyp ist diese Formatierung gedacht", "enum": [ "NUMERIC", "DATE", "DATETIME", "BOOLEAN" ] }, "patternString": { "type": "string", "description": "F\u00fcr DATE & DATETIME: Ein Muster zum parsen" }, "groupingSign": { "type": "string", "description": "Das Tausender-Trennzeichen f\u00fcr Zahlwerte" }, "decimalSign": { "type": "string", "description": "Das Dezimal-Trennzeichen f\u00fcr Zahlwerte" }, "representationForTrue": { "type": "string", "description": "Ein Text, der als boolescher Wert f\u00fcr true steht (Beispielsweise 'J')" }, "representationForFalse": { "type": "string", "description": "Ein Text, der als boolescher Wert f\u00fcr false steht (Beispielsweise 'N')" } }, "description": "Standard-Format f\u00fcr Wahrheitswerte" }, "common-data_import-IgnoreRule": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "comparisonType": { "type": "string", "description": "Der Vergleichsoperator", "enum": [ "IS_NULL", "IS_NOT_NULL", "EQUALS", "NOT_EQUALS", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "NOT_CONTAINS", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN", "LESS_THAN_EQUALS" ] }, "matchingType": { "type": "string", "description": "Schlagen wir fehl bei einmaliger \u00dcbereinstimmung oder m\u00fcssen alle Werte \u00fcbereinstimmen?", "enum": [ "ANY_MATCH", "ALL_MATCH" ] }, "comparisonValue": { "type": "string", "description": "Wert, der zum Ausschluss f\u00fchren soll" }, "fieldToCompare": { "type": "string", "description": "Mit dem Wert aus welchem Feld soll verglichen Werden?" } }, "description": "Bedingungen, unter denen das zu importierende Objekt ignoriert werden soll" }, "common-data_import-ImportMappingRule": { "required": [ "transformation" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "transformation": { "$ref": "#/components/schemas/common-data_import-Transformation" } }, "description": "Mapping-Regeln" }, "common-data_import-ImportMappingRuleSet": { "required": [ "mode" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Modus", "enum": [ "SCRIPT", "IMPORT", "EXPORT" ] }, "label": { "type": "string", "description": "Eindeutiges Label" }, "jsonRoot": { "type": "string", "description": "Bei JSON-Import: Ab welchem Pfad beginnen die Import-Daten?" }, "rules": { "type": "array", "description": "Mapping-Regeln", "items": { "$ref": "#/components/schemas/common-data_import-ImportMappingRule" } }, "importModuleKey": { "type": "string", "description": "F\u00fcr welchen Import gilt dieser Regelsatz" }, "dataFrom": { "type": "integer", "description": "Index des ersten Datensatzes (1-basiert) - alle vorherigen werden ignoriert", "format": "int64" }, "dataTo": { "type": "integer", "description": "Index des letzten Datensatzes (1-basiert) - alle danach werden ignoriert", "format": "int64" }, "headerIndex": { "type": "integer", "description": "Falls vorhanden: Index der Kopfzeile (1-basiert)", "format": "int64" }, "columnSeparator": { "type": "string", "description": "Nur f\u00fcr CSV: Trennzeichen innerhalb einer Zeile" }, "charSet": { "type": "string", "description": "F\u00fcr CSV & JSON: Verwendeter Zeichensatz", "enum": [ "UTF_8", "ASCII", "LATIN_1", "AUTO_DETECT" ] }, "quotingChar": { "type": "string", "description": "Nur f\u00fcr CSV: Zeichen um ein Textfeld zu quoten (i.d.R. ' oder \")" }, "targetFieldRules": { "type": "array", "description": "Gibt an, wie mit Zielfeldern und Unterobjekten umgegangen werden soll.", "items": { "$ref": "#/components/schemas/common-data_import-TargetFieldRule" } }, "createRulesForEavGroup": { "type": "string", "description": "Gibt an, dass f\u00fcr eine Eav-Gruppe bei der Ausf\u00fchrung Regeln erzeugt werden sollen." }, "defaultDateFormatDirective": { "$ref": "#/components/schemas/common-data_import-FormatDirective" }, "defaultDateTimeFormatDirective": { "$ref": "#/components/schemas/common-data_import-FormatDirective" }, "defaultNumberFormatDirective": { "$ref": "#/components/schemas/common-data_import-FormatDirective" }, "defaultBooleanFormatDirective": { "$ref": "#/components/schemas/common-data_import-FormatDirective" }, "script": { "type": "string", "description": "Falls Mode == SCRIPT: auszuf\u00fchrendes Skript. Nur Skript oder Skript-Modul darf gesetzt sein" }, "scriptModuleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "parameters": { "type": "array", "description": "Parameter zum Skript", "items": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSetParameter" } }, "advancedUi": { "type": "boolean", "description": "Erweiterte Darstellung im UI verwenden?", "default": false }, "ignoreEmptyData": { "type": "boolean", "description": "Bei JSON-Import: Leere Datenmenge ignorieren?", "default": false }, "exportSetting": { "$ref": "#/components/schemas/common-data_import-ExportSetting" }, "suppressWebhooks": { "type": "boolean", "description": "Sollen Webhooks bei Ausf\u00fchrung deaktiviert werden?", "default": false }, "suppressWorkflows": { "type": "boolean", "description": "Sollen Workflows bei Ausf\u00fchrung deaktiviert werden?", "default": false } }, "description": "Regelsatz f\u00fcr den Import-Vorgang" }, "common-data_import-ImportMappingRuleSetParameter": { "required": [ "name" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Name des Parameters" }, "requiredValueType": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Typ des Parameters, falls er z.B. durch ein Skript-Modul vorgegeben wurde", "readOnly": true }, "fixedValue": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Fester Wert (nur in Kombination mit fixedValueType)" }, "fixedValueType": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Datentyp vom festen Wert (nur in Kombination mit fixedValue)" }, "queryPresetRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "variableMapping": { "type": "object", "additionalProperties": { "type": "string", "description": "Mapping von Query-Variable (Key) zu Attributpfaden in den Importdaten (Value)" }, "description": "Mapping von Query-Variable (Key) zu Attributpfaden in den Importdaten (Value)" }, "attributePath": { "type": "string", "description": "Pfad zu einem Attribut innerhalb der Query aus queryPresetRef" } }, "description": "Parameter zu einem Import-Rule-Set" }, "common-data_import-Replacement": { "required": [ "from" ], "type": "object", "properties": { "from": { "type": "string", "description": "zu ersetzende Zeichenkette" }, "to": { "type": "string", "description": "Ersatz f\u00fcr die Zeichenkette" } }, "description": "f\u00fcr REPLACE: Ersetzungen" }, "common-data_import-TargetFieldRule": { "required": [ "path" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "path": { "type": "string", "description": "Pfad zu dem Unterobjekt / Feld" }, "lookupFields": { "type": "array", "description": "Anhand welcher Felder soll das Objekt identifiziert werden? Nur f\u00fcr LOAD_OR_INSERT, UPDATE und UPSERT.", "items": { "type": "string", "description": "Anhand welcher Felder soll das Objekt identifiziert werden? Nur f\u00fcr LOAD_OR_INSERT, UPDATE und UPSERT." } }, "policy": { "type": "string", "description": "Wie soll mit Unterobjekten umgegangen werden?", "enum": [ "LOAD", "INSERT", "INSERT_FACTORY", "UPSERT", "UPDATE", "LOAD_OR_INSERT", "LOAD_OR_IGNORE" ] }, "nullValueHandlingStrategy": { "type": "string", "description": "Wie soll mit einem Null-Wert verfahren werden?", "enum": [ "IGNORE", "OVERRIDE" ] }, "ignoreRules": { "type": "array", "description": "Bedingungen, unter denen das zu importierende Objekt ignoriert werden soll", "items": { "$ref": "#/components/schemas/common-data_import-IgnoreRule" } } }, "description": "Gibt an, wie mit Zielfeldern und Unterobjekten umgegangen werden soll." }, "common-data_import-Transformation": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string", "description": "Typ der Transformation", "enum": [ "DIRECT", "CONCAT", "TRIM", "UPPER_CASE", "LOWER_CASE", "REPLACE", "REGEX_REPLACE", "FIXED_VALUE", "COALESCE", "ROW_INDEX", "GET_AT_INDEX", "ITERATE", "GROUP_TO_OBJECT", "MODULE_SPECIFIC" ] }, "children": { "type": "array", "description": "Sub-Transformationen als Input f\u00fcr die Transformation", "items": { "$ref": "#/components/schemas/common-data_import-Transformation" } }, "columnName": { "type": "string", "description": "f\u00fcr DIRECT, GET_AT_INDEX & ITERATE: Spalte, aus der die Daten entnommen werden sollen" }, "fixedValue": { "type": "string", "description": "f\u00fcr FIXED_VALUE: Wert" }, "replacements": { "type": "array", "description": "f\u00fcr REPLACE: Ersetzungen", "items": { "$ref": "#/components/schemas/common-data_import-Replacement" } }, "matchWholeFieldsOnly": { "type": "boolean", "description": "f\u00fcr REPLACE: Ersetzung nur, wenn der gesamte Wert \u00fcbereinstimmt, keine Substrings" }, "regexSearch": { "type": "string", "description": "f\u00fcr REGEX_REPLACE: Der Regul\u00e4re Ausdruck, nach dem gesucht wird" }, "regexReplacement": { "type": "string", "description": "f\u00fcr REGEX_REPLACE: Die Ersetzung, die f\u00fcr den Regex durchgef\u00fchrt wird" }, "caseSensitive": { "type": "boolean", "description": "f\u00fcr (REGEX_)REPLACE: Nur ersetzen, wenn Gro\u00df-/Kleinschreibung passt?" }, "useDefaultValueForReplacement": { "type": "boolean", "description": "f\u00fcr REPLACE mit matchWholeFieldsOnly:Soll durch den default-Wert ersetzt werden, wenn kein Ausdruck passt?", "default": false }, "defaultValue": { "type": "string", "description": "f\u00fcr REPLACE mit matchWholeFieldsOnly: Ersetzung, wenn kein Ausdruck passt" }, "index": { "type": "integer", "description": "f\u00fcr GET_AT_INDEX: Das wievielte Element des Array wollen wir? (0-basierter Index)", "format": "int32" }, "target": { "type": "string", "description": "Ziel, wohin das Transformationsergebnis geschrieben wird" }, "formatDirective": { "$ref": "#/components/schemas/common-data_import-FormatDirective" }, "moduleSpecificTransformationKey": { "type": "string", "description": "Key f\u00fcr Sonder-Transformationen" }, "suppressFailures": { "type": "boolean", "description": "f\u00fcr Sonder-Transformationen: Wenn ein Fehler auftritt ignorieren und null verwenden?" }, "auxiliaryTransformation": { "type": "boolean", "description": "Hilfs-Transformation ohne echtes Mapping-Target?", "default": false }, "dataType": { "type": "string", "description": "f\u00fcr Hilfs-Transformationen: Datentyp" } }, "description": "Gibt an, wie der Wert f\u00fcr target erzeugt wird." }, "common-data_import-UpdateMultiPartImportRunRequest": { "type": "object", "properties": { "label": { "type": "string", "description": "Bezeichnung" }, "orderedRuleSets": { "type": "array", "description": "Import-Regelwerk mit definierter Reihenfolge", "items": { "$ref": "#/components/schemas/common-data_import-UpdateMultiPartOrderedRuleSetRequest" } } } }, "common-data_import-UpdateMultiPartOrderedRuleSetRequest": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID eines MultiPartImportOrderedRuleSet", "format": "int64" }, "step": { "type": "integer", "description": "Stufe, auf der der einzelne Import gestartet wird", "format": "int32" }, "fileName": { "type": "string", "description": "Datei, die f\u00fcr den Import verwendet wird (inkl. Dateiendung)" }, "label": { "type": "string", "description": "Name des Imports" }, "ruleSet": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" } }, "description": "Import-Regelwerk mit definierter Reihenfolge" }, "common-data_import-MultiPartImportOrderedRuleSet": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "importRun": { "$ref": "#/components/schemas/common-data_import-DataImportRun" }, "step": { "type": "integer", "description": "Stufe, auf dem der Import-Run gestartet wird", "format": "int32" }, "fileName": { "type": "string", "description": "Datei, die f\u00fcr den Import verwendet wird" }, "importMappingRuleSetRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "label": { "type": "string", "description": "Bezeichnung" } }, "description": "Import-Regelwerk und -Lauf nach Reihenfolge" }, "common-data_import-MultiPartImportRun": { "type": "object", "properties": { "version": { "type": "string", "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" }, "state": { "type": "string", "description": "Status", "enum": [ "CREATED", "EXTRACTING_DATA", "DATA_EXTRACTED", "RUNNING", "ERRONEOUS", "COMPLETED", "IGNORED", "DUMMY" ] }, "orderedRuleSets": { "type": "array", "description": "Import-Regelwerk und -Lauf nach Reihenfolge", "items": { "$ref": "#/components/schemas/common-data_import-MultiPartImportOrderedRuleSet" } }, "template": { "type": "boolean", "description": "Handelt es sich um eine Vorlage?", "default": false } } }, "common-masterdata-CurrencyCode": { "required": [ "isoAlpha3", "isoNumeric", "label", "symbol" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 1, "type": "string", "description": "label of this currency" }, "isoAlpha3": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ISO A(3) value of this currency" }, "isoNumeric": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ISO N(3) value of this currency" }, "symbol": { "maxLength": 5, "minLength": 1, "type": "string", "description": "symbol of this currency" }, "active": { "type": "boolean", "description": "is active", "readOnly": true, "default": true } }, "description": "currency codes - ISO 4217" }, "common-masterdata-CurrencyExchangeRate": { "required": [ "exchangeRate", "fromCurrency", "toCurrency", "validFrom" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "valid from", "format": "date" }, "active": { "type": "boolean", "description": "is active", "readOnly": true, "default": true } }, "description": "currency exchange rates" }, "common-create_template-CreateTemplate": { "required": [ "content", "domain", "name" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "Standard-Vorlage?", "default": false }, "content": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-create_template-CreateTemplateGroup": { "required": [ "label" ], "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Bezeichnung" }, "description": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "Beschreibung" }, "domain": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Domain dieser Gruppe" }, "templateRefs": { "type": "array", "description": "Templates in dieser Gruppe", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } } }, "common-masterdata-CountryRegion": { "required": [ "countryCode", "label" ], "type": "object", "properties": { "version": { "type": "string", "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\u00fcrzung" }, "regionalCode": { "type": "string", "description": "Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)" }, "iso3166_2Code": { "maxLength": 6, "minLength": 4, "type": "string", "description": "ISO 3166-2 Code f\u00fcr die Region" }, "countryCode": { "$ref": "#/components/schemas/common-masterdata-CountryReference" }, "active": { "type": "boolean", "description": "is active", "readOnly": true, "default": true } }, "description": "Bundesland bzw. Regions-Verwaltung" }, "common-masterdata-CountryCode": { "required": [ "isoAlpha2", "isoAlpha3", "isoNumeric", "name" ], "type": "object", "properties": { "version": { "type": "string", "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" }, "nameEnglish": { "type": "string" }, "isoAlpha2": { "maxLength": 2, "minLength": 2, "type": "string", "description": "ISO 3166-1 alpha-2 code" }, "isoAlpha3": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ISO 3166-1 alpha-3 code" }, "isoNumeric": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ISO 3166-1 numeric code" }, "ewuMemberFrom": { "type": "string", "description": "this country is member in the ewu from...", "format": "date" }, "ewuMemberTo": { "type": "string", "description": "this country is member in the ewu unti...", "format": "date" }, "active": { "type": "boolean", "description": "is active", "readOnly": true, "default": true }, "languageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "currencyRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "ISO_3166_country_codes " }, "banking-api-BankingUser": { "required": [ "email", "username", "varioUserRef" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "bankingProviderRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "username": { "type": "string", "description": "username" }, "password": { "type": "string", "description": "password", "writeOnly": true }, "email": { "type": "string", "description": "email" }, "replicated": { "type": "boolean", "description": "is user replicated", "readOnly": true, "default": false }, "requiredUserAction": { "type": "string", "description": "type of required user action", "enum": [ "NO_ACTION_REQUIRED", "REPLICATION_REQUIRED", "PASSWORD_CHANGE_REQUIRED", "COULD_NOT_CHECK" ] }, "autoUpdateEnabled": { "type": "boolean", "description": "Is autoupdate on finAPI active" }, "varioUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "banking-api-BankingProvider": { "required": [ "bpIdentifier", "bpName" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "bpName": { "type": "string", "description": "banking provider name" }, "bpIdentifier": { "type": "string", "description": "banking provider identifier", "enum": [ "FINAPI", "FINAPI_SANDBOX", "MOCKBANK" ] }, "bankingUsers": { "type": "array", "description": "banking users for this provider", "items": { "$ref": "#/components/schemas/banking-api-BankingUser" } } } }, "banking-connector-BankingParameter": { "type": "object" }, "erp-wms-StockTransferProcessingRequest": { "required": [ "stockTransferType" ], "type": "object", "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "stockTransferType": { "type": "string", "description": "Umlagerungsarten", "enum": [ "FROM_TRANSIT", "TO_TRANSIT" ] }, "pickTrolleyId": { "type": "integer", "description": "Der aktuelle Wagen", "format": "int64" }, "quantity": { "type": "number", "description": "Mengen\u00e4nderung" }, "processingAction": { "type": "string", "description": "Spezielle Aktion bei der Verarbeitung von Picklisten", "enum": [ "NONE", "END" ] }, "articleId": { "type": "integer", "description": "ID vom aktuellen Artikel", "format": "int64" }, "storageBinId": { "type": "integer", "description": "ID vom Ziel Lagerplatz", "format": "int64" }, "articleSerialNumberId": { "type": "integer", "description": "ID einer Seriennummer", "format": "int64" } } }, "erp-stock-Stock": { "required": [ "amount", "articleId", "storageBinId" ], "type": "object", "properties": { "articleId": { "type": "integer", "description": "Artikel", "format": "int64" }, "storageBinId": { "type": "integer", "description": "Lagerplatz", "format": "int64" }, "storageBinDisplayName": { "type": "string", "description": "Anzeigename vom Lagerplatz", "readOnly": true }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "amount": { "type": "number", "description": "Bestand" }, "reservedSerialQuantity": { "type": "number", "description": "Reservierte Menge der Seriennummer auf dem Lagerplatz" } }, "description": "Bestand" }, "erp-wms-ArticleTrolleyStockInfo": { "required": [ "amount", "unit" ], "type": "object", "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\u00fcr den Artikel vordefinierter Lagerplatzu", "items": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" } } }, "description": "Artikel Bestand" }, "erp-wms-StockTransferProcessingResponse": { "type": "object", "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", "description": "Sollen Lagerpl\u00e4tze angezeigt werden?", "default": false } } }, "erp-wms-PickTrolleyBoxGenerateRequest": { "type": "object", "properties": { "pickTrolleyId": { "type": "integer", "description": "ID des Pickwagens", "format": "int64" }, "labelPrefix": { "type": "string", "description": "Pr\u00e4fix des Labels der generierten Boxen" }, "labelPostfixStart": { "type": "integer", "description": "Startwert des Postfix vom Label", "format": "int32", "default": 1 }, "desiredCount": { "type": "integer", "description": "Gew\u00fcnschte Anzahl", "format": "int32" } }, "description": "Infos zur Generierung von Pickboxen" }, "erp-wms-PicklistParcel": { "required": [ "weight", "weightUnitTypeRef" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID", "format": "int64" }, "weight": { "type": "number", "description": "Gewicht" }, "weightUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "length": { "type": "number", "description": "L\u00e4nge" }, "width": { "type": "number", "description": "Breite" }, "height": { "type": "number", "description": "H\u00f6he" }, "sizeUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" } }, "description": "Paket zur Pickliste" }, "erp-spi-VdsParcel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "width": { "type": "number" }, "height": { "type": "number" }, "length": { "type": "number" }, "dimensionUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "weight": { "type": "number" }, "weightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "trackingNumber": { "type": "string" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/erp-spi-VdsParcelLine" } }, "packageParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "shipmentId": { "type": "integer", "format": "int64" }, "parcelState": { "type": "string", "enum": [ "OPEN", "REQUESTED", "COMPLETED", "ERROR", "MANUAL", "CANCELLED" ] }, "carrierResponse": { "type": "string" }, "validationErrors": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-spi-VdsParcelLine": { "type": "object", "properties": { "parcelId": { "type": "integer", "format": "int64" }, "number": { "type": "string" }, "description": { "type": "string" }, "amount": { "type": "number" }, "grossWeight": { "type": "number" }, "grossWeightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "netWeight": { "type": "number" }, "netWeightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "grossPrice": { "type": "number" }, "netPrice": { "type": "number" }, "internationalParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "dangerousGoodsParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-wms-PicklistProcessingRequest": { "required": [ "processingType" ], "type": "object", "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "processingType": { "type": "string", "description": "Art der Picklisten-Verarbeitung", "enum": [ "PICKING", "PACKING" ] }, "processingAction": { "type": "string", "description": "Spezielle Aktion bei der Verarbeitung von Picklisten", "enum": [ "NONE", "COMMIT", "CANCEL", "RESET_TO_READY_FOR_PACKING", "PAUSE", "CHANGE_DELIVERY_METHOD_AND_TERM", "PROCESS_SERIAL_NUMBER_LIST", "CREATE_PICKLIST_FOR_MISSING_GOODS_PICKING", "PARCEL_WEIGHED", "PARCELS_WEIGHED_FOR_DELIVERY", "SHIPPING_DETAILS_PROVIDED_AND_PARCEL_WEIGHED", "SHIPPING_DETAILS_PROVIDED", "SHIPPING_DETAILS_PROVIDED_FOR_DELIVERY", "SHIPPING_DETAILS_PROVIDED_AND_PARCEL_WEIGHED_FOR_DELIVERY" ], "default": "NONE" }, "picklistId": { "type": "integer", "description": "ID der aktuellen Pickliste", "format": "int64" }, "pickTrolleyId": { "type": "integer", "description": "ID des aktuellen Pickwagen", "format": "int64" }, "pickTrolleyBoxId": { "type": "integer", "description": "ID der aktuellen Pickbox", "format": "int64" }, "lastProcessedPicklistLineId": { "type": "integer", "description": "ID der letzten verarbeitete Position", "format": "int64" }, "lastProcessedPicklistLineComponentId": { "type": "integer", "description": "ID der letzten verarbeiteten Komponente", "format": "int64" }, "lastProcessedOrderId": { "type": "integer", "description": "ID vom Letzten verarbeiteter Auftrag", "format": "int64" }, "articleId": { "type": "integer", "description": "ID vom aktuellen Artikel", "format": "int64" }, "serialNumberId": { "type": "integer", "description": "ID der aktuellen Seriennummer", "format": "int64" }, "storageBinId": { "type": "integer", "description": "ID vom aktueller Lagerplatz", "format": "int64" }, "deviatingDeliveryTermId": { "type": "integer", "description": "ID der ge\u00e4nderten Lieferbedingung", "format": "int64" }, "deviatingDeliveryMethodId": { "type": "integer", "description": "ID der ge\u00e4nderten Lieferart", "format": "int64" }, "manualQuantityChange": { "type": "number", "description": "Manuelle Mengen\u00e4nderung" }, "serialNumberIdsToProcess": { "type": "array", "description": "Liste von IDs von Artikel-Seriennummern, welche verarbeitet werden sollen", "items": { "type": "integer", "description": "Liste von IDs von Artikel-Seriennummern, welche verarbeitet werden sollen", "format": "int64" } }, "weighedParcels": { "type": "array", "description": "Pakete, zu denen das Gewicht ermittelt wurde", "items": { "$ref": "#/components/schemas/erp-wms-PicklistParcel" } }, "absoluteManualQuantityChange": { "type": "boolean" } } }, "erp-wms-PicklistProcessingResponse": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "processingState": { "type": "string", "description": "Status der Picklistenverarbeitung", "enum": [ "PICKING_FINISHED", "PACKING_FINISHED", "DELIVERY_DOCUMENT_CREATED", "PICKLIST_PAUSED", "PICKLIST_CANCELLED", "PICKLIST_CHOSEN", "PICK_TROLLEY_CHOSEN", "PICK_TROLLEY_BOX_CHOSEN", "PICK_TROLLEY_BOX_CANCELLED", "STORAGE_BIN_CHOSEN", "ARTICLE_CHOSEN", "SERIAL_NUMBER_CHOSEN", "SERIAL_NUMBER_LIST_PROCESSED", "ABSOLUTE_QUANTITY_MANUAL_CHANGED", "RELATIVE_QUANTITY_MANUAL_CHANGED", "PARCEL_NEEDS_TO_BE_WEIGHED", "SHIPPING_DETAILS_REQUIRED", "SHIPPING_DETAILS_AND_PARCEL_WEIGHT_REQUIRED", "PARCELS_FOR_DELIVERY_NEED_TO_BE_WEIGHED", "SHIPPING_DETAILS_REQUIRED_FOR_DELIVERY", "SHIPPING_DETAILS_AND_PARCEL_WEIGHT_REQUIRED_FOR_DELIVERY", "SCAN_DELIVERY_DOCUMENT_OR_SHIPPING_LABEL", "SCAN_DELIVERY_DOCUMENT", "SCAN_SHIPPING_LABEL", "PICKLIST_FOR_MISSING_GOODS_PICKING_CREATED" ] }, "picklist": { "$ref": "#/components/schemas/erp-wms-ProcessedPicklist" }, "pickTrolleyId": { "type": "integer", "description": "ID des aktuellen Pickwagen", "format": "int64" }, "pickTrolleyBoxId": { "type": "integer", "description": "ID der aktuellen Pickbox", "format": "int64" }, "lastProcessedPicklistLineId": { "type": "integer", "description": "ID der letzten verarbeitete Position", "format": "int64" }, "lastProcessedPicklistLineComponentId": { "type": "integer", "description": "ID der letzten verarbeiteten Komponente", "format": "int64" }, "lastProcessedOrderId": { "type": "integer", "description": "ID vom Letzten verarbeiteter Auftrag", "format": "int64" }, "createdDeliveryIds": { "type": "array", "description": "IDs der erstellten Liefer-Belege", "items": { "type": "integer", "description": "IDs der erstellten Liefer-Belege", "format": "int64" } }, "erroneousOutputs": { "type": "array", "description": "Fehlerhafte Druckauftraege", "items": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } }, "articleId": { "type": "integer", "description": "ID vom aktuellen Artikel", "format": "int64" }, "articleNumber": { "type": "string", "description": "Nummer vom aktuellen Artikel" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "storageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "deliveryMethod": { "$ref": "#/components/schemas/erp-delivery-DeliveryMethod" }, "deliveryTerm": { "$ref": "#/components/schemas/erp-delivery-DeliveryTerm" }, "picklistCancellationResult": { "$ref": "#/components/schemas/erp-wms-PicklistCancellationResult" }, "shipmentId": { "type": "integer", "description": "ID des Shipments f\u00fcr den Versanddialog, wenn processingState folgende Werte hat:\n- {@link EPicklistProcessingState#SHIPPING_DETAILS_REQUIRED}\n- {@link EPicklistProcessingState#SHIPPING_DETAILS_AND_PARCEL_WEIGHT_REQUIRED}\n- {@link EPicklistProcessingState#SHIPPING_DETAILS_REQUIRED_FOR_DELIVERY})\n- {@link EPicklistProcessingState#SHIPPING_DETAILS_AND_PARCEL_WEIGHT_REQUIRED_FOR_DELIVERY})\n", "format": "int64" }, "parcelId": { "type": "integer", "description": "ID des aktuellen Pakets, wenn das Gewicht ben\u00f6tigt wird und/oder der Versanddialog gezeigt werden soll", "format": "int64" }, "parcelCarrierResponse": { "type": "string", "description": "Nachricht vom Versender, wenn zu einem Problem beim Druck vom Versandlabel kam" }, "pickTrolleyRequired": { "type": "boolean", "description": "Wird ein Pickwagen f\u00fcr die Verarbeitung ben\u00f6tigt?", "default": false } } }, "erp-wms-ProcessedPicklist": { "required": [ "id", "lines", "number" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID der Pickliste", "format": "int64" }, "number": { "type": "string", "description": "Nummer der Pickliste" }, "lines": { "type": "array", "description": "Positionen der Pickliste ", "items": { "$ref": "#/components/schemas/erp-wms-ProcessedPicklistLine" } }, "usedTemplate": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate" }, "processedByUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Verarbeitete Pickliste" }, "erp-wms-ProcessedPicklistLine": { "required": [ "articleId", "componentId", "id", "lineType", "position", "quantity", "showStorageBinOrLocation", "storageId" ], "type": "object", "properties": { "id": { "type": "integer", "description": "ID der Position", "format": "int64" }, "componentId": { "type": "integer", "description": "ID der Position der hier dargestellten Komponente", "format": "int64" }, "position": { "type": "integer", "description": "Nummer der Position in der aktuellen Ansicht diese Positionsliste", "format": "int32" }, "lineType": { "type": "string", "description": "Arten von Picklistenpositionen", "enum": [ "ARTICLE", "ASSEMBLY_GROUP" ] }, "articleId": { "type": "integer", "description": "ID des Artikels", "format": "int64" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelbezeichnung", "readOnly": true }, "articleAlternativeName": { "type": "string", "description": "abweichende Artikelbezeichnung", "readOnly": true }, "articleDescription": { "type": "string", "description": "Artikelbeschreibung", "readOnly": true }, "assemblyGroupArticleNumber": { "type": "string", "description": "Artikelnummer der Baugruppe, falls diese Position eine Komponente zu einer Baugruppe darstellt", "readOnly": true }, "storageId": { "type": "integer", "description": "ID des Lagers, aus dem gepickt werden soll", "format": "int64" }, "storageNumber": { "type": "string", "description": "Lagernummer", "readOnly": true }, "storageDisplayName": { "type": "string", "description": "Lageranzeigename", "readOnly": true }, "storageLocation": { "type": "string", "description": "Lagerort, wenn keine Lagerpl\u00e4tze vorhanden", "readOnly": true }, "pickTrolleyBoxId": { "type": "integer", "description": "Zu verwendende PickTrolleyBox", "format": "int64", "readOnly": true }, "pickTrolleyBoxLabel": { "type": "string", "description": "Label der zu verwendenden PickTrolleyBox", "readOnly": true }, "showPickTrolleyBox": { "type": "boolean", "description": "Pickbox der Positionen der Picklisten im UI anzeigen", "readOnly": true, "default": false }, "quantity": { "type": "number", "description": "Geforderte Menge der Position" }, "quantityCommitted": { "type": "number", "description": "Verarbeitete Menge der Position" }, "bookedStorageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "specifiedStorageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "showStorageBinOrLocation": { "type": "string", "description": "Soll ein Lagerplatz oder ein Lagerort angezeigt werden", "readOnly": true, "enum": [ "STORAGE_BIN", "STORAGE_LOCATION" ] }, "presetSerialNumbers": { "type": "array", "description": "Vorgegebene Seriennummern", "items": { "$ref": "#/components/schemas/erp-wms-ProcessedPicklistSerialNumber" } }, "processedSerialNumbers": { "type": "array", "description": "Erfasste Seriennummern", "items": { "$ref": "#/components/schemas/erp-wms-ProcessedPicklistSerialNumber" } } }, "description": "Verarbeitete Position einer Pickliste" }, "erp-wms-ProcessedPicklistSerialNumber": { "type": "object", "properties": { "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "quantity": { "type": "number", "description": "Menge" } }, "description": "Verarbeitete Seriennummern zu einer Pickliste" }, "erp-wms-PicklistCreationResult": { "type": "object", "properties": { "createdPicklists": { "type": "array", "description": "Infos zu den erzeugten Picklisten", "items": { "$ref": "#/components/schemas/erp-wms-PicklistInfo" } }, "creationLog": { "type": "array", "description": "Protokoll der Erzeugung", "items": { "type": "string", "description": "Protokoll der Erzeugung" } } }, "description": "Ergebnis der Erzeugung von Picklisten" }, "erp-wms-PicklistInfo": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID der Pickliste", "format": "int64" }, "number": { "type": "string", "description": "Nummer der Pickliste" }, "state": { "type": "string", "description": "Status der Pickliste", "enum": [ "CREATED", "PAUSED_IN_PICKING", "IN_PICKING", "PICKED", "PAUSED_IN_PACKING", "IN_PACKING", "CANCELLED", "FINISHED" ] }, "processedByUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "lineCount": { "type": "integer", "description": "Anzahl der Positionen auf der Pickliste", "format": "int64" }, "orderCount": { "type": "integer", "description": "Anzahl der Auftr\u00e4ge auf der Pickliste", "format": "int64" }, "pickTrolleyLabel": { "type": "string", "description": "Ggf. Label des Pickwagens, falls es sich um die rollende Kommissionierung handelt" }, "pickingType": { "type": "string", "description": "Art der Kommissionierung", "enum": [ "FAST_ORDER_PICKING", "SINGLE_ORDER_PICKING", "COLLECTIVE_ORDER_PICKING", "ROLLING_ORDER_PICKING", "CONSOLIDATION", "REPLENISHMENT" ] }, "processingType": { "type": "string", "description": "Art der Picklisten-Verarbeitung", "enum": [ "PICKING", "PACKING" ] }, "useDigitalPicklist": { "type": "boolean", "description": "Digitale Pickliste verwenden: wenn processingType = PICKING -> Positionen nur durch tippen oder swippen best\u00e4tigt", "default": false }, "usePickNPack": { "type": "boolean", "description": "Pick'n'Pack verwenden: wenn processingType = PICKING", "default": false }, "hideTargetQuantityInViews": { "type": "boolean", "description": "Zielmengen in Masken verstecken: nur sinnvoll bei useDigitalPicklist = false oder processingType = PACKING", "default": false }, "allowFullConfirmation": { "type": "boolean", "description": "Sammelbest\u00e4tigung erlauben: wenn processingType = PACKING, dann Button zur Sammelbest\u00e4tigung einblenden", "default": false }, "assemblyGroupAtOnce": { "type": "boolean", "description": "Baugruppen als Ganzes erfassen", "default": false } }, "description": "Pickliste ohne Details" }, "core-api-QueryPageableApi": { "type": "object", "properties": { "sort": { "type": "string", "description": "Liste an Feldern zur Sortierung (komma-getrennt)" }, "_start": { "type": "integer", "description": "Start-Offset", "format": "int32" }, "_limit": { "type": "integer", "description": "Ergebnis-Limit", "format": "int32" }, "_order": { "type": "string", "description": "Sortierart der Felder (asc/desc, Liste, komma-getrennt)" } }, "description": "Paging" }, "erp-stock-Range": { "type": "object", "properties": { "from": { "type": "number" }, "to": { "type": "number" } }, "description": "Selektionsbereich von/bis" }, "erp-stock-StorageBinSelectionApi": { "type": "object", "properties": { "pageable": { "$ref": "#/components/schemas/core-api-QueryPageableApi" }, "storageId": { "type": "integer", "description": "Lager zu dem ein Lagerplatz geh\u00f6rt", "format": "int64" }, "storageAreaId": { "type": "integer", "description": "Lagerbereich zu dem ein Lagerplatz geh\u00f6rt", "format": "int64" }, "onlyWithoutStorageArea": { "type": "boolean", "description": "Nur Lagerpl\u00e4tze ohne Lagerbereich", "default": false }, "defaultBin": { "type": "boolean", "description": "Standard-Lagerplatz eines Lagers (nur relevant f\u00fcr Lager ohne Lagerpl\u00e4tze", "default": false }, "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", "description": "Normaler Regalplatz?", "default": false }, "forIncomingGoods": { "type": "boolean", "description": "F\u00fcr Wareneingang?", "default": false }, "palletSpace": { "type": "boolean", "description": "F\u00fcr Paletten/Nachschubmengen?", "default": false }, "clarifySpace": { "type": "boolean", "description": "Zur Kl\u00e4rung?", "default": false }, "forReturnedGoods": { "type": "boolean", "description": "F\u00fcr Retouren?", "default": false }, "useInAvailabilityDetermination": { "type": "boolean", "description": "Soll der Lagerplatz in der Ermittlung der verf\u00fcgbaren Mengen beachtet werden?", "default": false }, "state": { "type": "string", "description": "Status eines Lagerplatzes", "enum": [ "ACTIVE", "INACTIVE", "SUSPENDED", "BLOCKED_FOR_INVENTORY" ] }, "maxAllowedWeight": { "$ref": "#/components/schemas/erp-stock-Range" }, "heightInCM": { "$ref": "#/components/schemas/erp-stock-Range" }, "widthInCM": { "$ref": "#/components/schemas/erp-stock-Range" }, "depthInCM": { "$ref": "#/components/schemas/erp-stock-Range" } }, "description": "Selektionskriterien zur Ermittlung von Lagerpl\u00e4tzen" }, "erp-wms-InventoryProcessingRequest": { "type": "object", "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "inventoryId": { "type": "integer", "description": "ID der aktuellen Inventur", "format": "int64" }, "areaToCount": { "type": "string", "description": "Aktueller Inventurz\u00e4hlbereich" }, "processedCountingIds": { "type": "array", "description": "IDs der aktuell erfasstem Z\u00e4hllisten-Positionen zu einer Inventur", "items": { "type": "integer", "description": "IDs der aktuell erfasstem Z\u00e4hllisten-Positionen zu einer Inventur", "format": "int64" } }, "lastProcessedCountingId": { "type": "integer", "description": "ID der letzten verarbeiteten Position einer Z\u00e4hlliste zur Inventur", "format": "int64" }, "storageBinId": { "type": "integer", "description": "ID vom aktueller Lagerplatz", "format": "int64" }, "articleId": { "type": "integer", "description": "ID vom aktuellen Artikel", "format": "int64" }, "serialNumberId": { "type": "integer", "description": "ID der aktuellen Seriennummer/Charge", "format": "int64" }, "manualQuantityChange": { "type": "number", "description": "Manuelle Mengen\u00e4nderung" }, "absoluteManualQuantityChange": { "type": "boolean" } } }, "erp-wms-InventoryProcessingResponse": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "inventory": { "$ref": "#/components/schemas/erp-wms-Inventory" }, "areaToCount": { "type": "string", "description": "Zu z\u00e4hlender Inventurz\u00e4hlbereich" }, "inventoryCountings": { "type": "array", "description": "Aktuell erfasste Z\u00e4hllisten-Positionen zu einer Inventur", "items": { "$ref": "#/components/schemas/erp-wms-InventoryCounting" } }, "lastProcessedCountingId": { "type": "integer", "description": "ID der letzten verarbeitete Position der Z\u00e4hlliste", "format": "int64" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "storageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" } } }, "node-event-WebsocketToken": { "type": "object", "properties": { "userId": { "type": "integer", "description": "USER ID", "format": "int64" }, "tokenKey": { "type": "string", "description": "Token Key" }, "token": { "type": "string", "description": "Token" } } }, "erp-stock-LevelRange": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "description": "Bereich f\u00fcr eine Ebene" }, "erp-stock-StorageBinGenerateRequest": { "required": [ "numOfLevels" ], "type": "object", "properties": { "storageId": { "type": "integer", "description": "ID des Lagers, f\u00fcr das die Lagerpl\u00e4tze generiert werden sollen", "format": "int64" }, "storageAreaId": { "type": "integer", "description": "Lagerbereich, zu dem dieser Lagerplatz geh\u00f6rt", "format": "int64" }, "numOfLevels": { "maximum": 6, "minimum": 1, "type": "integer", "description": "Anzahl der Ebenen", "format": "int32" }, "rangeLevel1": { "$ref": "#/components/schemas/erp-stock-LevelRange" }, "rangeLevel2": { "$ref": "#/components/schemas/erp-stock-LevelRange" }, "rangeLevel3": { "$ref": "#/components/schemas/erp-stock-LevelRange" }, "rangeLevel4": { "$ref": "#/components/schemas/erp-stock-LevelRange" }, "rangeLevel5": { "$ref": "#/components/schemas/erp-stock-LevelRange" }, "rangeLevel6": { "$ref": "#/components/schemas/erp-stock-LevelRange" }, "generateUniqueIdentifier": { "type": "boolean", "description": "Sollen eindeutige Identifier f\u00fcr die Lagerpl\u00e4tze generiert werden", "default": false }, "startOfRoutePosition": { "type": "integer", "description": "Start der Laufwegposition f\u00fcr diese generierten Lagerpl\u00e4tze", "format": "int32" }, "shelfSpace": { "type": "boolean", "description": "Normaler Regalplatz?", "default": false }, "forIncomingGoods": { "type": "boolean", "description": "F\u00fcr Wareneingang?", "default": false }, "palletSpace": { "type": "boolean", "description": "F\u00fcr Paletten/Nachschubmengen?", "default": false }, "clarifySpace": { "type": "boolean", "description": "Zur Kl\u00e4rung?", "default": false }, "forReturnedGoods": { "type": "boolean", "description": "F\u00fcr Retouren?", "default": false }, "useInAvailabilityDetermination": { "type": "boolean", "description": "Soll der Lagerplatz in der Ermittlung der verf\u00fcgbaren Mengen beachtet werden?", "default": false }, "maxAllowedWeight": { "type": "number", "description": "Maximal zul\u00e4ssiges Gewicht" }, "heightInCM": { "type": "number", "description": "H\u00f6he in CM" }, "widthInCM": { "type": "number", "description": "Breite in CM" }, "depthInCM": { "type": "number", "description": "Tiefe in CM" }, "color": { "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string", "description": "Farbe zur Anzeige" }, "separator": { "pattern": "^[-/_\\\\| ]+$", "type": "string", "description": "Trenner" } }, "description": "Infos zur Generierung von Lagerpl\u00e4tzen" }, "erp-stock-StockTransferApi": { "required": [ "articleId", "quantity", "sourceStorageId", "targetStorageId" ], "type": "object", "properties": { "articleId": { "type": "integer", "description": "Artikel", "format": "int64" }, "serialNumberId": { "type": "integer", "description": "Seriennummer", "format": "int64" }, "bookDate": { "type": "string", "description": "Buchungsdatum", "format": "date" }, "quantity": { "type": "number", "description": "Menge" }, "note": { "type": "string", "description": "Bemerkung" }, "sourceStorageId": { "type": "integer", "description": "Quell-Lager", "format": "int64" }, "sourceStorageBinId": { "type": "integer", "description": "Quell-Lagerplatz", "format": "int64" }, "targetStorageId": { "type": "integer", "description": "Ziel-Lager", "format": "int64" }, "targetStorageBinId": { "type": "integer", "description": "Ziel-Lagerplatz", "format": "int64" }, "picklistLineComponentId": { "type": "integer", "description": "Komponente einer Picklistenposition, falls daf\u00fcr die Buchung stattfindet", "format": "int64" } }, "description": "Infos zur Durchf\u00fchrung einer Lagerumbuchung" }, "erp-stock-StockTransferResult": { "type": "object", "properties": { "article": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumber": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "sourceStorageBin": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "sourceStorage": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "sourceOldStock": { "type": "number", "description": "Alter Bestand Quellagerplatz" }, "sourceNewStock": { "type": "number", "description": "Neuer Bestand Quellagerplatz" }, "targetStorageBin": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetStorage": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetOldStock": { "type": "number", "description": "Alter Bestand Ziellagerplatz" }, "targetNewStock": { "type": "number", "description": "Neuer Bestand Ziellagerplatz" } } }, "erp-stock-StockMovementManualApi": { "required": [ "articleId", "factor", "quantity", "storageId" ], "type": "object", "properties": { "factor": { "type": "string", "description": "Zugang oder Abgang", "enum": [ "NONE", "INCREMENT", "DECREMENT" ] }, "articleId": { "type": "string", "description": "Artikel" }, "quantity": { "type": "number", "description": "Menge" }, "note": { "type": "string", "description": "Bemerkung" }, "storageId": { "type": "string", "description": "Lager" }, "storageBinId": { "type": "string", "description": "Lagerplatz" }, "storageLocation": { "type": "string", "description": "Lagerort (spielt nur bei Zug\u00e4ngen eine Rolle)" }, "purchasePrice": { "type": "number", "description": "EK (spielt nur bei Zug\u00e4ngen eine Rolle)" }, "serialNumber1": { "type": "string", "description": "Seriennummer 1, welche gebucht werden soll" }, "serialNumber2": { "type": "string", "description": "Seriennummer 2, welche gebucht werden soll" }, "expiryDate": { "type": "string", "description": "Haltbarkeitsdatum", "format": "date" }, "serialNumberNote": { "type": "string", "description": "Notiz zur Seriennummer" } }, "description": "Infos zur Durchf\u00fchrung einer manuellen Lagerbuchung" }, "erp-stock-BulkTransferRequestApi": { "type": "object", "properties": { "createReportAfterTransfer": { "type": "boolean", "description": "Soll nach der Umbuchung ein Report dazu erstellt werden?" }, "stockTransfers": { "type": "array", "description": "Enth\u00e4lt die Anweisungen f\u00fcr die Umbuchungen", "items": { "$ref": "#/components/schemas/erp-stock-StockTransferApi" } } }, "description": "Infos zur Durchf\u00fchrung einer Stapel-Lagerumbuchung" }, "erp-stock-BulkTransferResult": { "type": "object", "properties": { "reportId": { "type": "integer", "description": "Falls der Report im Request angefordert wurde, wird hier die ID aus dem DMS geliefert", "format": "int64" }, "stocks": { "type": "array", "description": "Die durch die Lagerbuchung ge\u00e4nderten Lagerplatz-Best\u00e4nde", "items": { "$ref": "#/components/schemas/erp-stock-StockTransferResult" } }, "date": { "type": "string", "description": "Das Buchungsdatum", "format": "date" } }, "description": "Infos zur Durchf\u00fchrung einer Stapel-Lagerumbuchung" }, "erp-statistic-DataSeriesRequest": { "type": "object", "properties": { "additionalPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "step": { "type": "string", "description": "defines the time-grouping for a query result", "enum": [ "YEAR", "QUARTER", "MONTH", "WEEK", "DAY" ] }, "fillEmptyGroups": { "type": "boolean", "description": "sollen Zeiteinheiten ohne Datenwerte mit zur\u00fcckgeliefert werden?", "default": false }, "slice": { "type": "string", "description": "defines the time-slice for a query", "enum": [ "CURRENT_YEAR", "CURRENT_AND_LAST_YEAR", "CURRENT_AND_LAST_TWO_YEARS", "CURRENT_AND_LAST_MONTH", "CURRENT_AND_LAST_WEEK", "LAST_TWELVE_MONTHS", "LAST_SEVEN_DAYS", "TODAY", "UNBOUND" ] } } }, "erp-statistic-DataSeries": { "type": "object", "properties": { "seriesLabel": { "type": "string", "description": "Label of the data series" }, "seriesType": { "type": "string", "description": "Type of the data series" }, "seriesEntryType": { "type": "string", "description": "Type of data series value " }, "seriesGroupHeader": { "type": "array", "description": "the Header for grouping operation (normally the year)", "items": { "type": "string", "description": "the Header for grouping operation (normally the year)" } }, "series": { "type": "array", "description": "List of series entries", "items": { "$ref": "#/components/schemas/erp-statistic-DataSeriesEntry" } } } }, "erp-statistic-DataSeriesEntry": { "type": "object", "properties": { "entryLabel": { "type": "integer", "description": "the position of this Entry with respect to the given TimeSeriesGrouping ", "format": "int64" }, "value": { "type": "array", "description": "value of this entry", "items": { "type": "object", "description": "value of this entry" } } }, "description": "List of series entries" }, "erp-product-ArticleCopyEntry": { "required": [ "newNumber" ], "type": "object", "properties": { "originalArticleId": { "type": "string", "description": "ID of original article" }, "newNumber": { "type": "string", "description": "new number for the copy" } }, "description": "Mapping of Articles to be copied" }, "erp-product-ProductCopyCommand": { "required": [ "copyEntries" ], "type": "object", "properties": { "modules": { "uniqueItems": true, "type": "array", "description": "Relations to be copied", "items": { "type": "string", "description": "Relations to be copied", "enum": [ "CUSTOM", "CUSTOMERS", "MEDIA", "SUPPLIERS", "TEXTS", "PRICES" ] } }, "copyEntries": { "uniqueItems": true, "type": "array", "description": "Mapping of Articles to be copied", "items": { "$ref": "#/components/schemas/erp-product-ArticleCopyEntry" } } } }, "erp-product-ProductVariantCreationRequest": { "type": "object", "properties": { "mainArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "combinations": { "type": "array", "description": "combinations of values", "items": { "type": "array", "description": "combinations of values", "items": { "type": "integer", "description": "combinations of values", "format": "int64" } } }, "blackListedCombinations": { "type": "array", "description": "blacklisted combinations of values", "items": { "type": "array", "description": "blacklisted combinations of values", "items": { "type": "integer", "description": "blacklisted combinations of values", "format": "int64" } } }, "productType": { "type": "string", "description": "Artikelarten", "enum": [ "WITH_STOCK", "WITHOUT_STOCK", "SERVICE_ARTICLE", "SERVICE_CONTINGENT", "ASSEMBLY_GROUP", "JUMBO", "SHIPPING_COSTS", "VARIANT_MAIN_ARTICLE" ] } }, "description": "Request zur Erstellung von Product Varianten" }, "erp-payment-DunningPayment": { "type": "object", "properties": { "dunningAmount": { "type": "number", "description": "Wieviel wird auf die Mahnung gezahlt" }, "dunningRecordId": { "type": "integer", "description": "Welche Mahnung wird damit bezahlt", "format": "int64" } }, "description": "Alle Mahnzahlungen" }, "erp-payment-Payment": { "required": [ "paymentAmount", "paymentDate", "paymentMethodId" ], "type": "object", "properties": { "paymentDate": { "type": "string", "description": "der zahlungstag", "format": "date" }, "openItemReceiptId": { "type": "string", "description": "Beleg des OPs (optional)" }, "openItemId": { "type": "string", "description": "der OP" }, "paymentAmount": { "type": "number", "description": "der zahlungsbetrag" }, "discountAmount": { "type": "number", "description": "gew\u00e4hrte/einbehaltene skonti" }, "companyBankAccountId": { "type": "string", "description": "welche Bank des Company-Accounts war beteiligt" }, "paymentMethodId": { "type": "string", "description": "die Zahlungsmethode" }, "direction": { "type": "string", "description": "Ein/Auszahlung" }, "depositPayment": { "type": "boolean", "description": "Ist diese Zahlung f\u00fcr die Anzahlung/Vorkasse gedacht", "default": false }, "dunningPayments": { "type": "array", "description": "Alle Mahnzahlungen", "items": { "$ref": "#/components/schemas/erp-payment-DunningPayment" } } }, "description": "beschreibt eine geleistete Zahlung. eins von openItemReceiptId oder openItemId muss gef\u00fcllt sein" }, "erp-finance-ManualPaymentResponse": { "type": "object", "properties": { "message": { "type": "array", "description": "Problems with the manual payment", "readOnly": true, "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } } } }, "erp-finance-PaymentRevertRequest": { "required": [ "openItemRecordId" ], "type": "object", "properties": { "openItemRecordId": { "type": "integer", "description": "ID des Records, der storniert werden soll", "format": "int64" }, "comment": { "type": "string", "description": "Kommentar zur Stornierung", "nullable": true } } }, "erp-stock-OrderProposalGenerateRequest": { "required": [ "needsAssessmentPreference", "supplierPreference" ], "type": "object", "properties": { "purchaseStorageIds": { "type": "array", "description": "IDs der Bestell-Lager, f\u00fcr das der Bestellvorschlag generiert werden sollen (leer=\u00fcber alle Bestell-Lager)", "items": { "type": "integer", "description": "IDs der Bestell-Lager, f\u00fcr das der Bestellvorschlag generiert werden sollen (leer=\u00fcber alle Bestell-Lager)", "format": "int64" } }, "supplierPreference": { "type": "string", "description": "Lieferanten-Pr\u00e4ferenz", "enum": [ "CHEAPEST", "FASTEST", "SPECIFIC_SUPPLIER", "MAIN_SUPPLIER" ] }, "needsAssessmentPreference": { "type": "string", "description": "Art der Bedarfsermittlung", "enum": [ "MINIMUM_TARGET_STOCK", "SALES" ] }, "recognizeReservations": { "type": "boolean", "description": "Reservierungen beachten f\u00fcr zu bestellende Menge", "default": false }, "recognizeOrders": { "type": "boolean", "description": "Bestellungen beachten f\u00fcr zu bestellende Menge", "default": false }, "recognizeStock": { "type": "boolean", "description": "Lagerbestand beachten f\u00fcr zu bestellende Menge", "default": false }, "numberOfDaysToOrderFor": { "type": "integer", "description": "Anzahl Tage f\u00fcr die bestellt werden soll (bei Bedarfsermittlung \u00fcber Abg\u00e4nge)", "format": "int32" }, "givenSupplierAccountId": { "type": "integer", "description": "ID des Vorgabe-Lieferanten-Accounts", "format": "int64" } }, "description": "Infos zur Erzeugung eines Bestellvorschlags" }, "erp-finance-OpenItemMatchingRequest": { "type": "object", "properties": { "openItemMatchingRules": { "type": "array", "description": "Passende Regeln", "items": { "$ref": "#/components/schemas/erp-finance-OpenItemMatchingRule" } }, "bankId": { "type": "integer", "description": "Bank f\u00fcr den Abgleich", "format": "int64" }, "bankAccountId": { "type": "integer", "description": "Bankkonto f\u00fcr den Abgleich nach Import der Banktransaktionen pro Bankkonto", "format": "int64" }, "loggingLevels": { "type": "array", "description": "Logging Level", "items": { "type": "string", "description": "Logging Level", "enum": [ "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ] } } } }, "erp-finance-SyncMarkRequest": { "type": "object", "properties": { "bankAccountId": { "type": "integer", "description": "Id des BankAccounts, zu dem die Transaktionen verarbeitet werden", "format": "int64" }, "minimumPoints": { "type": "integer", "description": "Wieviele Punkte sind unser unteres Limit f\u00fcrs Vormerken der Buchung", "format": "int32" } } }, "erp-finance-TransactionFinalizationPointsRequest": { "type": "object", "properties": { "accountId": { "type": "integer", "description": "ID eines Accounts", "format": "int64" }, "points": { "type": "integer", "description": "Die Punkte, ab denen verbucht werden soll", "format": "int32" } } }, "erp-finance-OpenItemTransactionDistribution": { "type": "object", "properties": { "openItemTransactionDistributionData": { "type": "array", "description": "Transaktionsverteilungsdaten", "items": { "$ref": "#/components/schemas/erp-finance-OpenItemTransactionDistributionData" } }, "transactionId": { "type": "integer", "description": "transaction Id", "format": "int64" }, "forceComplete": { "type": "boolean", "description": "erzwungener Abschluss" } }, "description": "matches" }, "erp-finance-OpenItemTransactionDistributionData": { "type": "object", "properties": { "openItemId": { "type": "integer", "description": "item Id", "format": "int64" }, "reasoning": { "type": "string", "description": "Argumentation" } }, "description": "Transaktionsverteilungsdaten" }, "erp-finance-OpenItemTransactionFinalizationRequest": { "type": "object", "properties": { "matches": { "type": "array", "description": "matches", "items": { "$ref": "#/components/schemas/erp-finance-OpenItemTransactionDistribution" } } } }, "erp-finance-OpenItemTransactionReassignRequest": { "type": "object", "properties": { "targetOpenItemId": { "type": "integer", "description": "neuer OP dem die Transaction zugewiesen werden soll", "format": "int64" } } }, "erp-finance-ClearingResponse": { "type": "object", "properties": { "firstOpenItemId": { "type": "integer", "description": "ID des ersten OPs", "format": "int64" }, "secondOpenItemId": { "type": "integer", "description": "ID des zweiten OPs", "format": "int64" }, "clearedAmount": { "type": "number", "description": "Verrechneter Betrag" } } }, "erp-finance-OpenItemRecalculateRequest": { "type": "object", "properties": { "grantDeliveryApproval": { "type": "boolean", "description": "Lieferfreigabe erteilen", "nullable": true }, "newBalance": { "type": "number", "description": "neuer Saldo", "nullable": true } } }, "erp-finance-OpenItemPlanRunRequest": { "required": [ "dueDate" ], "type": "object", "properties": { "dueDate": { "type": "string", "description": "F\u00e4lligkeit der n\u00e4chsten Buchung", "format": "date" }, "accountIds": { "type": "array", "description": "Einschr\u00e4nkung auf spezielle Adressen?", "items": { "type": "integer", "description": "Einschr\u00e4nkung auf spezielle Adressen?", "format": "int64" } }, "startDate": { "type": "string", "description": "Starttag des Zahlungsplanes - bis", "format": "date" }, "endDate": { "type": "string", "description": "Endtag des Zahlungsplanes - bis", "format": "date" } } }, "erp-finance-PaymentCreationRequest": { "type": "object", "properties": { "paymentDetails": { "type": "array", "description": "Detailangaben f\u00fcr die Zahlung", "items": { "$ref": "#/components/schemas/erp-finance-PaymentCreationRequestDetail" } }, "paymentTemplateId": { "type": "integer", "description": "Zahlungsvorlage", "format": "int64" } } }, "erp-finance-PaymentCreationRequestDetail": { "type": "object", "properties": { "openItemId": { "type": "integer", "description": "Die ID des offenen Postens, zu dem ein Zahlungsauftrag angelegt werden soll", "format": "int64" }, "totalAmount": { "type": "number", "description": "Der Betrag, der gezahlt werden soll" }, "discountPercent": { "type": "number", "description": "Skontosatz" }, "discountAmount": { "type": "number", "description": "Skontobetrag" }, "purpose": { "type": "string", "description": "Verwendungszweck" } }, "description": "Detailangaben f\u00fcr die Zahlung" }, "erp-finance-PaymentCreationResponse": { "type": "object", "properties": { "openItemCount": { "type": "integer", "description": "Anzahl der Offenen Posten", "format": "int32" }, "totalAmount": { "type": "number", "description": "Gesamtbetrag der Offenen Posten" }, "responseDetails": { "type": "array", "description": "Erzeugte Zahlungen", "items": { "$ref": "#/components/schemas/erp-finance-PaymentCreationResponseDetail" } } } }, "erp-finance-PaymentCreationResponseDetail": { "type": "object", "properties": { "payment": { "$ref": "#/components/schemas/erp-bank-BankPayment" }, "messages": { "type": "array", "description": "Meldungen", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } } }, "description": "Erzeugte Zahlungen" }, "erp-finance-PaymentRunRequest": { "type": "object", "properties": { "toDate": { "type": "string", "description": "bis F\u00e4lligkeitsdatum", "format": "date" }, "incoming": { "type": "boolean", "description": "Einzug oder \u00dcberweisung" }, "bankAccountId": { "type": "integer", "description": "Bankkonto f\u00fcr Zahlung", "format": "int64" }, "templateId": { "type": "integer", "description": "ID der zu verwendenden Textvorlage", "format": "int64" } } }, "erp-finance-TransactionToOpenItemRequest": { "type": "object", "properties": { "transactionId": { "type": "integer", "description": "Die ID eines Bankumsatzes", "format": "int64" }, "accountId": { "type": "integer", "description": "Die ID eines Accounts, der einen neuen OP bekommen soll", "format": "int64" }, "paymentMethodId": { "type": "integer", "description": "Die ID einer Zahlungsmethode, die im OP vermerkt werden soll", "format": "int64" } } }, "erp-finance-OpenItemReopenRequest": { "type": "object", "properties": { "comment": { "type": "string", "description": "Kommentar zur Wieder\u00f6ffnung", "nullable": true }, "businessTransactionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-finance-OpenItemCloseRequest": { "type": "object", "properties": { "reimbursePayments": { "type": "boolean", "description": "bisherige Zahlungen zur\u00fcckerstatten" }, "comment": { "type": "string", "description": "Kommentar zur Schliessung", "nullable": true }, "closeableAmount": { "type": "number", "description": "Betrag zur Schliessung", "nullable": true }, "businessTransactionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "grantDeliveryApproval": { "type": "boolean", "description": "Lieferfreigabe erteilen", "nullable": true } } }, "erp-finance-OpenItemCloseableAmounts": { "type": "object", "properties": { "reimbursableAmount": { "type": "number", "description": "zur\u00fcckzuerstattender Betrag" }, "cancellationDunningAmount": { "type": "number", "description": "zur\u00fcckzubuchende Mahnbetr\u00e4ge" }, "closeableAmount": { "type": "number", "description": "abzuschliessender Betrag" } } }, "erp-finance-DunningRunRequest": { "type": "object", "properties": { "dunningLevel": { "type": "integer", "description": "Spezifische Mahnstufe f\u00fcr den Mahnlauf", "format": "int32" }, "customerNumberFrom": { "type": "string", "description": "Kunden-Nummer von" }, "customerNumberTo": { "type": "string", "description": "Kunden-Nummer bis" }, "responsibleUserId": { "type": "integer", "description": "Zust\u00e4ndiger Benutzer", "format": "int64" }, "paymentDueDate": { "type": "string", "description": "F\u00e4lligkeitsdatum", "format": "date" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customerGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-document-DocumentTypeTransitionRequest": { "required": [ "transitionId" ], "type": "object", "properties": { "transitionId": { "type": "string", "description": "transition id" }, "targetTypeId": { "type": "integer", "description": "Ggf. die ID der Ziel-Belegart", "format": "int64" }, "parameters": { "type": "array", "description": "additional parameters for transition", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } }, "document": { "$ref": "#/components/schemas/erp-document-RequestDocument" } } }, "erp-account-TaxIDProtocol": { "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Gepr\u00fcfte Ust-ID" }, "validity": { "type": "string", "description": "G\u00fcltigkeit einer Ust-ID", "enum": [ "NOT_YET_VALIDATED", "VALID", "VALID_WITH_INVALID_ADDRESS", "NOT_VALID" ] }, "validatedCompanyName": { "type": "string", "description": "Gepr\u00fcfter Firmenname" }, "companyNameValidationResult": { "type": "string", "description": "Ergebnis der Detail-Pr\u00fcfung einer Ust-ID", "enum": [ "VALID", "NOT_VALID", "NOT_REQUESTED", "NOT_DELIVERED", "UNKNOWN" ] }, "validatedCity": { "type": "string", "description": "Gepr\u00fcfter Ort" }, "cityValidationResult": { "type": "string", "description": "Ergebnis der Detail-Pr\u00fcfung einer Ust-ID", "enum": [ "VALID", "NOT_VALID", "NOT_REQUESTED", "NOT_DELIVERED", "UNKNOWN" ] }, "validatedPostalCode": { "type": "string", "description": "Gepr\u00fcfte PLZ" }, "postalCodeValidationResult": { "type": "string", "description": "Ergebnis der Detail-Pr\u00fcfung einer Ust-ID", "enum": [ "VALID", "NOT_VALID", "NOT_REQUESTED", "NOT_DELIVERED", "UNKNOWN" ] }, "validatedStreet": { "type": "string", "description": "Gepr\u00fcfte Stra\u00dfe" }, "streetValidationResult": { "type": "string", "description": "Ergebnis der Detail-Pr\u00fcfung einer Ust-ID", "enum": [ "VALID", "NOT_VALID", "NOT_REQUESTED", "NOT_DELIVERED", "UNKNOWN" ] }, "usedApi": { "type": "string", "description": "USt-ID Pr\u00fcfverfahren", "enum": [ "NONE", "BZST", "VIES" ] }, "apiResultCode": { "type": "string", "description": "Ergebnis-Code der Pr\u00fcfung" }, "apiResultMessage": { "type": "string", "description": "Ergebnis-Meldung der Pr\u00fcfung (falls vorhanden" } } }, "erp-spi-CreateShipmentResponse": { "type": "object", "properties": { "shipmentId": { "type": "integer", "description": "description/delivery Text of this order (internal vds description)", "format": "int64" } } }, "erp-document-ContractEvaluationJobRequest": { "type": "object", "properties": { "blackList": { "type": "array", "description": "Ignore ID-List", "items": { "type": "integer", "description": "Ignore ID-List", "format": "int64" } }, "whiteList": { "type": "array", "description": "Use ID-List", "items": { "type": "integer", "description": "Use ID-List", "format": "int64" } }, "variableSubstitutionList": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "documentDate": { "type": "string", "description": "Abweichendes Belegdatum", "format": "date" }, "deliveryDate": { "type": "string", "description": "Abweichendes Lieferdatum", "format": "date" }, "addBillingPeriod": { "type": "boolean", "description": "Abrechnungszeitraum hinzuf\u00fcgen?", "default": true }, "note": { "type": "string", "description": "Notiz" }, "print": { "type": "boolean", "description": "Drucken?", "default": false } }, "description": "Request zur Erstellung des Jobs f\u00fcr Abrechnungen der Vertr\u00e4ge" }, "einvoice-unknownmodule-ValidationEmbeddingDetails": { "type": "object", "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" } } } }, "einvoice-unknownmodule-ValidationPdfDetails": { "type": "object", "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-ValidationResponse": { "type": "object", "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": { "type": "object", "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": { "type": "object", "properties": { "value": { "type": "boolean" }, "profile": { "type": "integer", "format": "int32" } } }, "erp-document-DocumentMultipleLinesRequest": { "type": "object", "properties": { "documentLines": { "type": "array", "description": "Die neuen Belegpositionen", "items": { "$ref": "#/components/schemas/erp-document-DocumentLine" } }, "additionalParameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter und Benutzerentscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-document-DocumentMultipleSourceLinesRequest": { "type": "object", "properties": { "variables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "sourceLineIdsToIgnore": { "type": "array", "description": "IDs von DocumentLines, die ignoriert werden sollen", "items": { "type": "integer", "description": "IDs von DocumentLines, die ignoriert werden sollen", "format": "int64" } }, "sourceLineIdsToAdd": { "type": "array", "description": "IDs von DocumentLines, die als Quelle dem Dokument hinzugef\u00fcgt werden sollen", "items": { "type": "integer", "description": "IDs von DocumentLines, die als Quelle dem Dokument hinzugef\u00fcgt werden sollen", "format": "int64" } } }, "description": "Request zum Hinzuf\u00fcgen von mehreren Quell-Positionen zu einem Dokument" }, "erp-document-SalesCollectiveInvoiceRequest": { "required": [ "accountId", "deliveryDocumentIds" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "Account Id" }, "deliveryDocumentIds": { "type": "string", "description": "Liste der Lieferschein-Ids f\u00fcr die Sammelrechnung" } } }, "erp-crm-CrmDealVisibilityUpdateRequest": { "required": [ "dealUserId", "readPermittedUserIds" ], "type": "object", "properties": { "dealUserId": { "type": "integer", "description": "ID vom User, zu dem die lese-berechtigten Benutzer aktualisert werden sollen", "format": "int64" }, "readPermittedUserIds": { "type": "array", "description": "Die IDs der lese-berechtigten Benutzer", "items": { "type": "integer", "description": "Die IDs der lese-berechtigten Benutzer", "format": "int64" } } }, "description": "Request zur Aktualisierung von Sichtbarkeiten zu Deals" }, "erp-crm-CrmActivityPerformBillingRequest": { "type": "object", "properties": { "variables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "crmActivityIdsToIgnore": { "type": "array", "description": "IDs von Aktivit\u00e4ten, die nicht abgerechnet werden sollen", "items": { "type": "integer", "description": "IDs von Aktivit\u00e4ten, die nicht abgerechnet werden sollen", "format": "int64" } }, "crmActivityIdsToBill": { "type": "array", "description": "IDs von Aktivit\u00e4ten, die abgerechnet werden sollen", "items": { "type": "integer", "description": "IDs von Aktivit\u00e4ten, die abgerechnet werden sollen", "format": "int64" } } }, "description": "Request zur Durchf\u00fchrung der Abrechnung von Aktivit\u00e4ten" }, "erp-crm-CreateActivityByEmailRequest": { "type": "object", "properties": { "crmId": { "type": "integer", "description": "ID vom CRM-Objekt", "format": "int64" }, "crmType": { "type": "string", "description": "M\u00f6glich CRM-Typen", "enum": [ "TASK", "DEAL", "PROJECT" ] }, "accountId": { "type": "integer", "description": "ID vom Account", "format": "int64" }, "emailsAsProcessing": { "type": "boolean", "description": "Soll die Aktivit\u00e4t als \"E-Mail-Bearbeitung\" angelegt werden?", "default": false } }, "description": "Request zum Anlegen einer Aktivit\u00e4t E-Mail" }, "erp-commission-CommissionExportFile": { "type": "object", "properties": { "shelfDocumentId": { "type": "integer", "description": "Shelf Document ID", "format": "int64" }, "description": { "type": "string", "description": "Beschreibung" } }, "description": "export files" }, "erp-commission-CommissionRun": { "type": "object", "properties": { "version": { "type": "string", "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": { "maxLength": 255, "minLength": 0, "type": "string", "description": "number of commission run" }, "runState": { "type": "string", "description": "Verarbeitungsstatus Provisionslauf", "readOnly": true, "enum": [ "OPEN", "COMMITTED", "REVERTED" ] }, "salesAgents": { "type": "array", "description": "sales agents", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-commission-CommissionRunSalesAgent" } }, "runDate": { "type": "string", "description": "run date", "format": "date", "readOnly": true }, "dateFrom": { "type": "string", "description": "date from", "format": "date", "readOnly": true }, "dateTo": { "type": "string", "description": "date to", "format": "date", "readOnly": true }, "numberFrom": { "type": "string", "description": "SalesAgent number from", "readOnly": true }, "numberTo": { "type": "string", "description": "SalesAgent number to", "readOnly": true } } }, "erp-commission-CommissionRunFee": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Commission Date", "format": "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" } }, "description": "fees" }, "erp-commission-CommissionRunSalesAgent": { "type": "object", "properties": { "version": { "type": "string", "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", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-commission-CommissionRunFee" } }, "files": { "type": "array", "description": "export files", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-commission-CommissionExportFile" } }, "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" } }, "description": "sales agents" }, "erp-commission-CommissionRunRequest": { "type": "object", "properties": { "dateFrom": { "type": "string", "description": "date from", "format": "date" }, "dateTo": { "type": "string", "description": "date to", "format": "date" }, "runDate": { "type": "string", "description": "run date", "format": "date" }, "numberFrom": { "type": "string", "description": "SalesAgent number from" }, "numberTo": { "type": "string", "description": "SalesAgent number to" } } }, "erp-bank-BankConnectionUpdateRequest": { "type": "object", "properties": { "importNewAccounts": { "type": "boolean", "description": "Sollen neue Bankkonten importiert werden?", "default": false }, "manageSavedSettings": { "type": "string", "description": "Sollen die gespeicherten Einwilligungen bearbeitet werden?", "enum": [ "CREDENTIALS", "DEFAULT_TWO_STEP_PROCEDURE", "NONE" ], "default": "NONE" } } }, "erp-bank-ApiPayload": { "type": "object", "properties": { "bankConnectionId": { "type": "integer", "description": "bank connection ID", "format": "int64" }, "paymentId": { "type": "integer", "description": "payment Id", "format": "int64" }, "standingOrderId": { "type": "integer", "description": "standing order Id", "format": "int64" } }, "description": "api Payload" }, "erp-bank-ApiTaskInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "Die ID des externen Tasks" }, "createdAt": { "type": "string", "description": "Wann der Task angelegt wurde", "format": "date-time" }, "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-ApiWebform": { "type": "object", "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", "description": "time expires at", "format": "date-time" }, "createdAt": { "type": "string", "description": "time created At", "format": "date-time" }, "url": { "type": "string", "description": "web form Url" } }, "description": "Informationen \u00fcber ein Webform wenn eines angelegt wurde" }, "erp-bank-PaymentAssignment": { "type": "object", "properties": { "paymentId": { "type": "integer", "description": "Id der Sammellastschrift", "format": "int64" }, "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": { "type": "object", "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-bank-OpenItemDistribution": { "required": [ "distributionLines", "openItemId" ], "type": "object", "properties": { "openItemId": { "type": "integer", "description": "The ID of the open item to be matched with the transaction", "format": "int64" }, "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" } } } }, "erp-bank-OpenItemDistributionLine": { "required": [ "amount", "lineType" ], "type": "object", "properties": { "lineType": { "type": "string", "description": "Zeilentyp", "enum": [ "PAYMENT", "DUNNING", "FEE" ] }, "businessTransactionId": { "type": "integer", "description": "Id des Gesch\u00e4ftsvorfalls", "format": "int64" }, "amount": { "type": "number", "description": "der zu buchende (Mahn-)Betrag/die zu buchende Geb\u00fchr" }, "discountOrFeeAmount": { "type": "number", "description": "enthaltener Skonto oder Mahngeb\u00fchren" }, "comment": { "type": "string", "description": "Kommentar" }, "dunningRecordId": { "type": "integer", "description": "Id of the dunning record to pay towards", "format": "int64" } }, "description": "Betragszeilen" }, "erp-bank-ManualBookingResult": { "type": "object", "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", "description": "The ids of the manual bookings if successful", "format": "int64" } }, "irrelevantBookingId": { "type": "integer", "description": "The id of the irrelevancy marker booking if applicable", "format": "int64" } } }, "erp-finance-ManualFinanceBookingAccountDistribution": { "type": "object", "properties": { "ledgerNumber": { "type": "string", "description": "FiBu-Konto" }, "transactionKey": { "type": "string", "description": "Buchungsschl\u00fcssel" }, "costCenter1": { "type": "string", "description": "Kostenstelle" }, "documentField1": { "type": "string", "description": "Belegfeld 1" }, "distributionAmount": { "type": "number", "description": "Aufteilungsbetrag" } }, "description": "list booking account distributions" }, "erp-finance-ManualFinanceBookingRequest": { "required": [ "comment" ], "type": "object", "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" } } }, "erp-bank-BankTransactionComment": { "type": "object", "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" } } }, "erp-bank-BankPaymentAction": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the action" }, "type": { "type": "string", "description": "action type", "enum": [ "OPEN_URL" ] }, "expiration": { "type": "string", "description": "Expiration of the action", "format": "date-time" }, "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" } } }, "erp-bank-BankPaymentChangeAmountRequest": { "required": [ "bankPaymentId", "bankPaymentRecordId" ], "type": "object", "properties": { "bankPaymentId": { "type": "integer", "description": "Zahlung", "format": "int64" }, "bankPaymentRecordId": { "type": "integer", "description": "Zahlungssatz", "format": "int64" }, "amount": { "type": "number", "description": "ge\u00e4nderter Zahlbetrag" }, "comment": { "type": "string", "description": "Kommentar" } } }, "erp-bank-TransactionSyncRequest": { "required": [ "accountId" ], "type": "object", "properties": { "accountId": { "type": "integer", "description": "Id des Bankkontos", "format": "int64" }, "dateRelevant": { "type": "string", "description": "Datum, ab dem die Transaktionen gesch\u00e4ftsrelevant sind", "format": "date" }, "fromDate": { "type": "string", "description": "Startdatum f\u00fcr Transaktionsabgleich", "format": "date" }, "toDate": { "type": "string", "description": "Enddatum f\u00fcr Transaktionsabgleich", "format": "date" }, "syncAll": { "type": "boolean", "description": "Alle Transaktionen abrufen?", "default": true }, "async": { "type": "boolean", "description": "Synchronisation \u00fcber Job?", "default": false } } }, "erp-bank-TransactionSyncResponse": { "type": "object", "properties": { "transactions": { "type": "array", "description": "Liste der Transkationen bei synchroner Aktualisierung", "items": { "$ref": "#/components/schemas/erp-bank-BankTransaction" } }, "jobId": { "type": "string", "description": "Id des Jobs bei asynchroner Aktualisierung" } } }, "erp-product-CreateArticleRequestApi": { "required": [ "priceUnit" ], "type": "object", "properties": { "productRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "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", "DOUBLE_SERIAL_NUMBER" ] }, "createArticlesOrBundles": { "type": "boolean", "description": "Direkt Artikel/Gebinde anlegen", "default": false }, "bundle": { "type": "boolean", "description": "Nur wenn productRef leer ist: Handelt es sich um ein Gebinde?", "default": false }, "number": { "type": "string", "description": "Artikel-Nummer (nicht, wenn es ein Gebinde ist und ein Produkt angegeben ist" }, "name": { "type": "string", "description": "Bezeichnung" }, "unitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "productGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priceUnit": { "type": "number", "description": "Preiseinheit" }, "taxSchemaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priceBase": { "type": "string", "description": "Preisbasis", "enum": [ "NET_PRICE", "GROSS_PRICE" ] }, "bundleSchemaId": { "type": "integer", "description": "Vorlage zum Erstellen mehrerer Artikel", "format": "int64" }, "createTemplateId": { "type": "integer", "description": "Vorlage zum Erstellen eines Artikel", "format": "int64" }, "variantDefinitionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "values": { "type": "array", "description": "Produkt-Varianten Werte", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantValueReference" } } } }, "erp-stock-ArticleBundleMergeDissolveRequest": { "required": [ "processingStorageId", "sourceArticleOrBundleId", "sourceQuantityToProcess", "targetArticleOrBundleId" ], "type": "object", "properties": { "sourceArticleOrBundleId": { "type": "integer", "description": "ID vom Quell-Artikel/-Gebinde", "format": "int64" }, "targetArticleOrBundleId": { "type": "integer", "description": "ID vom Ziel-Artikel/-Gebinde", "format": "int64" }, "processingStorageId": { "type": "integer", "description": "ID vom Lager, in dem die Verarbeitung stattfinden soll", "format": "int64" }, "processingStorageBinId": { "type": "integer", "description": "(Optional, falls Lager mit Lagerpl\u00e4tzen) ID vom Lagerplatz, in dem die Verarbeitung stattfinden soll", "format": "int64" }, "sourceQuantityToProcess": { "type": "number", "description": "Zu verarbeitende Menge" } }, "description": "Request zum Zusammenf\u00fchren oder Aufl\u00f6sen von Gebinden" }, "erp-product-ArticlePrintLabelOrderRequest": { "type": "object", "properties": { "article": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "report": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumber": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "print": { "type": "boolean", "description": "Etikettendruck", "default": false }, "quantity": { "type": "integer", "description": "Menge", "format": "int32", "default": 1 } }, "description": "Anfrage Welche Artikel wie oft gedruckt werden soll" }, "dms-shelf-ShelfDocumentPostRequest": { "required": [ "shelfDocument" ], "type": "object", "properties": { "shelfDocument": { "$ref": "#/components/schemas/dms-shelf-ShelfDocument" }, "attributions": { "type": "array", "description": "Verweise auf andere Elemente, z.B. Account, Import-Vorgang, ...", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentAttribution" } }, "transformations": { "type": "array", "description": "Transformationen", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfImageTransformation" } } } }, "dms-shelf-TransferFileCreateRequest": { "required": [ "fileName" ], "type": "object", "properties": { "fileName": { "type": "string", "description": "filename (komplett) der zieldatei" } } }, "dms-shelf-TransferFileCreateResponse": { "type": "object", "properties": { "token": { "type": "string", "description": "token f\u00fcr den transfer file" } } }, "dms-shelf-TransferFilePartCreateResponse": { "type": "object", "properties": { "uploadUri": { "type": "string", "description": "upload-url for the real (tm) upload" } }, "description": "Response wenn ein UploadPart angelegt wird" }, "dms-shelf-TransferFileFinishRequest": { "required": [ "partCount" ], "type": "object", "properties": { "partCount": { "type": "integer", "description": "anzahl der Teile, die hochgeladen wurden", "format": "int64" }, "sha256Check": { "type": "string", "description": "sha256 checksumme des komplette files (optional)" } } }, "dms-shelf-DmsUploadLookup": { "required": [ "field", "value" ], "type": "object", "properties": { "field": { "type": "string", "description": "cUnit-Pfad" }, "value": { "type": "string", "description": "Vergleichswert" } }, "description": "Vergleiche, die verundet werden" }, "dms-shelf-DmsUploadWrapper": { "required": [ "lookUps", "resource" ], "type": "object", "properties": { "lookUps": { "type": "array", "description": "Vergleiche, die verundet werden", "items": { "$ref": "#/components/schemas/dms-shelf-DmsUploadLookup" } }, "resource": { "$ref": "#/components/schemas/dms-shelf-ShelfDocument" }, "purpose": { "type": "string" }, "uiSort": { "type": "integer", "format": "int32" } } }, "erp-finance-LedgerForSingleRecordRequest": { "type": "object", "properties": { "ledger": { "type": "string", "description": "neues Konto" }, "transactionKey": { "type": "string", "description": "neuer Buchungsschl\u00fcssel", "nullable": true }, "description": { "type": "string", "description": "Buchungstext" }, "costCenter1": { "type": "string", "description": "Kostenstelle 1" } } }, "erp-finance-FinanceBookingRecord": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "recordNumber": { "type": "integer", "description": "Eintragsnummer", "format": "int64" }, "recordType": { "type": "string", "description": "Soll/Haben-Kennzeichen", "enum": [ "DEBIT", "CREDIT" ] }, "ledger": { "type": "string", "description": "Konto" }, "transactionKey": { "type": "string", "description": "Buchungsschl\u00fcssel" }, "ledgerType": { "type": "string", "description": "Konto-Kennzeichen", "enum": [ "PERSONAL_LEDGER", "GENERAL_LEDGER" ] }, "amountGross": { "type": "number", "description": "Bruttobetrag" }, "amountNet": { "type": "number", "description": "Nettobetrag" }, "recordDate": { "type": "string", "description": "Buchungsdatum", "format": "date" }, "performanceDate": { "type": "string", "description": "Leistungsdatum", "format": "date" }, "documentField1": { "type": "string", "description": "Belegfeld 1" }, "documentField2": { "type": "string", "description": "Belegfeld 2" }, "description": { "type": "string", "description": "Buchungstext" }, "costCenter1": { "type": "string", "description": "Kostenstelle 1" }, "comment": { "type": "array", "description": "Hinweis", "items": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } }, "debugInfo": { "type": "string", "description": "Debug Info" }, "taxState": { "type": "string", "description": "Steuerart", "enum": [ "TAX_FREE", "TAX_ABLE" ] }, "taxPerformanceLocation": { "type": "string", "description": "Leistungsort", "enum": [ "DOMESTIC", "EUROPEAN_COMMUNITY", "INTERNATIONAL" ] }, "sourceCountryCode": { "type": "string", "description": "von Land" }, "performanceCountryCode": { "type": "string", "description": "an Land" }, "currencyCode": { "type": "string", "description": "W\u00e4hrung" }, "exchangeRate": { "type": "number", "description": "W\u00e4hrungskurs" }, "baseCurrencyCode": { "type": "string", "description": "Basisw\u00e4hrung" }, "baseAmountGross": { "type": "number", "description": "Bruttobetrag in Basisw\u00e4hrung" }, "baseAmountNet": { "type": "number", "description": "Nettobetrag in Basisw\u00e4hrung" }, "taxRateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "taxIdentificationNumber": { "type": "string", "description": "Umsatzsteuer-Ident-Nummer" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "bookingState": { "type": "string", "description": "Buchungsstatus", "enum": [ "OK", "IGNORED", "ERR_NO_LEDGER_ASSIGNMENT", "ERR_INVALID_LEDGER_ASSIGNMENT", "ERR_DOCUMENT_NOT_FOUND", "ERR_CASH_JOURNAL_NOT_FOUND", "ERR_OPEN_ITEM_RECORD_NOT_FOUND", "ERR_CURRENCY_NOT_FOUND", "ERR_EXCHANGE_RATE_NOT_FOUND", "ERR_OPEN_ITEM_NOT_FOUND", "ERR_BANK_TRANSACTION_NOT_FOUND", "ERR_MANUAL_ENTRY_NOT_FOUND", "ERR_DUNNING_NOT_FOUND", "ERR_NO_ARTICLE_FOUND", "ERR_NO_PERFORMANCE_COUNTRY_FOUND", "ERR_NO_PERFORMANCE_LOCATION_FOUND", "ERR_NO_SOURCE_COUNTRY_FOUND" ] }, "taxLiabilityReversedState": { "type": "string", "description": "\u00a713b-Status", "enum": [ "IGNORE", "REVERSED", "NOT_REVERSED" ] }, "sourceTaxRate": { "type": "number", "description": "Steuerprozentsatz Ursprung" }, "performanceTaxRate": { "type": "number", "description": "Steuerprozentsatz Bestimmung" }, "accountingType": { "type": "string", "description": "Journaltyp", "enum": [ "SALES_INVOICE", "SALES_CREDIT_NOTE", "PURCHASE_INVOICE", "PURCHASE_CREDIT_NOTE", "PAYMENT", "PAYMENT_REVERSAL", "PREPAYMENT_TAX", "PREPAYMENT_TAX_SETTLEMENT", "PREPAYMENT_DOCUMENTNUMBER_SETTLEMENT", "MANUAL_JOURNAL", "DUNNING", "OPEN_ITEM_CLOSURE", "FINANCIAL_SETTLEMENT", "DUNNING_REVERSAL", "SALES_INVOICE_CANCELLATION", "SALES_CREDIT_NOTE_CANCELLATION", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "NOT_RELEVANT_FOR_BUSINESS", "DISCOUNT_GRANTED", "DISCOUNT_RECEIVED", "FEE", "BANK_TRANSACTION", "BANK_TRANSACTION_REVERSAL", "POS_CASH_JOURNAL_OPENING", "POS_CASH_JOURNAL_CLOSING", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_RECEIPT", "POS_RECEIPT_CANCELLATION" ] }, "accountingRefId": { "type": "integer", "description": "Buchungs-Referenz", "format": "int64" }, "accountingRef1": { "$ref": "#/components/schemas/erp-finance-FinanceBookingReference" }, "accountingRef2": { "$ref": "#/components/schemas/erp-finance-FinanceBookingReference" }, "accountingRef3": { "$ref": "#/components/schemas/erp-finance-FinanceBookingReference" } } }, "erp-finance-FinanceBookingReference": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id der Referenz", "format": "int64" }, "type": { "type": "string", "description": "Referenztyp", "enum": [ "DOCUMENT", "DOCUMENT_LINE", "DOCUMENT_TAX", "OPEN_ITEM", "OPEN_ITEM_RECORD", "TAX_RATE", "DUNNING", "DUNNING_POSITION", "BANK_TRANSACTION", "MANUAL_ENTRY" ] }, "label": { "type": "string", "description": "Label der Referenz" } }, "description": "Finanzbuchungsreferenzen" }, "erp-finance-BookingResultLineComment": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "Originalzeile des Kommentars (ab 0)", "format": "int32" }, "position": { "type": "integer", "description": "Feld des Kommentars in Zeile (ab 0)", "format": "int32" }, "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } }, "description": "Hinweis" }, "erp-finance-FinanceBookingExportFile": { "type": "object", "properties": { "shelfDocumentId": { "type": "integer", "description": "Shelf Document ID", "format": "int64" }, "description": { "type": "string", "description": "Beschreibung" }, "comment": { "type": "array", "description": "Hinweis", "items": { "$ref": "#/components/schemas/erp-finance-BookingResultLineComment" } } }, "description": "export files" }, "erp-finance-FinanceBookingRun": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "runState": { "type": "string", "description": "Verarbeitungsstatus", "readOnly": true, "enum": [ "PROCESSING", "OPEN", "COMMITTABLE", "COMMITTED", "REVERTED" ] }, "dateFrom": { "type": "string", "description": "Request date from", "format": "date", "readOnly": true }, "dateTo": { "type": "string", "description": "Request date to", "format": "date", "readOnly": true }, "files": { "type": "array", "description": "export files", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-finance-FinanceBookingExportFile" } }, "persons": { "type": "array", "description": "persons", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-finance-FinanceBookingRunPerson" } }, "stateSummary": { "type": "array", "description": "booking cases per state", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-finance-FinanceBookingStateSummary" } }, "exportTypes": { "type": "array", "description": "Request Types for this run", "readOnly": true, "items": { "type": "string", "description": "Request Types for this run", "enum": [ "SALES_DOCUMENTS", "PURCHASE_DOCUMENTS", "FINANCE_BOOKINGS", "FINANCE_MANAGEMENT", "POS", "PREPAYMENT" ] } }, "bankAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "financeBookingBackendRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-finance-FinanceBookingRunPerson": { "type": "object", "properties": { "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "recordType": { "type": "string", "description": "record Type", "enum": [ "DEBIT", "CREDIT" ] }, "accountNumber": { "type": "string", "description": "account number / ledger" } }, "description": "persons" }, "erp-finance-FinanceBookingStateSummary": { "type": "object", "properties": { "state": { "type": "string", "description": "Buchungsstatus", "enum": [ "OK", "IGNORED", "ERR_NO_LEDGER_ASSIGNMENT", "ERR_INVALID_LEDGER_ASSIGNMENT", "ERR_DOCUMENT_NOT_FOUND", "ERR_CASH_JOURNAL_NOT_FOUND", "ERR_OPEN_ITEM_RECORD_NOT_FOUND", "ERR_CURRENCY_NOT_FOUND", "ERR_EXCHANGE_RATE_NOT_FOUND", "ERR_OPEN_ITEM_NOT_FOUND", "ERR_BANK_TRANSACTION_NOT_FOUND", "ERR_MANUAL_ENTRY_NOT_FOUND", "ERR_DUNNING_NOT_FOUND", "ERR_NO_ARTICLE_FOUND", "ERR_NO_PERFORMANCE_COUNTRY_FOUND", "ERR_NO_PERFORMANCE_LOCATION_FOUND", "ERR_NO_SOURCE_COUNTRY_FOUND" ] }, "count": { "type": "integer", "description": "count of booking cases", "format": "int64" } }, "description": "booking cases per state" }, "erp-finance-LedgerForMissingRecordsRequest": { "type": "object", "properties": { "ledger": { "type": "string", "description": "neues Konto" }, "transactionKey": { "type": "string", "description": "neuer Buchungsschl\u00fcssel", "nullable": true }, "description": { "type": "string", "description": "Buchungstext" }, "costCenter1": { "type": "string", "description": "Kostenstelle 1" }, "ledgerAssignment": { "$ref": "#/components/schemas/erp-finance-LedgerAssignment" }, "createLedgerAssignment": { "type": "boolean", "description": "Regel f\u00fcr Kontenzuordnung anlegen f\u00fcr diese Kombination" } } }, "erp-finance-BookingRunRequest": { "type": "object", "properties": { "dateFrom": { "type": "string", "description": "Datum von", "format": "date" }, "dateTo": { "type": "string", "description": "Datum bis", "format": "date" }, "exportTypes": { "type": "array", "description": "Export-Typen", "items": { "type": "string", "description": "Export-Typen", "enum": [ "SALES_DOCUMENTS", "PURCHASE_DOCUMENTS", "FINANCE_BOOKINGS", "FINANCE_MANAGEMENT", "POS", "PREPAYMENT" ] } }, "bankAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-crm-CrmTaskPerformBillingRequest": { "type": "object", "properties": { "variables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "crmTaskIdsToIgnore": { "type": "array", "description": "IDs von Aufgaben, die nicht abgerechnet werden sollen", "items": { "type": "integer", "description": "IDs von Aufgaben, die nicht abgerechnet werden sollen", "format": "int64" } }, "crmTaskIdsToBill": { "type": "array", "description": "IDs von Aufgaben, die abgerechnet werden sollen", "items": { "type": "integer", "description": "IDs von Aufgaben, die abgerechnet werden sollen", "format": "int64" } }, "createCollectiveInvoicePerAccount": { "type": "boolean", "description": "Sammelrechnung pro Account erstellen", "default": false } }, "description": "Request zur Durchf\u00fchrung der Abrechnung von Aufgaben" }, "erp-crm-CreateCrmTaskRequest": { "type": "object", "properties": { "crmTask": { "$ref": "#/components/schemas/erp-crm-CrmTask" }, "createTemplateIdsWithTasks": { "type": "array", "description": "IDs von Vorlagen mit ggf. (teilweise) gef\u00fcllten Aufgaben", "items": { "$ref": "#/components/schemas/erp-crm-CreateTemplateIdWithTask" } }, "parameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-crm-CreateTemplateIdWithTask": { "required": [ "createTemplateId" ], "type": "object", "properties": { "createTemplateId": { "type": "integer", "description": "ID einer Vorlage", "format": "int64" }, "task": { "$ref": "#/components/schemas/erp-crm-CrmTask" } }, "description": "ID einer Vorlage mit einer (teilweise) gef\u00fcllten Aufgabe" }, "erp-crm-CreateCrmTaskResponse": { "type": "object", "properties": { "createdCrmTasks": { "type": "array", "description": "Die erstellten CRM-Tasks", "items": { "$ref": "#/components/schemas/erp-crm-CrmTask" } }, "warningsByTemplateRef": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "description": "Ggf. vorhandene Probleme", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } }, "description": "Ggf. vorhandene Probleme" } }, "description": "Antwort auf die Anfrage, Aufgaben zu erstellen" }, "erp-crm-CreateCrmProjectRequest": { "type": "object", "properties": { "createTemplateId": { "type": "integer", "description": "Vorlage zum Erstellen eines Projekts", "format": "int64" }, "project": { "$ref": "#/components/schemas/erp-crm-CrmProject" }, "parameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-crm-CrmDealCloseRequest": { "type": "object", "properties": { "dealId": { "type": "integer", "description": "ID des zu schliessenden Deals", "format": "int64" }, "closingReasonId": { "type": "integer", "description": "ID des zu verwendenden Abschlussgrunds", "format": "int64" }, "detailedClosingReason": { "type": "string", "description": "Detaillierter Abschlussgrund" } }, "description": "Request zum Schlie\u00dfen eines Deals" }, "erp-crm-CreateCrmDealRequest": { "type": "object", "properties": { "createTemplateId": { "type": "integer", "description": "Vorlage zum Erstellen eines Deals", "format": "int64" }, "deal": { "$ref": "#/components/schemas/erp-crm-CrmDeal" }, "parameters": { "type": "array", "description": "Zus\u00e4tzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-account-CreateAccountRequestApi": { "type": "object", "properties": { "createTemplateId": { "type": "integer", "description": "Vorlage zum Erstellen eines Accounts", "format": "int64" }, "account": { "$ref": "#/components/schemas/erp-account-Account" } } }, "common-api-AppMessageWebhook": { "required": [ "destinationQueue", "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "url des webhooks. \u00fcblicherweise http(s)://host:port/etc" }, "destinationOwner": { "type": "string", "description": "owner (optional)" }, "destinationQueue": { "type": "string", "description": "queue" }, "appIdentifier": { "type": "string", "description": "appIdentifier (registrar)", "format": "uuid" } } }, "common-api-OutputQueueStateChangeRequest": { "type": "object", "properties": { "processingResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-api-Message": { "type": "object", "properties": { "contentType": { "type": "string", "description": "(mail) content type", "readOnly": true, "enum": [ "TEXT", "HTML" ] }, "content": { "type": "string", "description": "(mail) content", "readOnly": true }, "subject": { "type": "string", "description": "short subject", "readOnly": true } }, "description": "messages)" }, "common-api-OutputQueue": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "resourceId": { "type": "string", "description": "resource id to be printed", "readOnly": true }, "filename": { "type": "string", "description": "filename", "readOnly": true }, "subject": { "type": "string", "description": "short subject", "readOnly": true }, "outputConsumerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "outputTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "fromAddress": { "type": "string", "description": "(mail) from address", "readOnly": true }, "fromName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "(mail) from name", "readOnly": true }, "destinations": { "type": "array", "description": "Recipients/Destinations", "readOnly": true, "items": { "$ref": "#/components/schemas/common-api-Recipient" } }, "messages": { "type": "array", "description": "messages)", "readOnly": true, "items": { "$ref": "#/components/schemas/common-api-Message" } }, "attachmentReferences": { "type": "array", "description": "(mail) additional file references", "readOnly": true, "items": { "type": "string", "description": "(mail) additional file references" } }, "state": { "type": "string", "description": "state of the printing task", "readOnly": true, "enum": [ "REQUESTED", "PROCESSING", "ERROR", "DONE", "ABORTED" ] }, "processingResult": { "type": "string", "description": "Prozessierungs-Ergebnis (f\u00fcr Log)", "readOnly": true }, "fromUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "successfulAttempts": { "type": "integer", "description": "successfulAttempts", "format": "int64", "readOnly": true }, "failedAttempts": { "type": "integer", "description": "failedAttempts", "format": "int64", "readOnly": true }, "ruleResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "importance": { "type": "string", "description": "Wichtigkeit/Dringlichkeit", "readOnly": true, "enum": [ "LOW", "NORMAL", "HIGH", "CRITICAL" ] } } }, "common-api-Recipient": { "type": "object", "description": "Recipients/Destinations" }, "common-api-TextEnumCreate": { "required": [ "groupKey" ], "type": "object", "properties": { "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Wert der Aufz\u00e4hlung" }, "active": { "type": "boolean", "description": "active", "readOnly": true, "default": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "groupKey": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Gruppe der Text-Aufz\u00e4hlung" } } }, "common-api-TextEnumGroupCreate": { "required": [ "key", "label" ], "type": "object", "properties": { "label": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Beschreibung" }, "key": { "maxLength": 255, "minLength": 0, "type": "string", "description": "eindeutiger Key der Gruppe" }, "autoAppend": { "type": "boolean", "description": "automatisches erweitern der Liste aktiv", "default": false } } }, "common-eav-EavDataRemoveRequest": { "required": [ "entities" ], "type": "object", "properties": { "entities": { "type": "array", "description": "Entity-Assoziation, bei denen die Daten gel\u00f6scht werden sollen", "items": { "type": "string", "description": "Entity-Assoziation, bei denen die Daten gel\u00f6scht werden sollen" } }, "attributeId": { "type": "array", "description": "Attribute Key dessen daten gel\u00f6scht werden sollen (optional)", "items": { "type": "integer", "description": "Attribute Key dessen daten gel\u00f6scht werden sollen (optional)", "format": "int64" } } } }, "common-workflow-WorkflowScriptExecutionRequest": { "required": [ "script", "workflowElementType", "workflowId" ], "type": "object", "properties": { "workflowId": { "type": "integer", "description": "ID des Workflows, in dessen Kontext das Skript ausgef\u00fchrt werden soll", "format": "int64" }, "workflowElementType": { "type": "string", "description": "Gibt an, um welche Art von Element es sich bei einem WorkflowElement handelt", "enum": [ "START_EVENT", "INTERMEDIATE_EVENT", "END_EVENT_SUCCESS", "END_EVENT_ERROR", "USER_TASK", "SCRIPT_TASK", "EXCLUSIVE_SPLIT_GATEWAY", "EXCLUSIVE_JOIN_GATEWAY", "PARALLEL_JOIN_GATEWAY", "TIMER", "SUB_WORKFLOW" ] }, "script": { "type": "string", "description": "Das auszuf\u00fchrende Skript" }, "parameters": { "type": "object", "additionalProperties": { "type": "string", "description": "Parameter die an Skript gegeben werden sollen" }, "description": "Parameter die an Skript gegeben werden sollen" } }, "description": "F\u00fchrt ein Skript in einer \"Sandbox\" aus" }, "common-user-UserSetting": { "required": [ "key", "value" ], "type": "object", "properties": { "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "key": { "type": "string", "description": "setting-key" }, "value": { "type": "string", "description": "setting-value" } } }, "common-user-UserMessageCreateRequest": { "required": [ "message" ], "type": "object", "properties": { "recipientUserIds": { "type": "array", "description": "Empf\u00e4nger User", "items": { "type": "integer", "description": "Empf\u00e4nger User", "format": "int64" } }, "recipientGroupIds": { "type": "array", "description": "Empf\u00e4nger User-Gruppen (werden zu Usern)", "items": { "type": "integer", "description": "Empf\u00e4nger User-Gruppen (werden zu Usern)", "format": "int64" } }, "senderBotAlias": { "type": "string", "description": "optional ein BotName als versender. Nur f\u00fcr interne Apps und darf nur mit leeren userIds/groupIds verwendet werden" }, "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } }, "description": "Nachricht-Umschlag zum verschicken" }, "common-output-OutputReportCreateRequest": { "type": "object", "properties": { "copyFromId": { "type": "integer", "description": "kopie: die Id des Reports, der kopiert werden soll. Wenn dieser Wert gesetzt ist, wird outputModuleKey ignoriert", "format": "int64" }, "toGroupId": { "type": "integer", "description": "kopie/neuanlage: die Gruppe, in die der Report als neuer Report angelegt wird", "format": "int64" }, "outputModuleKey": { "type": "string", "description": "neuanlage: der modul key" }, "reportTypeId": { "type": "integer", "description": "neuanlage: welcher Reporttyp liegt vor", "format": "int64" }, "label": { "type": "string", "description": "Bezeichnung des neuen Reports" }, "alias": { "type": "string", "description": "Alias des neuen Reports" } } }, "common-ftsearch-SearchPhoneticRequest": { "type": "object", "properties": { "languageCode": { "maxLength": 2, "minLength": 0, "type": "string", "description": "language code" }, "types": { "type": "array", "description": "Die Types, die durchsucht werden sollen. Oder null f\u00fcr alle", "items": { "type": "string", "description": "Die Types, die durchsucht werden sollen. Oder null f\u00fcr alle" } }, "name1": { "type": "string", "description": "(optional) ein name1" }, "name2": { "type": "string", "description": "(optional) ein name2" }, "name3": { "type": "string", "description": "(optional) ein name3" }, "street": { "type": "string", "description": "(optional) eine street" }, "city": { "type": "string", "description": "(optional) eine city" }, "email": { "type": "string", "description": "(optional) eine email" } } }, "common-ftsearch-SearchResult": { "type": "object", "properties": { "entryType": { "type": "string", "description": "origin of document" }, "refId": { "type": "string", "description": "origin id" }, "parentEntryType": { "type": "string", "description": "parent of document" }, "parentRefId": { "type": "string", "description": "parent id" }, "document": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-data_import-CreateMultiPartImportRunRequest": { "type": "object", "properties": { "label": { "type": "string", "description": "Bezeichnung" }, "orderedRuleSets": { "type": "array", "description": "Import-Regelwerk mit definierter Reihenfolge", "items": { "$ref": "#/components/schemas/common-data_import-CreateMultiPartOrderedRuleSetRequest" } }, "template": { "type": "boolean", "description": "Als Vorlage anlegen?", "default": false } } }, "common-data_import-CreateMultiPartOrderedRuleSetRequest": { "type": "object", "properties": { "step": { "type": "integer", "description": "Stufe, auf der der einzelne Import gestartet wird", "format": "int32" }, "fileName": { "type": "string", "description": "Datei, die f\u00fcr den Import verwendet wird (inkl. Dateiendung)" }, "label": { "type": "string", "description": "Name des Imports" }, "ruleSet": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" } }, "description": "Import-Regelwerk mit definierter Reihenfolge" }, "core-cunit-CuResult": { "type": "object", "properties": { "definition": { "type": "array", "description": "spaltenbeschreibung dieser zelle (bei verschachtelung)", "items": { "oneOf": [ { "$ref": "#/components/schemas/core-cunit-CuMeta" } ] } }, "data": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "Der Ergebniscontainer" }, "common-cunit-QueryPresetOutputRequest": { "type": "object", "properties": { "exportFormat": { "type": "string", "description": "Exportformate", "enum": [ "PDF", "XLSX", "XLSX_RAW", "JSON_RAW", "REPORT_TEMPLATE" ] }, "exportFilename": { "type": "string", "description": "Dateiname (ohne Endung) bei einem Dateiexport" }, "outputType": { "type": "string", "description": "Ausgabe-Typ" }, "groupIdentifier": { "type": "string", "description": "outputGroup Identifier (optional)" }, "published": { "type": "boolean", "description": "ist ver\u00f6ffentlicht?", "default": false }, "presetRequest": { "$ref": "#/components/schemas/common-cunit-QueryPresetRequest" } } }, "common-cunit-CreateQueryPresetRequest": { "required": [ "forWorkflow", "label", "mode" ], "type": "object", "properties": { "label": { "type": "string", "description": "label f\u00fcr diesen filter" }, "mode": { "type": "string", "description": "QueryMode", "enum": [ "QUERY", "STATEMENT" ] }, "permissionAggregation": { "$ref": "#/components/schemas/common-user-ObjectSpecificPermissionAggregation" }, "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\u00e4tzliche konfigurationen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetTransformation" } }, "uiPayload": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "variables": { "type": "array", "description": "Variablen f\u00fcr dieses Preset", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariable" } }, "arithmeticQueryTerms": { "type": "array", "description": "Arithmetische Terme - hier kommt die tats\u00e4chliche Berechnung rein", "items": { "$ref": "#/components/schemas/common-cunit-ArithmeticQueryTerm" } }, "queryStatement": { "type": "string", "description": "Optional ein VQL Query (bei Mode:STATEMENT)" }, "forWorkflow": { "type": "boolean", "description": "f\u00fcr Workflows vorgesehen", "default": false } } }, "common-cunit-VqlQueryApi": { "required": [ "statement" ], "type": "object", "properties": { "statement": { "type": "string", "description": "das statement" }, "limit": { "type": "integer", "description": "optionaler wert f\u00fcr limit (wird gerne zus\u00e4tzlich von tools mitgegeben)", "format": "int32" }, "offset": { "type": "integer", "description": "optionaler wert f\u00fcr offset (wird gerne zus\u00e4tzlich von tools mitgegeben)", "format": "int64" }, "variableSubstitutionList": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" } } }, "node-nodemaster-AppToken": { "type": "object", "properties": { "appIdentifier": { "type": "string", "description": "App-Identifikationsnummer", "format": "uuid" }, "bearerToken": { "type": "string", "description": "Bearer-Token f\u00fcr Companion-App Api" }, "expiresIn": { "type": "integer", "description": "Token wird ablaufen in Sekunden", "format": "int32" }, "issuedAt": { "type": "string", "description": "Token erstellt am", "format": "date-time" } } }, "node-nodemaster-PermittedTokenRequest": { "type": "object", "properties": { "expiresAt": { "type": "string", "description": "g\u00fcltig bis UTC Timestamp", "format": "date-time" }, "permissions": { "type": "array", "description": "Permissions", "items": { "type": "string", "description": "Permissions" } } } }, "banking-api-BankingProviderCreationRequest": { "type": "object", "properties": { "bankType": { "type": "string", "description": "Bankschnittstelle", "enum": [ "FINAPI", "FINAPI_SANDBOX", "MOCKBANK" ] }, "username": { "type": "string", "description": "Username f\u00fcr Bankschnittstelle (falls ben\u00f6tigt)" }, "password": { "type": "string", "description": "Password f\u00fcr Bankschnittstelle (falls ben\u00f6tigt)" } } }, "banking-api-BankingProviderCreationMessage": { "type": "object" }, "erp-wms-ScannableCodePart": { "type": "object", "properties": { "ai": { "type": "string", "description": "AI (Application Identifier)", "readOnly": true }, "value": { "type": "string", "description": "Wert", "readOnly": true }, "label": { "type": "string", "description": "Label", "readOnly": true }, "description": { "type": "string", "description": "Beschreibung", "readOnly": true } }, "description": "Liste der Teile des Codes", "readOnly": true }, "erp-wms-ScannableCodeRecognitionResult": { "type": "object", "properties": { "articleId": { "type": "integer", "description": "ID vom erkannten Artikel (falls einer erkannt wurde)", "format": "int64", "readOnly": true }, "articleNumber": { "type": "string", "description": "Nummer vom erkannten Artikel (falls einer erkannt wurde)", "readOnly": true }, "storageBinId": { "type": "integer", "description": "ID vom erkannten Lagerplatz (falls einer erkannt wurde)", "format": "int64", "readOnly": true }, "storageBinDisplayName": { "type": "string", "description": "Anzeigename vom erkannten Lagerplatz (falls einer erkannt wurde)", "readOnly": true }, "codeType": { "type": "string", "description": "Arten von scanbare Codes", "readOnly": true, "enum": [ "COMMON", "GS1", "HIBC" ] }, "scannableCodeParts": { "type": "array", "description": "Liste der Teile des Codes", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-wms-ScannableCodePart" } } } }, "erp-wms-Picklist": { "required": [ "lines", "number", "state" ], "type": "object", "properties": { "version": { "type": "string", "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": [ "CREATED", "PAUSED_IN_PICKING", "IN_PICKING", "PICKED", "PAUSED_IN_PACKING", "IN_PACKING", "CANCELLED", "FINISHED" ] }, "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" } }, "description": "Pickliste" }, "erp-wms-PicklistLine": { "required": [ "articleId", "lineType", "quantity", "sourceDocumentId", "sourceDocumentLineId", "state", "storageId" ], "type": "object", "properties": { "version": { "type": "string", "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": [ "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", "description": "ID des Quell-Dokuments", "format": "int64" }, "sourceDocumentLineId": { "type": "integer", "description": "ID der Quell-Dokumentposition", "format": "int64" }, "articleId": { "type": "integer", "description": "ID des Artikels", "format": "int64" }, "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 }, "storageId": { "type": "integer", "description": "ID des Lagers, aus dem gepickt werden soll", "format": "int64" }, "storageNumber": { "type": "string", "description": "Lagernummer", "readOnly": true }, "storageDisplayName": { "type": "string", "description": "Lageranzeigename", "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" }, "targetDocumentId": { "type": "integer", "description": "ID des Ziel-Dokuments", "format": "int64" }, "targetDocumentLineId": { "type": "integer", "description": "ID der Ziel-Dokumentposition", "format": "int64" }, "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" } } }, "description": "Positionen einer Pickliste" }, "erp-wms-PicklistLineBooking": { "required": [ "quantity", "quantityPacked", "state", "storageBinId" ], "type": "object", "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", "description": "ID vom bebuchten Lagerplatz", "format": "int64" }, "storageBinDisplayName": { "type": "string", "description": "Anzeigename vom Lagerplatz", "readOnly": true }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" } }, "description": "Buchungen zu Positionen einer Pickliste" }, "erp-wms-PicklistLineComponent": { "required": [ "articleId", "picklistLineId", "position", "quantity", "sourceDocumentLineComponentId" ], "type": "object", "properties": { "version": { "type": "string", "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", "description": "ID einer Position einer Pickliste", "format": "int64" }, "position": { "type": "integer", "description": "Position der Komponente in der Baugruppe", "format": "int32" }, "sourceDocumentLineComponentId": { "type": "integer", "description": "ID der Komponente der Quell-Dokumentposition", "format": "int64" }, "articleId": { "type": "integer", "description": "ID des Artikels", "format": "int64" }, "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", "description": "ID der Komponente der Ziel-Dokumentposition", "format": "int64" }, "bookings": { "type": "array", "description": "Buchungen zu dieser Komponente", "items": { "$ref": "#/components/schemas/erp-wms-PicklistLineBooking" } } }, "description": "Komponenten einer Position einer Pickliste" }, "core-scripting-ScriptDescription": { "type": "object", "properties": { "mainInstance": { "$ref": "#/components/schemas/core-scripting-ScriptingInstanceDescription" }, "availableTypes": { "type": "array", "description": "Beschreibungen der verf\u00fcgbaren Typen", "items": { "$ref": "#/components/schemas/core-scripting-ScriptingTypeDescription" } }, "availableInput": { "type": "array", "description": "Verf\u00fcgbare Eingabedaten", "items": { "$ref": "#/components/schemas/core-scripting-ScriptInputDescription" } } }, "description": "Beschreibung zu einem Skript" }, "core-scripting-ScriptInputDescription": { "type": "object", "properties": { "name": { "type": "string", "description": "Name des Parameters" }, "description": { "type": "string", "description": "Beschreibung des Parameters" }, "dataType": { "type": "string", "description": "Datentyp des Parameters" }, "dataTypeName": { "type": "string", "description": "F\u00fcr Datentyp \"object\": Typ des Parameters" } }, "description": "Beschreibung eines Eingabe-Parameters" }, "core-scripting-ScriptingInstanceDescription": { "type": "object", "properties": { "moduleName": { "type": "string", "description": "Name des Moduls, wo diese Instanz definiert ist" }, "name": { "type": "string", "description": "Name des Typs" }, "description": { "type": "string", "description": "Beschreibung des Typs" }, "attributes": { "type": "array", "description": "Attribute des Typs", "items": { "$ref": "#/components/schemas/core-scripting-ScriptingTypeAttributeDescription" } }, "methods": { "type": "array", "description": "Methoden des Typs", "items": { "$ref": "#/components/schemas/core-scripting-ScriptingTypeMethodDescription" } } }, "description": "Beschreibung einer Instanz, welcher im Scripting verwendet wird" }, "core-scripting-ScriptingTypeAttributeDescription": { "type": "object", "properties": { "name": { "type": "string", "description": "Name des Attributs" }, "description": { "type": "string", "description": "Beschreibung des Attributs" }, "readOnly": { "type": "boolean", "description": "Ist das Attribut read-only", "default": false }, "dataType": { "type": "string", "description": "Datentyp des Attributs" }, "dataTypeName": { "type": "string", "description": "F\u00fcr Datentyp \"object\": Beschreibung des Objekts" } }, "description": "Beschreibung eines Attributs eines Objekts, welches im Scripting verwendet wird" }, "core-scripting-ScriptingTypeDescription": { "type": "object", "properties": { "name": { "type": "string", "description": "Name des Typs" }, "description": { "type": "string", "description": "Beschreibung des Typs" } }, "description": "Beschreibungen der verf\u00fcgbaren Typen" }, "core-scripting-ScriptingTypeMethodDescription": { "type": "object", "properties": { "name": { "type": "string", "description": "Name der Methode" }, "description": { "type": "string", "description": "Beschreibung der Methode" }, "returnType": { "type": "string", "description": "R\u00fcckgabetyp der Methode" }, "returnTypeName": { "type": "string", "description": "F\u00fcr Datentyp \"object\": Name des R\u00fcckgabe-Typs" }, "returnDescription": { "type": "string", "description": "Beschreibung zum R\u00fcckgabe-Wert" }, "parameters": { "type": "array", "description": "Name der Methode", "items": { "$ref": "#/components/schemas/core-scripting-ScriptingTypeMethodParameterDescription" } } }, "description": "Beschreibung einer Methode eines Objekts, welches im Scripting verwendet wird" }, "core-scripting-ScriptingTypeMethodParameterDescription": { "type": "object", "properties": { "name": { "type": "string", "description": "Name des Parameters" }, "description": { "type": "string", "description": "Beschreibung des Parameters" }, "nonNull": { "type": "boolean", "description": "Ist der Parameter als \"non-null\" definiert", "default": false }, "dataType": { "type": "string", "description": "Datentyp des Parameters" }, "dataTypeName": { "type": "string", "description": "F\u00fcr Datentyp \"object\": Name des Parameter-Typs" } }, "description": "Beschreibung eines Parameters einer Methode eines Objekts, welches im Scripting verwendet wird" }, "erp-wms-InventoryTransition": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID der Transition", "format": "int64" }, "label": { "type": "string", "description": "Bezeichnung der Transition" }, "uiHint": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "Inventur-Transition" }, "erp-wms-InventoryDifference": { "required": [ "articleId", "inventoryId", "storageBinId" ], "type": "object", "properties": { "inventoryId": { "type": "integer", "description": "Inventur", "format": "int64" }, "articleId": { "type": "integer", "description": "Artikel", "format": "int64" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelname", "readOnly": true }, "articleDescription": { "type": "string", "description": "Artikelbeschreibung", "readOnly": true }, "storageBinId": { "type": "integer", "description": "Lagerplatz, welcher gez\u00e4hlt wurde", "format": "int64" }, "storageBinDisplayName": { "type": "string", "description": "Anzeigename vom Lagerplatz, welcher gez\u00e4hlt wurde", "readOnly": true }, "serialNumberRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "purchasePrice": { "type": "number", "description": "EK" }, "averagePurchasePrice": { "type": "number", "description": "DEK" }, "targetStock": { "type": "number", "description": "Soll-Bestand" }, "actualStock": { "type": "number", "description": "Ist-Bestand" }, "diffStock": { "type": "number", "description": "Bestand: Soll-Ist-Differenz" }, "targetValue": { "type": "number", "description": "Soll-Wert" }, "actualValue": { "type": "number", "description": "Ist-Wert" }, "diffValue": { "type": "number", "description": "Wert: Soll-Ist-Differenz" }, "targetAverage": { "type": "number", "description": "Soll-Durchschnittswert" }, "actualAverage": { "type": "number", "description": "Ist-Durchschnittswert" }, "diffAverage": { "type": "number", "description": "Durchschnittswert: Soll-Ist-Differenz" }, "revision": { "type": "integer", "description": "Revision der Z\u00e4hlung", "format": "int32", "readOnly": true } }, "description": "Position der Differenzlisten der Inventur" }, "vds-carrier-VdiInitializerKey": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "type": "string", "description": "specific carrier key" }, "name": { "type": "string", "description": "specific carrier name" }, "description": { "type": "string", "description": "carrier description" } } }, "common-system-ThirdPartyDependency": { "type": "object", "properties": { "groupId": { "type": "string", "description": "Group-ID" }, "artifactId": { "type": "string", "description": "Artifact ID" }, "version": { "type": "string", "description": "Version" }, "licenses": { "type": "array", "items": { "$ref": "#/components/schemas/common-system-ThirdPartyLicense" } } } }, "common-system-ThirdPartyLicense": { "type": "object", "properties": { "License Name": { "type": "string" }, "License URL": { "type": "string" } }, "description": "License" }, "core-unknownmodule-GitInfo": { "type": "object", "properties": { "module": { "type": "string", "description": "Project Name" }, "repository": { "type": "string", "description": "Repository Name" }, "branch": { "type": "string", "description": "Branch Name" }, "buildTime": { "type": "string", "description": "Build Time" }, "buildVersion": { "type": "string", "description": "Repository Version" }, "commitId": { "type": "string", "description": "Commit ID" } } }, "erp-stock-StockJournalSelection": { "type": "object", "properties": { "articleId": { "type": "integer", "description": "Ein Artikel", "format": "int64" }, "storageId": { "type": "integer", "description": "Ein Lager", "format": "int64" }, "storageBinId": { "type": "integer", "description": "Ein Lagerplatz", "format": "int64" }, "serialNumberId": { "type": "integer", "description": "Eine Seriennummer", "format": "int64" }, "productGroupId": { "type": "integer", "description": "Eine Produktgruppe", "format": "int64" }, "fromDate": { "type": "string", "description": "Ab Datum", "format": "date" }, "toDate": { "type": "string", "description": "Bis Datum", "format": "date" }, "goodsReceiptPosting": { "type": "boolean", "description": "Wareneingangsbuchung" } } }, "erp-stock-StockJournal": { "type": "object", "properties": { "version": { "type": "string", "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 Lagerbuchung", "enum": [ "MANUAL", "DOCUMENT", "RESTOCKING", "INITIAL_INVENTORY", "INVENTORY_CORRECTION", "AVERAGE_PURCHASE_PRICE_CORRECTION", "LAST_PURCHASE_PRICE_CORRECTION", "BUNDLE_MERGE_OR_DISSOLVE" ] }, "articleId": { "type": "string", "description": "Artikel, welches gebucht wurde" }, "productNumber": { "type": "string", "description": "Produktnummer" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "storageBinId": { "type": "string", "description": "Lagerplatz, welcher bebucht wurde" }, "documentLineComponentId": { "type": "string", "description": "Document-Line-Komponente, zu der die Buchung stattgefunden hat" }, "picklistLineComponentId": { "type": "string", "description": "Picklist-Line-Komponente, zu der die Buchung stattgefunden hat" }, "documentNumber": { "type": "string", "description": "Dokument-Nummer" }, "documentType": { "type": "string", "description": "Dokument-Typ" }, "bookingTypeId": { "type": "string", "description": "Buchungstyp dieses JournalEintrags", "readOnly": true }, "quantity": { "type": "number", "description": "Menge die gebucht wurde" }, "factor": { "type": "string", "description": "Bewertungsfaktor der Buchung (Lagerzugang / Lagerabgang)", "enum": [ "NONE", "INCREMENT", "DECREMENT" ] }, "valueDate": { "type": "string", "description": "Buchungs-/Wertstellungs-Datum der Lagerbewegung", "format": "date" }, "note": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Bemerkung zu der Buchung" }, "totalPurchasePrice": { "type": "number", "description": "EK dieser Buchung" }, "purchasePriceAdjustment": { "type": "number", "description": "EK-Anpassung dieser Buchung" }, "cancellation": { "type": "boolean", "description": "Handelt es sich um ein Storno?", "default": false }, "cancellationDetails": { "type": "string", "description": "Details zu einem Storno" }, "priceUnit": { "type": "number", "description": "Preiseinheit" } }, "description": "Lagerbuchungen", "readOnly": true }, "erp-statistic-QueryAlias": { "type": "object", "properties": { "id": { "type": "string", "description": "id for the query" }, "description": { "type": "string", "description": "description of this query" } } }, "erp-product-ProductPriceHistory": { "required": [ "article", "newPrice", "priceBase", "salesChannel" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "article": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannel": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "previousPrice": { "type": "number", "description": "Vorheriger Preis", "readOnly": true }, "newPrice": { "type": "number", "description": "Neuer Preis", "readOnly": true }, "priceBase": { "type": "string", "description": "Preisbasis", "readOnly": true, "enum": [ "NET_PRICE", "GROSS_PRICE" ] } }, "description": "Preishistorie" }, "erp-product-PurchasePriceStatistic": { "type": "object", "properties": { "averagePrice": { "type": "number", "description": "Durchschnitts-Einkaufspreis", "readOnly": true }, "averagePriceBookedAt": { "type": "string", "description": "Wertstellungsdatum Durchschnitts-Einkaufspreis", "format": "date", "readOnly": true }, "lastPrice": { "type": "number", "description": "letzter Einkaufspreis", "readOnly": true }, "lastPriceUpdatedAt": { "type": "string", "description": "Erfassungszeitpunkt letzter Einkaufspreis", "format": "date-time", "readOnly": true }, "lastPriceBookedAt": { "type": "string", "description": "Wertstellungsdatum letzter Einkaufspreis", "format": "date", "readOnly": true }, "mainSupplierAccount": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "mainSupplierProductPrice": { "$ref": "#/components/schemas/erp-product-ProductPrice" } }, "description": "Preisstatistiken (DEK und letzter EK)" }, "erp-product-ProductCombinationDto": { "type": "object", "properties": { "article": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "combination": { "type": "array", "description": "Wert-Kombination", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "description": "used combinations" }, "erp-product-ProductVariantCombinationsDto": { "type": "object", "properties": { "mainProductVariant": { "$ref": "#/components/schemas/erp-product-ProductVariant" }, "attributes": { "type": "array", "description": "attributes used for combinations", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttribute" } }, "values": { "type": "array", "description": "values used for combinations", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttributeValue" } }, "usedCombinations": { "type": "array", "description": "used combinations", "items": { "$ref": "#/components/schemas/erp-product-ProductCombinationDto" } } } }, "erp-payment-PaymentTemplateField": { "type": "object", "properties": { "label": { "type": "string" }, "fieldName": { "type": "string" } } }, "erp-stock-OrderProposalToOrdersRun": { "type": "object", "properties": { "number": { "type": "integer", "description": "Nummer", "format": "int64", "readOnly": true }, "successful": { "type": "boolean", "description": "Erfolgreich?", "readOnly": true }, "logLines": { "type": "array", "description": "Logeintr\u00e4ge", "readOnly": true, "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" } }, "orderProposalId": { "type": "string", "description": "Bestellvorschlag", "readOnly": true }, "orderDocuments": { "type": "array", "description": "Preisanfragen/Bestellungen", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } } }, "description": "Bestellerstellungslauf entsprechend einem Bestellvorschlag" }, "erp-finance-PaymentRun": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "processed": { "type": "boolean", "description": "Wurde dieser Zahllauf bereits verarbeitet" }, "label": { "type": "string", "description": "Ein Name f\u00fcr den Zahllauf" } } }, "common-workflow-WorkItem": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "Workflow-Element, das abgebildet wird", "format": "int64" }, "parentWorkItemRef": { "type": "integer", "description": "Work-Item im \u00fcbergeordneten Workflow, wenn es sich um einen Unter-Workflow handelt", "format": "int64" }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "logEntries": { "type": "array", "description": "Logging-Eintr\u00e4ge chronologisch sortiert", "items": { "$ref": "#/components/schemas/common-workflow-WorkflowInstanceLogLine" } }, "splitResult": { "type": "string", "description": "F\u00fcr Split-Gateways: mit welchem Ergebnis wurde dieses Work-Item ausgef\u00fchrt" } }, "description": "Schritte des Workflows" }, "common-workflow-WorkflowInstance": { "type": "object", "properties": { "version": { "type": "string", "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\u00e4ge chronologisch sortiert", "items": { "$ref": "#/components/schemas/common-workflow-WorkflowInstanceLogLine" } } } }, "common-workflow-WorkflowInstanceLogLine": { "type": "object", "properties": { "version": { "type": "string", "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", "description": "ID der Workflow-Instanz", "format": "int64" }, "workItemId": { "type": "integer", "description": "ID des Work-Items", "format": "int64" }, "logTime": { "type": "string", "description": "Zeitstempel", "format": "date-time" }, "origin": { "type": "string", "description": "Wodurch wurde dieser Eintrag ausgel\u00f6st", "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\u00fcr die I18n-Nachricht" }, "description": "Parameter f\u00fcr die I18n-Nachricht" } }, "description": "Logging-Eintr\u00e4ge chronologisch sortiert" }, "erp-finance-ClearingExpectedResponse": { "type": "object", "properties": { "qualifier": { "type": "string", "description": "Forderung oder Verbindlichkeit", "enum": [ "PAYABLE", "RECEIVABLE" ] }, "amount": { "type": "number", "description": "saldo" } } }, "erp-finance-DirectDebitInfo": { "type": "object", "properties": { "invoiceNumber": { "type": "string", "description": "Rechnungsnummer" }, "invoiceDate": { "type": "string", "description": "Datum der Rechnung", "format": "date" }, "amount": { "type": "number", "description": "Vollbetrag der Rechnung" }, "discount": { "type": "number", "description": "Rabattbetrag" }, "amountToDebit": { "type": "number", "description": "Gesamter einzuziehender Betrag nach Rabattabzug" }, "customerNumber": { "type": "string", "description": "Kundennummer" }, "name": { "type": "string", "description": "Name des Kunden" }, "iban": { "type": "string", "description": "IBAN des Kunden" }, "bic": { "type": "string", "description": "BIC des Kunden" }, "paymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "purpose": { "type": "string", "description": "Betreffzeile" }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryDate": { "type": "string", "description": "Lieferdatum", "format": "date" }, "country": { "$ref": "#/components/schemas/common-masterdata-CountryReference" }, "zipCode": { "type": "string", "description": "Postleitzahl der Kundenrechnungsadresse" }, "city": { "type": "string", "description": "Stadt der Kundenrechnungsadresse" }, "dueDate": { "type": "string", "description": "F\u00e4lligkeitsdatum", "format": "date" }, "opNumber": { "type": "string", "description": "Op-Nummer" }, "accountId": { "type": "integer", "description": "Accound-Id", "format": "int64" }, "documentId": { "type": "integer", "description": "Document-Id", "format": "int64" } }, "description": "Lastschriftinformationen" }, "erp-finance-MoneyTransferInfo": { "type": "object", "properties": { "invoiceDate": { "type": "string", "description": "Datum der Rechnung", "format": "date" }, "externalInvoiceNumber": { "type": "string", "description": "Externe Belegnummer" }, "invoiceNumber": { "type": "string", "description": "Belegnummer" }, "name": { "type": "string", "description": "Name des Lieferanten" }, "dueDate": { "type": "string", "description": "F\u00e4lligkeitsdatum", "format": "date" }, "discountDate": { "type": "string", "description": "Datum f\u00fcr Skontoabzug wenn anwendbar", "format": "date" }, "amount": { "type": "number", "description": "Vollbetrag der Rechnung" }, "discountAmount": { "type": "number", "description": "Skontobetrag wenn anwendbar" }, "amountToPay": { "type": "number", "description": "Betrag nach Abzug von Skonto" }, "paymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "iban": { "type": "string", "description": "IBAN des Lieferanten" }, "bic": { "type": "string", "description": "BIC des Lieferanten" }, "opNumber": { "type": "string", "description": "openItemNummer" }, "accountId": { "type": "integer", "description": "accountId", "format": "int64" }, "documentId": { "type": "integer", "description": "documentId", "format": "int64" } }, "description": "\u00dcberweisungsinformationen" }, "erp-finance-PaymentPrepareResponse": { "type": "object", "properties": { "bankAccount": { "$ref": "#/components/schemas/erp-bank-BankAccount" }, "details": { "type": "array", "description": "Details zum Zahlungsvorschlag", "items": { "$ref": "#/components/schemas/erp-finance-PaymentPrepareResponseDetail" } } } }, "erp-finance-PaymentPrepareResponseDetail": { "type": "object", "properties": { "openItemId": { "type": "integer", "description": "item Id", "format": "int64" }, "directDebitInfo": { "$ref": "#/components/schemas/erp-finance-DirectDebitInfo" }, "moneyTransferInfo": { "$ref": "#/components/schemas/erp-finance-MoneyTransferInfo" }, "messages": { "type": "array", "description": "list of message", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } }, "index": { "type": "integer", "description": "index", "format": "int32" }, "creatable": { "type": "boolean", "description": "Ist die Erstellung m\u00f6glich?" } }, "description": "Details zum Zahlungsvorschlag" }, "erp-finance-ManualEntry": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "transaction": { "$ref": "#/components/schemas/erp-bank-BankTransaction" }, "amount": { "type": "number", "description": "the amount" }, "ledgerNumber": { "type": "string", "description": "the number of the ledger" }, "transactionKey": { "type": "string", "description": "transaction key" }, "costCenter1": { "type": "string", "description": "cost center 1" }, "documentField1": { "type": "string", "description": "document field 1" }, "comment": { "type": "string", "description": "a comment on the entry" } } }, "erp-finance-DunningRun": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "processed": { "type": "boolean", "description": "Wurde der Mahnlauf bereits verarbeitet" }, "label": { "type": "string", "description": "Ein Kurzname f\u00fcr den Mahnlauf" }, "number": { "type": "string", "description": "Die Mahnlauf-Nummer" }, "canceled": { "type": "boolean", "description": "Storniert" }, "processedAt": { "type": "string", "description": "Verbuchungsdatum", "format": "date-time" } } }, "erp-finance-Dunning": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "dunningDate": { "type": "string", "description": "Mahndatum", "format": "date" }, "nextDunningDate": { "type": "string", "description": "N\u00e4chstes Mahndatum", "format": "date" }, "dunningFee": { "type": "number", "description": "Mahngeb\u00fchr" }, "dunningInterest": { "type": "number", "description": "Mahnzinsen" }, "positions": { "type": "array", "description": "Mahnpositionen", "items": { "$ref": "#/components/schemas/erp-finance-DunningPosition" } }, "printedAt": { "type": "string", "description": "Datum des Drucks", "format": "date" }, "currencyCode": { "type": "string", "description": "W\u00e4hrung der Mahnung (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der W\u00e4hrung zu Basisw\u00e4hrung" }, "baseCurrencyCode": { "type": "string", "description": "Basisw\u00e4hrung der Mahnung (ISO-A3)" }, "baseDunningFee": { "type": "number", "description": "Mahngeb\u00fchr in Basisw\u00e4hrung" }, "baseDunningInterest": { "type": "number", "description": "Mahnzinsen in Basisw\u00e4hrung" } } }, "erp-finance-DunningPosition": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "openItemRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "dunningLevelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "dunningFee": { "type": "number", "description": "Mahngeb\u00fchr" }, "dunningInterest": { "type": "number", "description": "Mahnzinsen" }, "currencyCode": { "type": "string", "description": "W\u00e4hrung der Mahnung (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der W\u00e4hrung zu Basisw\u00e4hrung" }, "baseCurrencyCode": { "type": "string", "description": "Basisw\u00e4hrung der Mahnung (ISO-A3)" }, "baseDunningFee": { "type": "number", "description": "Mahngeb\u00fchr in Basisw\u00e4hrung" }, "baseDunningInterest": { "type": "number", "description": "Mahnzinsen in Basisw\u00e4hrung" }, "dunningAmount": { "type": "number", "description": "Anzumahnender Betrag" } }, "description": "Mahnpositionen" }, "erp-document-DocumentUiHintCollection": { "type": "object", "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": { "type": "object", "properties": { "articleId": { "type": "integer", "description": "Artikel, auf den sich die UI-Hints beziehen", "format": "int64" }, "uiHints": { "type": "array", "description": "UI-Hints f\u00fcr den Artikel und Dokumenttypen", "items": { "type": "string", "description": "UI-Hints f\u00fcr den Artikel und Dokumenttypen" } } }, "description": "UI-Hints, die sich auf den Dokumenttypen und einen Artikel beziehen" }, "erp-document-DocumentTransitionRef": { "required": [ "id", "transitionId" ], "type": "object", "properties": { "id": { "type": "string", "description": "das gleiche wie transition id f\u00fcr 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", "readOnly": true, "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_CASH_RECEIPT_CANCELLATION", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ] }, "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\u00fcr die Kategorie", "readOnly": true }, "targetState": { "type": "string", "description": "Der Ziel-Status der Transition", "readOnly": true }, "sortOrder": { "type": "integer", "description": "Sortier-Reihenfolge", "format": "int32", "readOnly": true } } }, "erp-document-DocumentHistoryNode": { "type": "object", "properties": { "documentId": { "type": "string", "description": "the id of the document" }, "number": { "type": "string", "description": "the number of the document" }, "documentDate": { "type": "string", "description": "documentDate", "format": "date" }, "totalGrossPrice": { "type": "number", "description": "gross total price (GROSS)" }, "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", "description": "indicates that this document was requested", "default": false }, "chainIdentifier": { "type": "string", "description": "Belegketten-Id" } } }, "erp-document-SuccessorDocumentAssignableLinesDocumentLine": { "type": "object", "properties": { "unassignedLines": { "type": "array", "description": "Positionen ohne Vorbelegsposition", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-document-DocumentLine" } }, "uncompletedLines": { "type": "array", "description": "Nicht (vollst\u00e4ndig) \u00fcbernommene Positionen", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-document-DocumentLine" } }, "completedLines": { "type": "array", "description": "Vollst\u00e4ndig \u00fcbernommene Positionen", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-document-DocumentLine" } } }, "description": "Belegpositionen f\u00fcr die Vorbelegszuordnung" }, "erp-document-DocumentLineStorageResponse": { "type": "object", "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" } }, "description": "storage option for a document-line" }, "erp-document-OrderableLine": { "required": [ "order", "quantity" ], "type": "object", "properties": { "documentLineId": { "type": "string", "description": "Id der DocumentLine", "readOnly": true }, "position": { "type": "integer", "description": "Positionsnummer", "format": "int32", "readOnly": true }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelbezeichnung", "readOnly": true }, "articleId": { "type": "integer", "description": "Artikelnummer", "format": "int64", "readOnly": true }, "quantity": { "type": "number", "description": "Menge" }, "order": { "type": "boolean", "description": "Bestellen?", "default": true }, "supplierRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "availableQuantity": { "type": "number", "description": "Verf\u00fcgbare Menge", "readOnly": true }, "orderedQuantity": { "type": "number", "description": "Bestellte Menge", "readOnly": true }, "dropShippingPolicy": { "type": "string", "description": "Definiert, ob und wie ein Artikel per Streckengesch\u00e4ft verkauft werden darf", "readOnly": true, "enum": [ "ANY", "DROP_SHIPPING", "STORAGE", "STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING" ] } }, "description": "Bestellbare Positionen f\u00fcr \u00dcbernahme in Bestellung" }, "erp-document-ToSupplierDeliveryTransferableLine": { "type": "object", "properties": { "documentLineId": { "type": "integer", "description": "ID der Document-Line", "format": "int64" }, "position": { "type": "integer", "description": "Positionsnummer", "format": "int32" }, "articleNumber": { "type": "string", "description": "Artikelnummer" }, "articleName": { "type": "string", "description": "Artikelbezeichnung" }, "quantity": { "type": "number", "description": "Menge" }, "orderedQuantity": { "type": "number", "description": "Bestellte Menge" }, "storageId": { "type": "integer", "description": "Die Lager-ID der Position", "format": "int64" }, "hasStorageBins": { "type": "boolean", "description": "Hat das Ziel-Lager der Position Lagerpl\u00e4tze?", "default": false } }, "description": "In Eingangslieferung \u00fcbernehmbare Positionen" }, "erp-wms-CompleteDocumentAvailabilityInfo": { "type": "object", "properties": { "orderAvailabilityInfo": { "$ref": "#/components/schemas/erp-wms-OrderAvailabilityInfo" }, "lineAvailabilityInfos": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/erp-wms-OrderLineAvailabilityInfo" } } } }, "erp-wms-OrderAvailabilityInfo": { "type": "object", "properties": { "orderAvailability": { "type": "string", "enum": [ "FULL_DELIVERABLE", "NOTHING_DELIVERABLE", "AT_LEAST_ONE_LINE_IS_FULL_DELIVERABLE", "AT_LEAST_ONE_LINE_IS_PARTIALLY_DELIVERABLE" ] }, "orderStackProcessingType": { "type": "string", "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" } } }, "erp-wms-OrderLineAvailabilityInfo": { "type": "object", "properties": { "orderLineAvailability": { "type": "string", "enum": [ "FULL_DELIVERABLE", "NOTHING_DELIVERABLE", "PARTIALLY_DELIVERABLE" ] }, "availableQuantity": { "type": "number" }, "maxAvailableQuantity": { "type": "number" }, "orderedQuantity": { "type": "number" } } }, "erp-document-DocumentTypeTransition": { "required": [ "key", "label", "targetState" ], "type": "object", "properties": { "label": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "key": { "type": "string", "description": "unique key" }, "sourceState": { "type": "string", "description": "source/origin state" }, "targetState": { "type": "string", "description": "target state" }, "uiHint": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-document-DocumentTypeStateRef": { "type": "object", "properties": { "key": { "type": "string", "description": "key for this state" }, "label": { "type": "string", "description": "label/name of this state" } } }, "erp-crm-CrmBillingRun": { "type": "object", "properties": { "number": { "type": "integer", "description": "Nummer", "format": "int64", "readOnly": true }, "successful": { "type": "boolean", "description": "Erfolgreich?", "readOnly": true }, "logLines": { "type": "array", "description": "Logeintr\u00e4ge", "readOnly": true, "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" } }, "billingDocuments": { "type": "array", "description": "Abrechnungseintr\u00e4ge", "readOnly": true, "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } } }, "description": "CRM Abrechnungslauf" }, "erp-bank-BankAction": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the action" }, "type": { "type": "string", "description": "action type", "enum": [ "OPEN_URL" ] }, "expiration": { "type": "string", "description": "Expiration of the action", "format": "date-time" }, "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" } } }, "erp-bank-BankRef": { "type": "object", "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" } } }, "erp-bank-BankConnectionDto": { "type": "object", "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" } } }, "erp-stock-ArticleStorageMovement": { "required": [ "articleId" ], "type": "object", "properties": { "articleId": { "type": "string", "description": "Das Produkt, dessen Lagerinfos hier ausgegeben werden" }, "latestDecrement": { "$ref": "#/components/schemas/erp-stock-Movement" }, "latestIncrement": { "$ref": "#/components/schemas/erp-stock-Movement" }, "nextDelivery": { "$ref": "#/components/schemas/erp-stock-Movement" } }, "description": "Lagerbewegungs-Infos" }, "erp-stock-Movement": { "type": "object", "properties": { "movementDate": { "type": "string", "description": "Datum", "format": "date" }, "documentId": { "type": "integer", "description": "Document-Id", "format": "int64" }, "documentLineId": { "type": "integer", "description": "DocumentLine-Id", "format": "int64" }, "quantity": { "type": "number", "description": "Menge" } }, "description": "N\u00e4chste Lieferung" }, "erp-stock-ArticleStock": { "type": "object", "properties": { "articleId": { "type": "string", "description": "Artikel" }, "reservedQuantity": { "type": "number", "description": "Aktuelle reservierte Menge in den Sales-Storages" }, "orderedQuantity": { "type": "number", "description": "Aktuell bestellte Menge in den Sales-Storages" }, "quantityInPicking": { "type": "number", "description": "Aktuelle Menge in Kommissionierung" }, "stockAmount": { "type": "number", "description": "Aktueller Bestand in den Sales-Storages" }, "stockAvailable": { "type": "number", "description": "Aktuelle verf\u00fcgbare Menge in den Sales-Storages" }, "virtualStockAmount": { "type": "number", "description": "Aktueller \"virtueller\" Bestand in den Sales-Storages (wenn gr\u00f6\u00dfere Gebinde in dieses aufgel\u00f6st werden w\u00fcrden)" }, "virtualStockAvailable": { "type": "number", "description": "Aktuelle \"virtuelle\" verf\u00fcgbare Menge in den Sales-Storages (wenn gr\u00f6\u00dfere Gebinde in dieses aufgel\u00f6st werden w\u00fcrden)" } } }, "erp-product-ArticleComponentCollection": { "required": [ "components" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "components": { "type": "array", "description": "Alle Komponenten, die zu diesem Produkt geh\u00f6ren", "items": { "$ref": "#/components/schemas/erp-product-ArticleComponent" } }, "totalSalesPrice": { "type": "number", "description": "Summe der Verkaufspreise der Komponenten" }, "totalPurchasePrice": { "type": "number", "description": "Summe der Einkaufspreise der Komponenten" }, "totalNetWeight": { "type": "number", "description": "Summe der Netto-Gewichte der Komponenten" }, "totalGrossWeight": { "type": "number", "description": "Summe der Brutto-Gewichte der Komponenten" } }, "description": "Komponenten eines Baugruppen- oder Jumbo-Artikels mit Summen" }, "erp-product-ArticleBundleMergeDissolveInfo": { "type": "object", "properties": { "articleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "dissolveRatios": { "type": "array", "description": "M\u00f6gliche Ziele f\u00fcr die Aufl\u00f6sung", "items": { "$ref": "#/components/schemas/erp-product-ArticleBundleRatio" } }, "mergeRatios": { "type": "array", "description": "M\u00f6gliche Ziele f\u00fcr die Zusammenf\u00fchrung", "items": { "$ref": "#/components/schemas/erp-product-ArticleBundleRatio" } } }, "description": "Informationen zur Zusammenf\u00fchrung und Aufl\u00f6sung von Artikelgebinden" }, "erp-product-ArticleBundleRatio": { "type": "object", "properties": { "articleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "bundleRatio": { "$ref": "#/components/schemas/erp-product-BundleUnitTypeRatio" } }, "description": "Artikel mit seinem Gebindeschemaeintrag" }, "erp-product-ArticlePrintLabelOrderResponse": { "type": "object", "properties": { "position": { "type": "integer", "description": "Position", "format": "int32", "readOnly": true }, "article": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "report": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialArticle": { "type": "boolean", "description": "Seriennummernpflichtig?", "readOnly": true }, "serialNumber": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "print": { "type": "boolean", "description": "Etikettendruck" }, "quantity": { "type": "integer", "description": "Menge", "format": "int32" } }, "description": "Antwort Welche Artikel wie oft gedruckt werden soll" }, "erp-account-AccountDuplicate": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "firstAccount": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "secondAccount": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "markedNonDuplicate": { "type": "boolean", "description": "wurde der Account als nicht duplikat markiert", "default": false } } }, "dms-shelf-ShelfDocumentProtocol": { "type": "object", "properties": { "version": { "type": "string", "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": { "type": "integer", "description": "Verweis auf das zugeh\u00f6rige Shelf-Document", "format": "int64" }, "message": { "type": "string", "description": "Mitteilung des Protokolls" }, "protocolType": { "type": "string", "description": "Art des Protokolleintrags", "enum": [ "CREATED", "FILE_CHANGED", "CHANGED", "SHARED", "DEACTIVATED", "FILE_DELETED" ] }, "timestamp": { "type": "string", "description": "Zeitpunkt, an dem der Eintrag erstellt wurde", "format": "date-time" }, "userName": { "type": "string", "description": "Nutzer, der den Eintrag ausgel\u00f6st hat" } } }, "erp-finance-FinanceBooking": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "recordNumber": { "type": "integer", "description": "record number", "format": "int64" }, "records": { "type": "array", "description": "produced booking records", "items": { "$ref": "#/components/schemas/erp-finance-FinanceBookingRecord" } }, "originatingObject": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "journalType": { "type": "string", "description": "Journaltyp", "enum": [ "SALES_INVOICE", "SALES_CREDIT_NOTE", "PURCHASE_INVOICE", "PURCHASE_CREDIT_NOTE", "PAYMENT", "PAYMENT_REVERSAL", "PREPAYMENT_TAX", "PREPAYMENT_TAX_SETTLEMENT", "PREPAYMENT_DOCUMENTNUMBER_SETTLEMENT", "MANUAL_JOURNAL", "DUNNING", "OPEN_ITEM_CLOSURE", "FINANCIAL_SETTLEMENT", "DUNNING_REVERSAL", "SALES_INVOICE_CANCELLATION", "SALES_CREDIT_NOTE_CANCELLATION", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "NOT_RELEVANT_FOR_BUSINESS", "DISCOUNT_GRANTED", "DISCOUNT_RECEIVED", "FEE", "BANK_TRANSACTION", "BANK_TRANSACTION_REVERSAL", "POS_CASH_JOURNAL_OPENING", "POS_CASH_JOURNAL_CLOSING", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_RECEIPT", "POS_RECEIPT_CANCELLATION" ] } } }, "common-system-QueueDestinationDescription": { "type": "object", "properties": { "owner": { "type": "string" }, "queue": { "type": "string" } } }, "common-scripting-Script": { "required": [ "moduleName" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "moduleName": { "type": "string", "description": "Der Modulname dieses Skripts" }, "scriptSource": { "maxLength": 2147483647, "minLength": 0, "type": "string", "description": "Das auszuf\u00fchrende Skript" }, "scriptModuleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "description": "Script" }, "common-scripting-ScriptRun": { "required": [ "finishAt", "identifier", "script", "startedAt" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "script": { "$ref": "#/components/schemas/common-scripting-Script" }, "identifier": { "maxLength": 255, "minLength": 0, "type": "string", "description": "ID der Session" }, "logLines": { "type": "array", "description": "Log des Runs", "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" } }, "startedAt": { "type": "string", "description": "Startzeitpunkt", "format": "date-time" }, "finishAt": { "type": "string", "description": "Endzeitpunkt", "format": "date-time" }, "successful": { "type": "boolean", "description": "War der Run erfolgreich?", "default": true } } }, "common-eav-EavEntityRef": { "required": [ "key" ], "type": "object", "properties": { "key": { "type": "string", "description": "Identifier" }, "label": { "type": "string", "description": "a short description", "readOnly": true } } }, "common-workflow-WorkflowTriggerDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the Object" }, "topic": { "type": "string", "description": "Thema, das diesen Workflow ausl\u00f6st" }, "triggerName": { "type": "string", "description": "Genauerer Name des ausl\u00f6sers" } } }, "core-cunit-SearchDialogWithIdentifier": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Identifier des Search-Dialogs" }, "searchDialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "description": "Definition eines Search-Dialogs" }, "common-user-MeResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/common-user-User" }, "company": { "$ref": "#/components/schemas/common-user-MyCompany" } } }, "common-user-MyCompany": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the Object", "example": "1" }, "name1": { "type": "string", "description": "Name" }, "name2": { "type": "string", "description": "Name2" }, "name3": { "type": "string", "description": "Name3" }, "street": { "type": "string", "description": "Stra\u00dfe" }, "streetAddressNumber": { "type": "string", "description": "Hausnummer" }, "city": { "type": "string", "description": "Stadt" }, "postalCode": { "type": "string", "description": "Postleitzahl" }, "languageCodeIso2a": { "type": "string", "description": "Sprachcode Iso2a" }, "languageCodeId": { "type": "integer", "description": "SprachcodeId", "format": "int64" }, "countryCodeIso2a": { "type": "string", "description": "L\u00e4ndercode Iso2a" }, "countryCodeId": { "type": "integer", "description": "Id des Landes", "format": "int64" }, "currencyCodeIso3a": { "type": "string", "description": "W\u00e4hrungscode Iso3a" }, "currencyCodeId": { "type": "integer", "description": "Id der W\u00e4hrung", "format": "int64" }, "createdAt": { "type": "string", "description": "Zeit der Anlegung", "format": "date-time" } }, "description": "Meine Adresse" }, "common-ui-UiSettingResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the Object", "example": "1" }, "value": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "permissionAggregation": { "$ref": "#/components/schemas/common-user-ObjectSpecificPermissionAggregation" } } }, "common-cunit-QueryPresetResultEmbedded": { "required": [ "property" ], "type": "object", "properties": { "property": { "type": "string" }, "displayName": { "type": "string" }, "functions": { "type": "array", "items": { "type": "string" } }, "visible": { "type": "boolean" } } }, "common-text-QueryBaseHolderPresetEntity": { "required": [ "defaultFor", "templateGroupKey", "templateId" ], "type": "object", "properties": { "createdFrom": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedFrom": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "merge$Id": { "type": "integer", "format": "int64" }, "templateId": { "maxLength": 255, "minLength": 0, "type": "string" }, "templateGroupKey": { "maxLength": 255, "minLength": 0, "type": "string" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetResultEmbedded" } }, "defaultFor": { "type": "string", "enum": [ "DUNNING", "ACCOUNT", "ARTICLE", "OPENITEM", "DOCUMENT", "DOCUMENT_LINE", "MANDATE", "BANK", "BANK_TRANSACTION", "SHIPPED_DOCUMENT", "POS_REGISTER", "CASH_DRAWER", "POS_PAYMENT_METHOD", "POS_DEPOSIT_EXPENSE_TYPE" ] } } }, "common-task-TaskLog": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "executionId": { "type": "string", "description": "description of this task", "format": "uuid", "readOnly": true }, "dueTime": { "type": "string", "description": "start time (geplant)", "format": "date-time", "readOnly": true }, "queueDurationInSeconds": { "type": "integer", "description": "queue zeit", "format": "int64", "readOnly": true }, "startTime": { "type": "string", "description": "start time", "format": "date-time", "readOnly": true }, "endTime": { "type": "string", "description": "end time", "format": "date-time", "readOnly": true }, "durationInSeconds": { "type": "integer", "description": "duration", "format": "int64", "readOnly": true }, "status": { "type": "string", "description": "result of run", "readOnly": true, "enum": [ "CREATED", "QUEUED", "RUNNING", "TERMINATED", "SUCCESSFUL", "ERRONEOUS", "FATAL" ] }, "nodeName": { "type": "string", "description": "node-name ", "readOnly": true }, "logLines": { "type": "array", "description": "lines of log", "readOnly": true, "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" } } } }, "common-task-SupportTask": { "required": [ "identifier" ], "type": "object", "properties": { "identifier": { "type": "string", "description": "identifier" }, "description": { "type": "string", "description": "description" } } }, "core-product-AvailableLicense": { "type": "object", "properties": { "licenseKey": { "type": "string", "description": "der valide lizenz-key" }, "licenseValidTo": { "type": "string", "description": "Bei Testlizenzen -> valide bis", "format": "date" } } }, "common-sequencer-PooledSequence": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "context": { "type": "string", "description": "context of this Sequence", "readOnly": true }, "groupKey": { "type": "string", "description": "group-key", "readOnly": true }, "sequence": { "type": "integer", "description": "reserved sequence id", "format": "int64", "readOnly": true } } }, "common-sequencer-Sequence": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "context": { "type": "string", "description": "context of this Sequence", "readOnly": true }, "groupKey": { "type": "string", "description": "group-key", "readOnly": true }, "lastSequence": { "type": "integer", "description": "last returned sequence", "format": "int64", "readOnly": true } } }, "core-unknownmodule-ParameterSourceRef": { "type": "object", "properties": { "key": { "type": "string", "description": "der key f\u00fcr diesen Parameter" }, "caption": { "type": "string", "description": "die caption" }, "description": { "type": "string", "description": "die beschreibung" }, "unbounded": { "type": "boolean", "description": "ist es ein allgemeiner parameter" } }, "description": "Referenze auf eine Parameter-Klasse" }, "common-observer-PossibleSubscription": { "type": "object", "properties": { "refKey": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } } } }, "common-output-ReportTemplateResponse": { "type": "object", "properties": { "id": { "type": "integer", "description": "id der resource im DMS", "format": "int64", "readOnly": true }, "description": { "type": "string", "description": "Beschreibung", "readOnly": true }, "filename": { "type": "string", "description": "der Dateiname", "readOnly": true } } }, "common-output-OutputReportType": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "outputTypes": { "type": "array", "description": "Die Ausgabetypen f\u00fcr diesen ReportType", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "engine": { "type": "string", "description": "Druck-Techniken", "readOnly": true, "enum": [ "VQL_REPORTS", "JSON_REPORTS", "TEXT_ONLY" ] }, "systemPresetting": { "type": "boolean", "description": "Die verwendete Druck-Technik", "readOnly": true }, "label": { "type": "string", "description": "Kurzbezeichnung", "readOnly": true } } }, "common-output-OutputModuleInfo": { "type": "object", "properties": { "key": { "type": "string", "description": "output module key" }, "label": { "type": "string", "description": "output module label" }, "domainIdentifier": { "type": "string", "description": "Welcher Domain geh\u00f6rt dieses OutputModul an (wichtig f\u00fcr Platzhalter etc)", "readOnly": true }, "canCreateLayout": { "type": "boolean", "description": "gibt es eine m\u00f6glichkeit, neue Reports f\u00fcr diesen Druck zu hinterlegen", "readOnly": true, "default": false }, "sources": { "type": "array", "description": "welche neuanlage-modi werden unterst\u00fctzt", "readOnly": true, "items": { "type": "string", "description": "Report Quellen", "enum": [ "PARAMETER_MODE", "FILE_MODE" ] } }, "supportedOutputType": { "type": "array", "description": "welche Ausgabetypen werden unterst\u00fctzt", "readOnly": true, "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "default": false }, "subreportOnlyModule": { "type": "boolean", "description": "unterst\u00fctzt das Modul nur Subreports, bietet als keine eigene Druck-Implementierung", "readOnly": true, "default": false }, "supportOutputFilterScript": { "type": "boolean", "description": "unterst\u00fctzt das Modul Output-Filter-Scripte", "readOnly": true, "default": false }, "outputFilterScriptModule": { "type": "string", "description": "Script-Modul f\u00fcr Output-Filter scripte", "readOnly": true } } }, "common-fulltext-SearchEntryStatistics": { "type": "object", "properties": { "type": { "type": "string" }, "count": { "type": "integer", "format": "int64" } } }, "common-email-EmailContent": { "type": "object", "properties": { "html": { "type": "string", "description": "Inhalt-Html" }, "text": { "type": "string", "description": "Inhalt-Text" } }, "description": "content" }, "common-email-EmailList": { "type": "object", "properties": { "version": { "type": "string", "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": "type", "enum": [ "INBOUND", "OUTBOUND" ] }, "from": { "type": "string", "description": "Absender Email-Adresse" }, "fromPersonal": { "type": "string", "description": "Absender Vollname" }, "to": { "type": "string", "description": "Empf\u00e4nger" }, "cc": { "type": "string", "description": "CC" }, "bcc": { "type": "string", "description": "BCC" }, "subject": { "type": "string", "description": "Betreff" }, "content": { "$ref": "#/components/schemas/common-email-EmailContent" }, "attachmentObjectReferences": { "type": "string", "description": "Referenz zum Anhang" }, "state": { "type": "string", "description": "Stand dieser Email", "enum": [ "TO_DELIVER", "DELIVERED", "DELIVER_FAILED", "RECEIVED" ] } } }, "common-email-EmailFailure": { "type": "object", "properties": { "version": { "type": "string", "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", "enum": [ "BOUNCE", "COMPLAINT" ] }, "reason": { "type": "string", "description": "Grund f\u00fcr den Fehler" }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/common-email-EmailNotificationStatus" } }, "timestamp": { "type": "string", "description": "Zeitstempel", "format": "date-time" } } }, "common-email-EmailNotificationStatus": { "type": "object", "properties": { "status": { "type": "string" }, "action": { "type": "string" }, "diagnosticCode": { "type": "string" }, "emailAddress": { "type": "string" } }, "description": "Status" }, "common-data_import-MultiPartImportOrderedRuleSetExtensive": { "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "importRun": { "$ref": "#/components/schemas/common-data_import-DataImportRun" }, "step": { "type": "integer", "description": "Stufe, auf dem der Import-Run gestartet wird", "format": "int32" }, "fileName": { "type": "string", "description": "Datei, die f\u00fcr den Import verwendet wird" }, "ruleSet": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" }, "label": { "type": "string", "description": "Bezeichnung" } }, "description": "Import-Regelwerk und -Lauf nach Reihenfolge" }, "common-data_import-MultiPartImportRunExtensive": { "type": "object", "properties": { "version": { "type": "string", "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" }, "state": { "type": "string", "description": "Status", "enum": [ "CREATED", "EXTRACTING_DATA", "DATA_EXTRACTED", "RUNNING", "ERRONEOUS", "COMPLETED", "IGNORED", "DUMMY" ] }, "orderedRuleSets": { "type": "array", "description": "Import-Regelwerk und -Lauf nach Reihenfolge", "items": { "$ref": "#/components/schemas/common-data_import-MultiPartImportOrderedRuleSetExtensive" } }, "template": { "type": "boolean", "description": "Handelt es sich um eine Vorlage?", "default": false } } }, "common-data_import-BatchProcessingTargetFieldApi": { "type": "object", "properties": { "path": { "type": "string", "description": "f\u00fcr das Mapping relavanter Pfad" }, "displayName": { "type": "string", "description": "Anzeigename f\u00fcr das Feld" }, "dataType": { "$ref": "#/components/schemas/core-cunit-CuAttributeDataType" }, "constraint": { "$ref": "#/components/schemas/core-cunit-CuAttributeConstraint" }, "modelType": { "type": "string", "description": "dynamisches oder statisches Feld?", "enum": [ "STATIC", "DYNAMIC" ] } } }, "common-data_import-ImportModuleInformation": { "type": "object", "properties": { "startEntityIdentifier": { "type": "string", "description": "Haupt-Entity des Imports" }, "key": { "type": "string", "description": "Eindeutiger Schl\u00fcssel f\u00fcr eine Import-Art" }, "subgraphs": { "type": "array", "description": "Unter-Objekte, f\u00fcr die eine resolving strategy definiert werden kann", "items": { "$ref": "#/components/schemas/common-data_import-ResolvingStrategyInformation" } }, "supportsFileUpload": { "type": "boolean", "description": "Upload von zus\u00e4tzlichen Dateien m\u00f6glich?" }, "supportsValidation": { "type": "boolean", "description": "Wird der Validierungsschritt unterst\u00fctzt?" }, "type": { "type": "string", "enum": [ "ENTITY_IMPORT", "FILE_EXPORT" ] } } }, "common-data_import-ResolvingStrategyInformation": { "type": "object", "properties": { "path": { "type": "string", "description": "Pfad zum Objekt" }, "allowedStrategies": { "type": "array", "description": "erlaubte Strategien, um das Objekt zu erzeugen", "items": { "type": "string", "description": "erlaubte Strategien, um das Objekt zu erzeugen", "enum": [ "LOAD", "INSERT", "INSERT_FACTORY", "UPSERT", "UPDATE", "LOAD_OR_INSERT", "LOAD_OR_IGNORE" ] } } }, "description": "Unter-Objekte, f\u00fcr die eine resolving strategy definiert werden kann" }, "core-cunit-CuTemplateGroup": { "type": "object", "properties": { "key": { "type": "string", "description": "der group key" }, "label": { "type": "string", "description": "beschreibung der gruppe" } } }, "core-cunit-CuTemplate": { "type": "object", "properties": { "templateIdentifier": { "type": "string", "description": "das definierende Template" }, "label": { "type": "string", "description": "Bezeichnung des Templates" }, "group": { "$ref": "#/components/schemas/core-cunit-CuTemplateGroup" } } }, "common-cunit-QueryPresetValidationResult": { "type": "object", "properties": { "checkedPreset": { "$ref": "#/components/schemas/common-cunit-QueryPreset" }, "validationErrors": { "type": "array", "description": "The full list of validation problems", "items": { "$ref": "#/components/schemas/common-cunit-QueryValidationErrorDetail" } } } }, "common-cunit-QueryValidationErrorDetail": { "type": "object", "properties": { "path": { "type": "string", "description": "The path to the erroneous property" }, "type": { "type": "string", "description": "Where the property was used", "enum": [ "RESULT", "FILTER", "SORT", "TERM" ] } }, "description": "The full list of validation problems" }, "core-cunit-CuAttributes": { "type": "object", "properties": { "attributes": { "type": "array", "description": "attribute", "items": { "$ref": "#/components/schemas/core-cunit-CuAttribute" } } } }, "core-cunit-CuDialect": { "type": "object", "properties": { "functions": { "type": "array", "description": "Die Funktionen, die verwendet werden k\u00f6nnen", "readOnly": true, "items": { "$ref": "#/components/schemas/core-cunit-CuDialectFunctionRef" } }, "dataTypes": { "type": "array", "description": "Die Datentype, die im Standard vorhanden sind", "readOnly": true, "items": { "$ref": "#/components/schemas/core-cunit-CuAttributeDataType" } } } }, "core-cunit-CuDialectFunctionRef": { "type": "object", "properties": { "identifier": { "type": "string", "description": "der Function Identifier" }, "aggregate": { "type": "boolean", "description": "handelt es sich um eine Aggregat-Funktion", "readOnly": true, "default": false }, "messageCode": { "type": "string", "description": "localizeable Label", "readOnly": true } }, "description": "Die Funktionen, die verwendet werden k\u00f6nnen" }, "common-audit-SnapshotAndPredecessorApi": { "type": "object", "properties": { "current": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "previous": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "core-api-AfterTenantMigrationActionExecutionHistory": { "required": [ "className" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "className": { "type": "string", "description": "Name der \"Aktions\"-Klasse" } }, "description": "Historie der ausgef\u00fchrten einmaligen Aktionen, welche nach den DB-Migrationen ausgef\u00fchrt werden sollen" }, "node-nodemaster-AppManifestBase": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the Object", "readOnly": true, "example": "1" }, "createdAt": { "type": "string", "description": "Created At Timestamp", "format": "date-time", "readOnly": true }, "createdFrom": { "type": "string", "description": "TenantUser-Identifier of the creator", "readOnly": true }, "updatedAt": { "type": "string", "description": "Last Updated AT Timestamp", "format": "date-time", "readOnly": true }, "updatedFrom": { "type": "string", "description": "TenantUser-Identifier of most recent updater", "readOnly": true }, "version": { "type": "integer", "description": "Version of most recent updater", "format": "int64", "readOnly": true }, "identifier": { "type": "string", "description": "Unique Identifier of this CompanionApp", "format": "uuid" }, "label": { "type": "string", "description": "label / short description" }, "appVersion": { "type": "string", "description": "the latest version of this app" }, "privateApp": { "type": "boolean", "description": "is this a private app or published via the public app-store", "default": true }, "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-nodemaster-UiIntegrations" }, "requirements": { "$ref": "#/components/schemas/node-nodemaster-Requirements" }, "authorizationVerbs": { "type": "array", "description": "access rights this app needs", "items": { "$ref": "#/components/schemas/node-nodemaster-AuthorizationVerb" } } }, "description": "Manifest" }, "node-nodemaster-AuthorizationVerb": { "type": "object", "properties": { "verb": { "type": "string" }, "description": { "type": "string" }, "autoAppendable": { "type": "boolean" } }, "description": "access rights this app needs" }, "node-nodemaster-InstalledApp": { "type": "object", "properties": { "installedFrom": { "type": "integer", "description": "User Id", "format": "int64" }, "installedAt": { "type": "string", "description": "Installation-zeit", "format": "date-time" }, "appManifest": { "$ref": "#/components/schemas/node-nodemaster-AppManifestBase" } } }, "node-nodemaster-Requirements": { "type": "object", "properties": { "licenseKey": { "type": "string" }, "licenseKeys": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/node-nodemaster-RequirementsPermission" } } }, "description": "requirements this app needs" }, "node-nodemaster-RequirementsPermission": { "type": "object", "properties": { "resource": { "type": "string" }, "verb": { "type": "string" } } }, "node-nodemaster-UiIntegration": { "type": "object", "properties": { "id": { "type": "string" }, "permissionKey": { "type": "string" }, "pointOfIntegration": { "type": "string" }, "msgKey": { "type": "string" }, "url": { "type": "string" }, "iconClass": { "type": "string" }, "contextAttribute": { "type": "object", "additionalProperties": { "type": "object" } } } }, "node-nodemaster-UiIntegrations": { "type": "object", "properties": { "integrations": { "type": "array", "items": { "$ref": "#/components/schemas/node-nodemaster-UiIntegration" } } }, "description": "configuration of ui integrations" }, "banking-api-BankInitializerKey": { "required": [ "description", "key" ], "type": "object", "properties": { "key": { "type": "string", "description": "banking provider key", "enum": [ "FINAPI", "FINAPI_SANDBOX", "MOCKBANK" ] }, "description": { "type": "string", "description": "banking provider description" } } }, "banking-api-BankInitializerParameter": { "type": "object", "properties": { "key": { "type": "string" }, "type": { "type": "string", "enum": [ "STRING", "INTEGER", "BOOLEAN" ] }, "mandatory": { "type": "boolean" }, "defaultValue": { "type": "string" }, "description": { "type": "string" } } }, "node-event-CallStackElement": { "type": "object", "properties": { "method": { "type": "string" }, "duration": { "type": "integer", "format": "int64" }, "calls": { "type": "integer", "format": "int64" }, "statements": { "type": "array", "items": { "$ref": "#/components/schemas/node-event-CallStatementElement" } } } }, "node-event-CallStatementElement": { "type": "object", "properties": { "payload": { "type": "object" }, "duration": { "type": "integer", "description": "dauer dieses statements", "format": "int64" }, "calls": { "type": "integer", "description": "aufrufe dieses statements", "format": "int64" }, "type": { "type": "string", "description": "type dieses statements. kann frei vergeben werden" } } }, "node-event-ExceptionElement": { "type": "object", "properties": { "message": { "type": "string" }, "traces": { "type": "array", "items": { "type": "string" } }, "nested": { "$ref": "#/components/schemas/node-event-ExceptionElement" } } }, "node-event-SqlStatisticElement": { "type": "object", "properties": { "id": { "type": "string" }, "statement": { "type": "array", "items": { "type": "string" } }, "duration": { "type": "integer", "format": "int64" }, "calls": { "type": "integer", "format": "int64" } } }, "node-event-TraceDump": { "type": "object", "properties": { "key": { "type": "string" }, "dateTime": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "MIGRATION_ERROR", "ERROR", "TRACE" ] }, "userId": { "type": "string" }, "userName": { "type": "string" }, "tenantId": { "type": "string" }, "tenantSchema": { "type": "string" }, "traceActive": { "type": "boolean" }, "k8sNamespace": { "type": "string" }, "podName": { "type": "string" }, "httpMethod": { "type": "string" }, "httpUrl": { "type": "string" }, "httpUri": { "type": "string" }, "frontendPath": { "type": "string" }, "varioAgent": { "type": "string" }, "httpQuery": { "type": "string" }, "httpBodyContent": { "type": "string" }, "httpStatusCode": { "type": "integer", "format": "int32" }, "taskId": { "type": "string" }, "executionId": { "type": "string" }, "callStack": { "type": "array", "items": { "$ref": "#/components/schemas/node-event-CallStackElement" } }, "exception": { "type": "array", "items": { "$ref": "#/components/schemas/node-event-ExceptionElement" } }, "gitInfo": { "$ref": "#/components/schemas/node-event-TraceDumpGitInfo" }, "sqlStatistic": { "type": "array", "items": { "$ref": "#/components/schemas/node-event-SqlStatisticElement" } } } }, "node-event-TraceDumpGitInfo": { "type": "object", "properties": { "modules": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "branch": { "type": "string" }, "buildTime": { "type": "string" }, "buildVersion": { "type": "string" }, "commitId": { "type": "string" } } } } } }