{ "openapi": "3.1.0", "info": { "title": "OpenAPI definition", "version": "2026.36.3" }, "servers": [ { "url": "api.example.com" } ], "tags": [ { "name": "ATM", "description": "Aktionen nach den Tenant-Migrationen", "x-page-description": "View the history of one-time post-migration tenant actions via the VARIO Cloud REST API, including executed action classes." }, { "name": "Abrechnungsregeln zu Aktivitäten", "description": "Abrechnungsregeln zu CRM Aktivitäten", "x-page-description": "Manage CRM activity billing rules in VARIO Cloud via the REST API, including users, groups, activity types and billing article assignments." }, { "name": "Abschlußgründe zu Deals", "description": "CRM Deals: Abschlußgründe", "x-page-description": "Manage CRM deal closing reasons in VARIO Cloud via the API, including positive or negative outcomes, sorting, activation and custom descriptions." }, { "name": "AccountType", "description": "the available Account Types", "x-page-description": "Explore the VARIO Account Type API to retrieve available account types, including customers, suppliers, manufacturers, merchants, and sales agents." }, { "name": "Aktivitäten", "description": "CRM Aktivitäten", "x-page-description": "Manage CRM activities in VARIO Cloud via API, including creation, billing, email processing, workflow states, scheduling, updates, and deletion." }, { "name": "Aktivitätsarten", "description": "CRM Aktivitätsarten", "x-page-description": "Configure CRM activity types in VARIO Cloud via API, including billing, usage, email handling, publishing, activation and sorting." }, { "name": "Aktivitätstypen pro Benutzer", "description": "CRM Aktivitätstypen pro Benutzer", "x-page-description": "Configure user-specific CRM activity types and default billing settings in VARIO Cloud via API, with endpoints to create, update, retrieve and delete mappings." }, { "name": "AppMessage", "description": "App message queue entries", "x-page-description": "Connect VARIO Cloud apps through the App Message API to manage queue entries, register webhooks, and route events to configured destinations." }, { "name": "AppScriptingProxy", "description": "Scripting proxy configuration", "x-page-description": "Manage app scripting proxy configurations in VARIO Cloud, including triggers, scripts, script modules, execution, and CRUD operations via REST API." }, { "name": "AppSettings", "description": "settings for apps", "x-page-description": "Manage app settings via the VARIO Cloud REST API, including retrieving, creating, updating, and deleting settings by app identifier." }, { "name": "Article", "description": "the Article API", "x-page-description": "Manage articles via the VARIO Cloud REST API, including product data, taxes, components, listings, locks, workflows, and label printing." }, { "name": "ArticleActor", "description": "the Article Actor API" }, { "name": "ArticleCustomer", "description": "the Article Costumer API", "x-page-description": "Manage article-customer relations, including customer-specific product data, pricing, identifiers, and activation with the VARIO Cloud REST API." }, { "name": "ArticleStorage", "description": "Stock & Storage information of product", "x-page-description": "Access and manage article storage data in VARIO Cloud via API, including stock levels, availability, storage movements, replenishment and bundle conversions." }, { "name": "ArticleSupplier", "description": "the Article Supplier API", "x-page-description": "Configure article-supplier relations in VARIO Cloud via API, including supplier product data, prices, delivery times, order quantities, and labels." }, { "name": "Asset", "description": "Verwaltung der Assets", "x-page-description": "Use the VARIO Cloud Asset API to manage assets, asset types, warranties, serial numbers, relationships, copies and activation states." }, { "name": "Asset", "description": "Verwaltung der Assets-Typen", "x-page-description": "Use the VARIO Cloud Asset API to manage assets, asset types, warranties, serial numbers, relationships, copies and activation states." }, { "name": "Attributions", "description": "Verwaltet Verknüpfungen zwischen DMS-Resourcen und den Objekten aus dem ERP", "x-page-description": "Manage links between DMS resources and ERP objects in VARIO Cloud, including retrieval, creation, updates, publishing, and attribution settings via REST API." }, { "name": "Aufgaben", "description": "CRM Aufgaben", "x-page-description": "Manage CRM tasks in VARIO Cloud via API, including task creation, updates, reminders, workflows, relationships, billing and completion." }, { "name": "Bank", "description": "Banks and accounts", "x-page-description": "Manage banks and accounts in VARIO Cloud, including connections, authentication, account sync, transaction downloads, and CRUD operations via REST API." }, { "name": "BankInitializer", "description": "Bank-Initialisierung", "x-page-description": "Explore banking providers and their initialization parameters via the VARIO Cloud REST API, including keys, types, defaults, and requirements." }, { "name": "BankPayment", "description": "Zahlungen", "x-page-description": "Manage bank payments in VARIO Cloud via API, including payment records, statuses, validation, submission, authorization and account synchronization." }, { "name": "BankPaymentRun", "description": "Zahlungsvorschlag", "x-page-description": "Manage bank payment runs in VARIO Cloud, including creation, processing, cancellation, retrieval, open items, execution dates, and bank accounts." }, { "name": "BankTransactions", "description": "Transaktionen", "x-page-description": "Manage bank transactions in VARIO Cloud via API, including matching, reassignment, recalculation, manual booking and transaction status handling." }, { "name": "BankingBackend", "description": "Bankschnittstellen", "x-page-description": "Manage banking backends in VARIO Cloud via API, including app endpoints, backend types, transaction handling, payments, status checks and activation." }, { "name": "BankingProvider", "description": "Bankdienstleister", "x-page-description": "Manage banking providers in VARIO Cloud, including provider settings, parameters, user assignments, login checks, and provider creation via REST API." }, { "name": "BankingUser", "description": "Verwaltung der Bankbenutzer", "x-page-description": "Manage banking users in VARIO Cloud, including user creation, updates, replication, login checks, provider links, account assignment, and deletion." }, { "name": "BankingWebform", "description": "Bankautorisierungen", "x-page-description": "Manage banking webform authorizations in VARIO Cloud, including the deletion of existing banking authorization resources via the REST API." }, { "name": "Bestellvorschlag-zu-Bestellungen-Lauf", "description": "Bestellvorschlag-zu-Bestellungen-Lauf", "x-page-description": "Learn how to retrieve an order proposal-to-orders run by its identifier using the VARIO Cloud REST API, including response data and status information." }, { "name": "BusinessTransaction", "description": "the BusinessTransaction API", "x-page-description": "Manage business transactions via the VARIO Cloud REST API, including creating, retrieving, updating, and deleting transaction records." }, { "name": "CRM Abrechnungslauf", "description": "CRM Abrechnungslauf", "x-page-description": "Review CRM billing run results in VARIO Cloud via API, including run numbers, success status, log entries and generated billing documents." }, { "name": "Carrier", "description": "Shipping carriers", "x-page-description": "Configure shipping carriers in VARIO Cloud via the API, including carrier types, authentication parameters, tracking, labels, activation and updates." }, { "name": "CashDrawer", "description": "Kassenschubladen", "x-page-description": "Manage VARIO Cloud cash drawers via API, including creation, updates, activation, drawer states, and locking or unlocking for cash journal runs." }, { "name": "Category", "description": "Kategorien verwalten", "x-page-description": "Manage categories in VARIO Cloud via API, including creating, updating, deleting, activating, deactivating and organizing category hierarchies." }, { "name": "CategoryTree", "description": "Kategorie-Bäume verwalten", "x-page-description": "Manage category trees in VARIO Cloud, including child categories, labels, descriptions, activation, deactivation, and CRUD operations via the REST API." }, { "name": "CollectiveInvoiceRun", "description": "Sammelrechnungsläufe", "x-page-description": "Start and cancel collective invoice runs in VARIO Cloud, selecting accounts and delivery documents with filters, variables, IDs, and due dates." }, { "name": "CommissionAssignment", "description": "Provisionszuordnung", "x-page-description": "Manage commission assignments in VARIO Cloud, including sales agents, accounts, articles, product groups, validity periods, values, and currencies." }, { "name": "CommissionRun", "description": "Provisionslauf", "x-page-description": "Process and manage commission runs in VARIO Cloud via API, including single runs, status checks, exports, commits, reversals and sales agent periods." }, { "name": "CommodityCode", "description": "Commodity Code (SOVA)", "x-page-description": "Learn how to create, retrieve, update, delete, activate, and deactivate commodity codes using the VARIO Cloud REST API." }, { "name": "ContactType", "description": "the ContactType API", "x-page-description": "Manage VARIO Cloud contact types via API, including labels, communication types, activation, deactivation, updates, creation and deletion." }, { "name": "ContractAdditionalFunctions", "description": "Additional Contract Functions", "x-page-description": "Update contract due dates in VARIO Cloud via API, including current and next due dates, with validation hints and updated document data." }, { "name": "Cost Center", "description": "Kostenstellen FiBu", "x-page-description": "Manage cost centers in VARIO Cloud via API, including retrieving, creating, updating, and deleting finance cost center records." }, { "name": "CountryCode", "description": "the CountryCodes according to ISO-3166-1", "x-page-description": "Manage ISO 3166-1 country codes, names, activation status, regional address settings, languages, currencies, and dropdown visibility." }, { "name": "CountryRegion", "description": "the Region inside a Country e.g. Bundesländer", "x-page-description": "Manage country regions in VARIO Cloud via API, including ISO 3166-2 codes, regional identifiers, country assignments, activation and updates." }, { "name": "CreateTemplateGroups", "description": "Vorlagengruppen", "x-page-description": "Learn how to create, retrieve, update, and delete template groups using the VARIO Cloud REST API, including group details and assigned templates." }, { "name": "CreateTemplates", "description": "Vorlagen", "x-page-description": "Manage create templates in the VARIO Cloud REST API, including listing, retrieving, creating, updating, and deleting template resources." }, { "name": "CurrencyCode", "description": "the CurrencyCode according to ISO-4217", "x-page-description": "Manage ISO 4217 currency codes in VARIO Cloud via API, including creation, updates, activation, visibility settings, and deletion." }, { "name": "CurrencyExchangeRate", "description": "the exchange rates for currencies", "x-page-description": "Manage VARIO Cloud currency exchange rates, including source/target currencies, validity dates, comments, activation, creation, updates, and deletion." }, { "name": "CustomerGroup", "description": "the CustomerGroup API", "x-page-description": "Manage customer groups in VARIO Cloud via the API, including creation, updates, activation, deactivation and deletion." }, { "name": "CustomsMeasure", "description": "customs measures", "x-page-description": "Streamline multi-part imports in VARIO Cloud via API, managing rule sets, templates, execution, copies, run creation, and import status tracking." }, { "name": "Deals", "description": "CRM Deals", "x-page-description": "Manage VARIO Cloud CRM deals via API, including creation, updates, reminders, subscriptions, relationships, closing, and workflow status tracking." }, { "name": "DeliveryMethod", "description": "Liefermethoden", "x-page-description": "Manage delivery methods in VARIO Cloud via the REST API, including carriers, delivery times, parcel weights, country rules, activation and CRUD." }, { "name": "DeliveryTerm", "description": "Lieferbedingungen", "x-page-description": "Manage delivery terms in VARIO Cloud, including delivery methods, free shipping thresholds, COD fees, freight charges, translations, and activation." }, { "name": "Document", "description": "the Document API", "x-page-description": "Manage ERP documents, including creation, updates, state transitions, line items, validation, printing, locking, picking, shipments, and workflows." }, { "name": "Document Types", "description": "Resource managing the document types in our DMS(Shelf)", "x-page-description": "Manage VARIO Cloud DMS document types via the REST API, including storage duration, revision rules, access levels, activation, and CRUD operations." }, { "name": "DocumentAdditionalFunctions", "description": "Additional Document Functions", "x-page-description": "Manage VARIO document workflows via REST API: update tags, types and states, control delivery, unlock open items and process document lines." }, { "name": "DocumentType", "description": "Document-Types", "x-page-description": "Manage VARIO Cloud document types via API, including categories, states, transitions, follow-up types, numbering, activation, and configuration." }, { "name": "DocumentTypeChain", "description": "the Document API", "x-page-description": "Configure document type chains through the VARIO Cloud API to create, retrieve, update and delete predecessor and successor relationships." }, { "name": "Documents", "description": "Resource managing the Documents in our DMS(Shelf)", "x-page-description": "Manage documents in the VARIO Cloud DMS via API, including metadata, shares, file uploads, revisions, downloads, deletion states and document references." }, { "name": "Dunning", "description": "Mahnungen", "x-page-description": "Manage dunning notices, positions, fees, interest, printing, fixation, dissolution, and retrieve the highest dunning for an open item." }, { "name": "DunningLevel", "description": "Mahnstufe", "x-page-description": "Manage VARIO Cloud dunning levels via API, including due dates, fees, interest, currency, localized reminder texts, and level creation or updates." }, { "name": "DunningRun", "description": "Mahnlauf", "x-page-description": "Manage dunning runs via the VARIO Cloud REST API, including creation, printing, retrieval, fixation, dissolution, and deletion." }, { "name": "EavGroup", "description": "Management of individual Fields", "x-page-description": "Manage EAV groups and custom fields in VARIO Cloud, including attributes, entity assignments, usage checks, data removal, and CRUD operations via REST API." }, { "name": "Email", "description": "Email sending", "x-page-description": "Manage VARIO Cloud emails via API: retrieve messages, update delivery states, delete emails, and inspect bounce or complaint failure details." }, { "name": "FinanceBooking", "description": "the FinanceAccount API", "x-page-description": "Manage finance booking runs in VARIO Cloud via API, including ledger assignments, validation, commits, reversals and booking record checks." }, { "name": "FinanceBookingBackend", "description": "Finanzbuchhaltungen bearbeiten", "x-page-description": "Configure financial accounting backends in VARIO Cloud via API, including booking texts, date handling, activation, updates and deletion." }, { "name": "FiscalizationBackend", "description": "Fiskalisierungs-Schnittstellen", "x-page-description": "Manage fiscalization backends in VARIO Cloud, including Fiskaly integration, registration, test environments, activation, updates, and deletion." }, { "name": "FreeSequencer", "description": "Create and Manage Free to use Sequences", "x-page-description": "Create and manage custom number sequences in VARIO Cloud via the Free Sequencer API, including activation, configuration, preview and next-value retrieval." }, { "name": "FulltextSearch", "description": "Interface to our embedded Fulltext Search", "x-page-description": "Search VARIO Cloud data via API with full-text and phonetic search, filtering, grouping, index rebuilding and search type statistics." }, { "name": "Gesundheitsstatus zu Deals", "description": "CRM Deals: Gesundheitsstatus", "x-page-description": "Manage CRM deal health statuses in VARIO Cloud via API, including creation, updates, activation, deactivation, sorting, and deletion." }, { "name": "Group", "description": "Benutzergruppen", "x-page-description": "Manage user groups in VARIO Cloud via API, including roles, user assignments, activation, updates, creation and deletion for access organization." }, { "name": "HTTP Whitelist", "description": "Verwaltung der URL-Whitelist für den SecureHttpClient", "x-page-description": "Manage HTTP whitelist entries in VARIO Cloud for domains, URLs, and URL patterns, including creation, updates, deletion, activation, and deactivation." }, { "name": "IdentifierType", "description": "the IdentifierType API", "x-page-description": "Manage product identifier types in VARIO Cloud. Create, retrieve, update, delete, activate, and deactivate identifier types via the REST API." }, { "name": "Image Transformations", "description": "Manage transformations for image resource", "x-page-description": "Manage image transformations in the VARIO Cloud API, including resizing, rotation, watermarks, sharing, storage duration and file downloads." }, { "name": "ImportRuleSet", "description": "Import-Regelwerke", "x-page-description": "Manage VARIO Cloud import rule sets via API, including mappings, field and format settings, scripts, CSV/JSON/XML, parallel runs and workflow controls." }, { "name": "ImportRun", "description": "einzelne Importvorgänge", "x-page-description": "Manage VARIO Cloud import runs via the REST API, including states, data loading, validation, entry updates, execution, and supported file formats." }, { "name": "Inventory", "description": "Alles rund um die Inventur", "x-page-description": "Manage inventory workflows in VARIO Cloud via API, including inventory counts, state transitions, storage bins, revisions, and stock differences." }, { "name": "Lagerbereiche", "description": "Lagerbereiche zu Artikeln", "x-page-description": "Assign and manage article storage areas in VARIO Cloud via API, including retrieval, creation, updates, deletion and warehouse-specific storage mappings." }, { "name": "LanguageCode", "description": "The language code according to ISO-639-1", "x-page-description": "Configure ISO language codes in VARIO Cloud via API, including labels, ISO alpha-2 and alpha-3 values, activation status, and dropdown visibility." }, { "name": "LeasableLock", "description": "(Zeitlich begrenzbare) Sperren für Entitäten/Vorgänge", "x-page-description": "Manage temporary entity and process locks in the VARIO Cloud API, including listing, extending, and releasing locks manually or automatically." }, { "name": "Ledger", "description": "Fibukonten", "x-page-description": "Manage ledger accounts via the VARIO Cloud REST API, including creating, retrieving, updating, and deleting ledger numbers and labels." }, { "name": "LedgerAssignment", "description": "Fibukontenzuordnung", "x-page-description": "Manage ledger assignments, account mappings, tax settings, cost centers, and booking rules with the VARIO Cloud REST API." }, { "name": "LocalStorage", "description": "Local file storage (presigned URLs)", "x-page-description": "Use the VARIO Cloud API for local file storage with presigned URLs, including multipart uploads and secure file downloads." }, { "name": "Logs", "description": "Log Resource", "x-page-description": "Access and manage system log entries in VARIO Cloud via the REST API, including log levels, messages, request IDs, users and error details." }, { "name": "MainProductGroups", "description": "the IdentifierType API", "x-page-description": "Manage VARIO Cloud main product groups via API, including labels, descriptions, target trading margins, custom data, activation and deletion." }, { "name": "ManualEntry", "description": "Manual Booking Entries", "x-page-description": "Manage and review manual finance entries in VARIO Cloud via API, including transaction details, ledger data, cost centers, and booking reversals." }, { "name": "MatchingRules", "description": "The rules for matching openitems with transactions", "x-page-description": "Explore the VARIO Cloud REST API for managing matching rules, including rule types, scoring points, CRUD operations, and maximum point values." }, { "name": "MultiPartImport", "description": "mehrstufige Importvorgänge", "x-page-description": "Run and manage multi-part imports in VARIO Cloud via API, including ordered rule sets, templates, import runs, copies, status tracking, and execution." }, { "name": "OpenItem", "description": "the Finance OpenItem API", "x-page-description": "Manage VARIO Cloud open items via API, including due dates, payment terms, discounts, dunning, tags, balances, workflows, and transaction clearing." }, { "name": "OpenItemClosure", "description": "Offene Posten - Manueller Abschluss", "x-page-description": "Use the VARIO Cloud API to calculate, close, and reopen open items, including refunds, booking details, and delivery approval." }, { "name": "OpenItemDunning", "description": "Offene Posten - Mahngebühren/Mahnzinsen erfassen", "x-page-description": "Handle dunning fees and interest for open items in VARIO Cloud via API, including posting charges and reverting dunning records." }, { "name": "OpenItemPayment", "description": "Offene Posten - Zahlungen (Reimburse-/Übersicht-Operationen)", "x-page-description": "Manage open item reimbursements in VARIO Cloud via the REST API, creating bank payments and returning related processing messages." }, { "name": "OpenItemSynch", "description": "Umsatzabgleich", "x-page-description": "Streamline open item synchronization in VARIO Cloud via API, matching bank transactions, marking results and booking reconciled payments automatically." }, { "name": "OrderProposals", "description": "Bestellvorschläge", "x-page-description": "Manage order proposals in VARIO Cloud via API, including suppliers, proposal lines, ordering decisions, background generation and order creation." }, { "name": "Output-Consumer", "description": "Ausgabe-Systeme", "x-page-description": "Manage output consumers, print servers, push modes, output types, refresh requests, heartbeats, and output jobs with the VARIO Cloud REST API." }, { "name": "Output-Module", "description": "Ausgabe Module", "x-page-description": "Manage VARIO Cloud output modules via API, including reports, localizations, report groups, templates, parameters, activation and printing." }, { "name": "Output-Queue", "description": "Ausgabe-Warteschlange", "x-page-description": "Manage output queue tasks, retrieve task details, update processing states, and track output results with the VARIO Cloud REST API." }, { "name": "Output-Rule", "description": "Ausgabe-Regeln", "x-page-description": "Define and manage output rules in VARIO Cloud via API, including modules, report groups, consumers, quantities, priorities and system presets." }, { "name": "Parameter", "description": "manage unbound parameters", "x-page-description": "Manage unbound parameters and metadata in VARIO Cloud via API, including retrieval, updates, deletion, key-based queries and parameter definitions." }, { "name": "PaymentMethods", "description": "Zahlungsmethoden", "x-page-description": "Manage payment methods in VARIO Cloud via the REST API, including payment types, direct debits, open item closing, activation and translations." }, { "name": "PaymentPlan", "description": "Offene Posten - Zahlungspläne", "x-page-description": "Manage VARIO Cloud payment plans for open items: modify terms, convert invoices to payment plans, recalculate plans, and start payment plan runs." }, { "name": "PaymentTemplates", "description": "Zahlungsvorlagen", "x-page-description": "Streamline payment processing in VARIO Cloud with API-managed templates for invoices, credit notes, direct debits, defaults and payment fields." }, { "name": "PaymentTerms", "description": "Zahlungsbedingungen", "x-page-description": "Configure payment terms in VARIO Cloud via API, including payment types, discounts, net due dates, dunning blocks, credit limits and translations." }, { "name": "Payments", "description": "Zahlungen erfassen", "x-page-description": "Record and reverse payments in VARIO Cloud via API, linking open items, bank accounts, payment methods, discounts and dunning payments." }, { "name": "Picklisten", "description": "Picklisten", "x-page-description": "Streamline warehouse picking in VARIO Cloud with the Picklists API to create, process, print, cancel, and manage picking workflows." }, { "name": "Picklisten-Vorlagen", "description": "Picklisten-Vorlagen", "x-page-description": "Manage picklist templates, order selection, picking types, processing options, and warehouse picking workflows with the VARIO Cloud REST API." }, { "name": "Pickwagen", "description": "Pickwagen & Co.", "x-page-description": "Manage warehouse pick trolleys and boxes in VARIO Cloud, including assignments, states, barcode lookup, box generation and picking workflows." }, { "name": "Pickwagengruppen", "description": "Pickwagengruppen", "x-page-description": "Manage pick trolley groups in VARIO Cloud via API, including creating, updating, deleting, and assigning pick trolleys to groups." }, { "name": "PosDepositExpenseType", "description": "Einlagen-/Ausgabenarten", "x-page-description": "Manage POS deposit and expense types in VARIO Cloud. Create, retrieve, update, delete, activate, and deactivate deposit and expense types via REST API." }, { "name": "PosDocument", "description": "POS-Belege", "x-page-description": "Manage POS documents, cash journal openings and closings, balances, previews and TSS transaction cancellations via the VARIO Cloud API." }, { "name": "PosPayment", "description": "POS-Zahlungen verwalten", "x-page-description": "Retrieve POS payments by external payment ID and update their status, including processing, success, cancellation, rejection, and error details." }, { "name": "PosPaymentBackend", "description": "Kassenzahlungs-Backends bearbeiten", "x-page-description": "Manage POS payment backends in VARIO Cloud. Create, retrieve, update, delete, activate, and deactivate payment backends via the REST API." }, { "name": "PosPaymentConsumer", "description": "POS-Payment-Consumer verwalten", "x-page-description": "Manage POS payment consumers, including activation, heartbeats, refresh requests, and payment processing with the VARIO Cloud REST API." }, { "name": "PosPaymentMethod", "description": "Kassenzahlungsarten bearbeiten", "x-page-description": "Manage POS payment methods in VARIO Cloud, including creation, retrieval, updates, deletion, activation, and deactivation via the REST API." }, { "name": "PosPaymentRule", "description": "POS-Payment-Rules verwalten", "x-page-description": "Manage VARIO Cloud POS payment rules via the REST API, including payment methods, registers, sales channels, operations, and target consumers." }, { "name": "PosRegister", "description": "Kassen", "x-page-description": "Manage POS registers in VARIO Cloud via REST API, including TSS registration, DSFinV-K exports, payment methods, activation and register data." }, { "name": "PriceModifierTypes", "description": "Price modifier templates", "x-page-description": "Manage price modifier types in VARIO Cloud, including discount and surcharge templates, creation, retrieval, updates, and deletion." }, { "name": "Priorität zu Projekten", "description": "CRM Projekte: Prioritätsverwaltung", "x-page-description": "Manage VARIO Cloud CRM project priorities via API, including priority types, sorting, creation, updates, deletion, and retrieval." }, { "name": "Prioritäten zu Aufgaben", "description": "CRM Aufgaben: Prioritätsverwaltung", "x-page-description": "Manage CRM task priorities in VARIO Cloud via the REST API, including priority types, ordering, retrieval, creation, updates, and deletion." }, { "name": "Prioritäten zu Deals", "description": "CRM Deals: Prioritätsverwaltung", "x-page-description": "Manage CRM deal priorities via the VARIO Cloud API, including creating, retrieving, updating, deleting and reordering priorities such as CRITICAL, NORMAL and LOW." }, { "name": "Product", "description": "Artikel kopieren", "x-page-description": "Manage product data in the VARIO Cloud API, including product settings, bundles, variants, suppliers, customers, copying and unit price conversion." }, { "name": "Product-Variant", "description": "the Product-Variant API", "x-page-description": "Manage product variants via the VARIO Cloud REST API, including creating variants, updating fields, and retrieving schemas and combinations." }, { "name": "ProductGroups", "description": "the IdentifierType API", "x-page-description": "Manage product groups in VARIO Cloud, including names, descriptions, main groups, customs tariff numbers, trading margins, activation, and deletion." }, { "name": "ProductPriceGroups", "description": "The ProductPriceGroup API", "x-page-description": "Organize product price groups in VARIO Cloud via API to create, retrieve, update and delete pricing group labels and descriptions." }, { "name": "ProductPrices", "description": "The Product Price API", "x-page-description": "Explore the VARIO Product Price API to manage sales and purchase prices, discounts, price rules, calculations, and product pricing data." }, { "name": "Produktion", "description": "Funktionen zur Verarbeitung von Produktionsbelegen", "x-page-description": "Streamline production processes in VARIO Cloud with API endpoints for producing, reverting, and managing fabrication orders and components." }, { "name": "Projekt-Phasen", "description": "CRM Projekt-Phasen", "x-page-description": "Structure CRM project phases in VARIO Cloud via API, including creating, updating, activating, deactivating, deleting and reordering phases." }, { "name": "Projekte", "description": "CRM Projekte", "x-page-description": "Manage CRM projects in VARIO Cloud via API, including project data, reminders, subscriptions, workflows, billing, and parent-child relations." }, { "name": "PurgeMovementData", "description": "Purges all movement data in the application", "x-page-description": "Purge all movement data in the application using the VARIO Cloud REST API and the dedicated purge movement records endpoint." }, { "name": "RMA", "description": "Funktionen zur Verarbeitung von Retouren", "x-page-description": "Manage returns and goods exchanges in VARIO Cloud with the RMA API to identify returnable lines and transfer replacements to customer or shipping orders." }, { "name": "Recommended Retail Price", "description": "RecommendedRetailPrice API", "x-page-description": "Manage recommended retail prices for VARIO Cloud articles via API, including country, currency and price values, with create, read, update and delete." }, { "name": "Replenishment", "description": "Replenishment proposals", "x-page-description": "Use the VARIO Cloud API to manage warehouse replenishment proposals and templates, control stock transfers, quantities, processing, printing, and status." }, { "name": "Retouren-Handling", "description": "Retouren-Annahme und Verarbeitung", "x-page-description": "Process returns in VARIO Cloud via API, from receiving scans and matching documents to validating items, quantities, return causes and processing steps." }, { "name": "ReturnCauses", "description": "the ReturnCause API", "x-page-description": "Manage return causes in VARIO Cloud, including creation, retrieval, updates, deletion, activation, deactivation, barcodes, labels, and return rules." }, { "name": "ReturnGroups", "description": "the ReturnGroup API", "x-page-description": "Configure return groups for customer and supplier returns in VARIO Cloud via API, including labels, barcodes, product groups, and status." }, { "name": "Role", "description": "Benutzerrollen", "x-page-description": "Manage user roles, permissions, DMS access levels, activation, and CRUD operations with the VARIO Cloud REST API." }, { "name": "SalesChannel", "description": "Verkaufskanäle bearbeiten", "x-page-description": "Manage sales channels in VARIO Cloud via API, including channel types, storage assignments, pricing, fiscalization, TSS operations, and backend settings." }, { "name": "Scanbare-Code-Erkennung", "description": "Erkennung von scanbaren Codes (z.B. nach GS1-, HIBC- und anderen Standards", "x-page-description": "Manage scannable code recognition in VARIO Cloud, including GS1, HIBC, and common codes, article identification, storage bins, and code details." }, { "name": "Scenario", "description": "Statistic scenarios", "x-page-description": "Manage VARIO Cloud statistic scenarios via API, including setup, activation, rebuilding, dimensions, facts, and desired or actual values." }, { "name": "Scripting", "description": "Script management", "x-page-description": "Access scripting modules, TypeScript declarations, run logs and deprecation data through the VARIO Cloud Scripting API." }, { "name": "Scripting", "description": "Script deprecation logs", "x-page-description": "Access scripting modules, TypeScript declarations, run logs and deprecation data through the VARIO Cloud Scripting API." }, { "name": "Secret Storage", "description": "Verwaltung von Secrets (Passwörter, API-Keys, Tokens)", "x-page-description": "Manage VARIO Cloud secrets via API, including passwords, API keys and tokens, with create, update, retrieve and delete operations by ID or name." }, { "name": "Sequencer", "description": "Monitoring and configuration of sequencers and sequence pools", "x-page-description": "Manage VARIO Cloud sequencers via API, including configuration, sequence pools, reinitialization, and retrieval of next, last, and current sequence values." }, { "name": "SerialNumber", "description": "Serial numbers of articles", "x-page-description": "Manage article serial numbers in VARIO Cloud, including CRUD operations, expiry dates, UDI data, notes, and GS1 or HIBC code processing via REST API." }, { "name": "ShelfPublicAccess", "description": "Public access to DMS documents", "x-page-description": "Provide public access to VARIO DMS documents by resolving a public document ID to an alternate download location." }, { "name": "Shipment", "description": "the shipment API", "x-page-description": "Explore the VARIO Cloud Shipment API to create, update, validate and manage shipments, parcels, carrier labels, tracking data and shipping details." }, { "name": "Sichtbarkeit von CRM-Deals", "description": "CRM Deals: Sichtbarkeit", "x-page-description": "Manage CRM deal visibility and read permissions, including bulk updates and user-specific access, with the VARIO Cloud REST API." }, { "name": "Skript-Modul", "description": "Skript-Modul", "x-page-description": "Manage scripting modules in VARIO Cloud, including scripts, domains, parameters, permissions, presettings, creation, updates, and deletion." }, { "name": "Skript-Modul-Gruppe", "description": "Skript-Modul-Gruppe", "x-page-description": "Organize scripting modules in VARIO Cloud via API by creating, updating, retrieving, and deleting module groups linked to apps and module references." }, { "name": "Status zu Aufgaben", "description": "CRM Aufgaben: Statusverwaltung", "x-page-description": "Manage CRM task statuses, including ordering, start/end states, billing readiness, comment requirements, activation, and CRUD operations." }, { "name": "Status zu Deals", "description": "CRM Deals: Statusverwaltung", "x-page-description": "Manage CRM deal statuses in VARIO Cloud via API, including creation, updates, activation, ordering, billing readiness and completion rules." }, { "name": "Status zu Projekten", "description": "CRM Projekte: Statusverwaltung", "x-page-description": "Manage CRM project statuses in VARIO Cloud via API, including creating, updating, deleting, activating, deactivating and reordering project states." }, { "name": "Stocks", "description": "Lagerbuchungen", "x-page-description": "Automate warehouse operations in VARIO Cloud with APIs for stock transfers, manual movements, purchase-price corrections, serial numbers, bulk transfers and stock-journal queries." }, { "name": "Storage", "description": "Lager", "x-page-description": "Manage storages and storage bins, including configuration, availability, activation, and warehouse operations with the VARIO Cloud REST API." }, { "name": "StorageArea", "description": "Lagerbereiche", "x-page-description": "Manage storage areas and storage bins in VARIO Cloud, including configuration, availability settings, filtering, assignment, and removal via REST API." }, { "name": "SupplierGroup", "description": "the SupplierGroup API", "x-page-description": "Manage supplier groups in the VARIO Cloud API, including creation, updates, retrieval, activation, deactivation, and deletion." }, { "name": "System", "description": "System Resource", "x-page-description": "Manage system resources in VARIO Cloud, including retrieval of system messages, license keys, and license validity information via the REST API." }, { "name": "Tags", "description": "Tags", "x-page-description": "Manage VARIO Cloud tags via the REST API, including tag types, labels, colors, groups, and CRUD operations across ERP, CRM, and DMS." }, { "name": "Task", "description": "Task for Batch Processing", "x-page-description": "Manage VARIO Cloud batch-processing tasks via API, including scheduling, execution, cancellation, status tracking, logs, and support tasks." }, { "name": "TaxEwuDeliveryLimits", "description": "this resource manage the EWU delivery limits", "x-page-description": "Manage EWU delivery limits in the VARIO Cloud REST API, including retrieval, creation, updates, deletion, validity dates, and exceeded status." }, { "name": "TaxRates", "description": "the tax rate of a country", "x-page-description": "Manage tax rates in VARIO Cloud, including country-specific rates, validity dates, tax types, creation, updates, activation, and deletion." }, { "name": "TaxSchemas", "description": "definies a mapping between a key/label an country dependent tax-rates", "x-page-description": "Manage tax schemas in VARIO Cloud, including country-specific tax mappings, default tax types, creation, updates, activation, and deletion." }, { "name": "TaxSelect", "description": "A tax rate by selection", "x-page-description": "Select the applicable VARIO Cloud tax rate using article, country and date criteria, or retrieve the tax rate associated with a specific tax schema." }, { "name": "TenantApp", "description": "Tenant applications", "x-page-description": "Manage VARIO Cloud tenant apps via the REST API, including token issuance, refresh, permissions, installed apps, status, settings, and app domains." }, { "name": "Text", "description": "Text-Parameter Resource", "x-page-description": "Manage multilingual text translations and variable domains in VARIO Cloud via API, including creating, updating, deleting and retrieving text resources." }, { "name": "TextTemplate", "description": "Textbausteine", "x-page-description": "Use the VARIO Cloud API to create and manage text templates, localized content, document positions, UI hints, sales channels, and reusable text blocks." }, { "name": "Themen zu Deals", "description": "CRM Deals: Themen", "x-page-description": "Manage CRM deal topics in VARIO Cloud via API, including creating, updating, sorting, activating, deactivating and deleting deal topics." }, { "name": "ThirdPartyInfo", "description": "Third-party license information", "x-page-description": "Retrieve third-party license information for VARIO Cloud via API, including group IDs, artifact IDs, versions and associated software licenses." }, { "name": "Trace", "description": "Trace data (development)", "x-page-description": "Access VARIO Cloud trace data via the REST API, including trace keys, errors, HTTP details, call stacks, Git info, and SQL statistics." }, { "name": "Typen von Aufgaben", "description": "CRM Aufgaben: Verwaltung von Typen", "x-page-description": "Use the VARIO Cloud API to manage CRM task types, including creation, updates, ordering, activation, deactivation, listing, deletion, and sorting via REST." }, { "name": "Typen von Deals", "description": "CRM Deals: Verwaltung von Typen", "x-page-description": "Manage CRM deal types, including creation, updates, activation, deactivation, deletion, ordering, and retrieval with the VARIO Cloud REST API." }, { "name": "Typen von Projekten", "description": "CRM Projekte: Verwaltung von Typen", "x-page-description": "Use the VARIO Cloud API to manage CRM project types: create, edit, sort, activate, deactivate, and delete types for flexible, structured CRM workflows now." }, { "name": "Ui-Einstellungen", "description": "Verwaltung von UI-Einstellungen", "x-page-description": "Manage UI settings in VARIO Cloud, including categories, keys, permissions, mandatory user or group assignments, values, creation, updates, and deletion." }, { "name": "Umlagerung", "description": "Umlagerung", "x-page-description": "Process stock transfers in VARIO Cloud via API, handling scans, quantities, storage bins, pick trolleys, serial numbers and transit stock movements." }, { "name": "UnitType", "description": "the UnitType API", "x-page-description": "Define and manage unit types in VARIO Cloud via API, including names, abbreviations, categories, UNECE references, updates, and deletion." }, { "name": "UnitTypeRatio", "description": "the UnitTypeRatio API", "x-page-description": "Manage unit type ratios and convert values between units with the VARIO Cloud REST API, including creation, updates, deletion, and conversion." }, { "name": "User", "description": "Benutzer", "x-page-description": "Manage users in VARIO Cloud via the REST API, including user data, permissions, settings, signatures, favorites, activation and deactivation." }, { "name": "User Message", "description": "the user message API", "x-page-description": "Manage user messages via the VARIO Cloud REST API, including sending, updating, marking as seen, deleting messages, and retrieving message counts." }, { "name": "UserDescription", "description": "the UserDescription API", "x-page-description": "Manage VARIO Cloud user details via the REST API, including account links, default and current locations, custom fields, and CRUD operations." }, { "name": "VariantAttribute", "description": "Variantenattribute", "x-page-description": "Manage variant attributes and values in VARIO Cloud, including multilingual labels, activation, units, sorting, and CRUD operations via the REST API." }, { "name": "VariantAttributeListing", "description": "Listings für Variantenattribute", "x-page-description": "Manage variant attribute listings and sales channel assignments, including creating, updating, retrieving, and deleting data via the VARIO Cloud REST API." }, { "name": "VariantSchema", "description": "Variantenschemas", "x-page-description": "Manage variant schemas in VARIO Cloud: create, update, activate, deactivate, delete, and retrieve assigned variant attributes." }, { "name": "VariantValueListing", "description": "Listings für Variantenattributwerte", "x-page-description": "Manage variant attribute value listings and their sales-channel assignments, including creating, retrieving, updating, partially updating, and deleting listings." }, { "name": "Verkaufskanal-Lagerzuordnung", "description": "Vorlagen für Verkaufskanal-Lagerzuordnung", "x-page-description": "Use the VARIO Cloud API to manage sales channel storage mappings, including creating, updating, activating, deactivating and deleting schemas." }, { "name": "Versandkosten", "description": "Versandkosten", "x-page-description": "Configure shipping costs by method, terms, country, postcode, parcel count and weight with the VARIO Cloud API for flexible delivery pricing." }, { "name": "WebSocket", "description": "WebSocket token", "x-page-description": "Generate WebSocket tokens via the VARIO Cloud REST API, including user, tenant, token key, and token information for authenticated connections." }, { "name": "WorkItem", "description": "for user interaction with workflows", "x-page-description": "Manage workflow work items, including assignment, unassignment, input submission, and user decisions with the VARIO Cloud REST API." }, { "name": "Workflow", "description": "the workflow API", "x-page-description": "Build and manage workflows in VARIO Cloud via API, including triggers, elements, scripts, savepoints, imports, exports, and activation." }, { "name": "WorkflowInstance", "description": "the workflow instance API", "x-page-description": "Manage VARIO Cloud workflow instances: view status, work items and logs, resume or kill runs, and retrieve latest instances or query presets by reference." }, { "name": "account", "description": "the Account API", "x-page-description": "Manage accounts in VARIO Cloud, including addresses, contacts, bank details, relations, listings, duplicates, output rules, and account updates." }, { "name": "bundle schema", "description": "the bundle schema API", "x-page-description": "Configure product bundle schemas, unit ratios and templates in VARIO Cloud through the Bundle Schema API." }, { "name": "computed-queries", "description": "request to our CUnitTemplates", "x-page-description": "Manage computed queries, presets, report groups, workflow presets, fields, validation, execution, and exports with the VARIO Cloud REST API." }, { "name": "datamarts", "description": "request to our datamarts", "x-page-description": "Update VARIO Cloud datamarts, including sales facts and dimensions, with options for full recalculation and synchronization via the REST API." }, { "name": "dataseries", "description": "request resource to our datamarts", "x-page-description": "Use the VARIO Cloud API to list available data series and query time-series data from datamarts with configurable grouping, time slices, and filters." }, { "name": "discount group", "description": "the Discount Group API", "x-page-description": "Configure discount groups and rules in VARIO Cloud with the API, including percentage or fixed discounts, quantities, price groups and currencies." }, { "name": "eingeplante Importe", "description": "zum Planen von periodisch auszuführenden Importen", "x-page-description": "Scheduled Imports in VARIO: Plan, configure, and automate recurring imports and exports using the REST API." }, { "name": "salutation", "description": "the salutation API", "x-page-description": "Manage salutations via the VARIO Cloud REST API, including creating, retrieving, updating, deleting, activating, and deactivating records." }, { "name": "variant attribute assignment config", "description": "ERP-Konfiguration für Varianten-Attributzuordnungen (Gebinde)", "x-page-description": "Manage ERP variant attribute assignment configurations, including bundle attributes and CRUD operations, via the VARIO Cloud REST API." }, { "name": "Änderungsprotokoll", "description": "API für den Zugriff auf's Änderungsprotokoll", "x-page-description": "Access VARIO audit-log snapshots and compare the current state of a record with its previous version." } ], "paths": { "/wms/replenishment-proposal/{id}": { "get": { "tags": [ "Replenishment" ], "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": [ "Replenishment" ], "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" } } } } } }, "delete": { "tags": [ "Replenishment" ], "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/{id}/print": { "put": { "tags": [ "Replenishment" ], "operationId": "printProposal", "parameters": [ { "name": "id", "in": "path", "description": "ID des Nachschubvorschlags", "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/replenishment-proposal/{id}/line/{lineId}": { "put": { "tags": [ "Replenishment" ], "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": [ "Replenishment" ], "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": [ "Replenishment" ], "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": [ "Replenishment" ], "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": [ "Replenishment" ], "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": [ "Replenishment" ], "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/replenishment-proposal/template/{id}/deactivate": { "put": { "tags": [ "Replenishment" ], "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": [ "Replenishment" ], "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_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/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_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/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_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-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_4", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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_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-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_6", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/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_5", "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": [ "LocalStorage" ], "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/variant/value-listing/{id}": { "get": { "tags": [ "VariantValueListing" ], "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/erp-sales_channel-VariantValueListing" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "VariantValueListing" ], "summary": "Update existing Resource ", "operationId": "update_7", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantValueListing" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantValueListing" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "VariantValueListing" ], "summary": "Delete an existing Resource", "operationId": "delete_6", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/variant/attribute-listing/{id}": { "get": { "tags": [ "VariantAttributeListing" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_8", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantAttributeListing" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "VariantAttributeListing" ], "summary": "Update existing Resource ", "operationId": "update_8", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantAttributeListing" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantAttributeListing" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "VariantAttributeListing" ], "summary": "Delete an existing Resource", "operationId": "delete_7", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/variant-attribute-assignment-config/{id}": { "get": { "tags": [ "variant attribute assignment config" ], "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-product-VariantAttributeAssignmentConfig" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "variant attribute assignment config" ], "summary": "Update existing Resource ", "operationId": "update_9", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-VariantAttributeAssignmentConfig" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-VariantAttributeAssignmentConfig" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "variant attribute assignment config" ], "summary": "Delete an existing Resource", "operationId": "delete_8", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/user-details/{id}": { "get": { "tags": [ "UserDescription" ], "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-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_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-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_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/text-templates/{id}": { "get": { "tags": [ "TextTemplate" ], "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-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_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-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_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/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_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-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_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-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_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/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_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-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_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-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_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/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_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-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_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-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_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/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_15", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/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_15", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-Storage" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-Storage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Storage" ], "summary": "Delete an existing Resource", "operationId": "delete_14", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "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ührt dem Etikettendruck zu gegebenen Lagerplätzen durch", "operationId": "printLabels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-StorageBinLabelPrintRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/erp/storage-areas/{id}": { "get": { "tags": [ "StorageArea" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_16", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-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_16", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-StorageArea" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-StorageArea" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "StorageArea" ], "summary": "Delete an existing Resource", "operationId": "delete_15", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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_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-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_17", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-SalesChannelStorageSchema" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-SalesChannelStorageSchema" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Verkaufskanal-Lagerzuordnung" ], "summary": "Delete an existing Resource", "operationId": "delete_16", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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/rma/return-groups/{id}": { "get": { "tags": [ "ReturnGroups" ], "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": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnGroup" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "ReturnGroups" ], "summary": "Update existing Resource ", "operationId": "update_18", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnGroup" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "ReturnGroups" ], "summary": "Delete an existing Resource", "operationId": "delete_17", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/rma/return-groups/{id}/deactivate": { "put": { "tags": [ "ReturnGroups" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_7", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnGroup" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/rma/return-groups/{id}/activate": { "put": { "tags": [ "ReturnGroups" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_7", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnGroup" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/rma/return-causes/{id}": { "get": { "tags": [ "ReturnCauses" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_19", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnCause" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "ReturnCauses" ], "summary": "Update existing Resource ", "operationId": "update_19", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnCause" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnCause" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "ReturnCauses" ], "summary": "Delete an existing Resource", "operationId": "delete_18", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/rma/return-causes/{id}/deactivate": { "put": { "tags": [ "ReturnCauses" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_8", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnCause" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/rma/return-causes/{id}/activate": { "put": { "tags": [ "ReturnCauses" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_8", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnCause" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/recommended-retail-price/{id}": { "get": { "tags": [ "Recommended Retail Price" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-RecommendedRetailPrice" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Recommended Retail Price" ], "summary": "Update existing Resource ", "operationId": "update_20", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-RecommendedRetailPrice" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-RecommendedRetailPrice" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Recommended Retail Price" ], "summary": "Delete an existing Resource", "operationId": "delete_19", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/products/{id}": { "put": { "tags": [ "Product" ], "summary": "Update existing Resource ", "operationId": "update_21", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-Product" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Product" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Product" ], "summary": "Delete an existing Resource", "operationId": "delete_20", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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/product-types/product-price-groups/{id}": { "get": { "tags": [ "ProductPriceGroups" ], "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-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_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-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_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/product-groups/{id}": { "get": { "tags": [ "ProductGroups" ], "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-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_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-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_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/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_9", "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_9", "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_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-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_24", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductMainGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductMainGroup" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "MainProductGroups" ], "summary": "Delete an existing Resource", "operationId": "delete_23", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/product-types/main-product-groups/{id}/deactivate": { "put": { "tags": [ "MainProductGroups" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_10", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductMainGroup" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-types/main-product-groups/{id}/activate": { "put": { "tags": [ "MainProductGroups" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_10", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductMainGroup" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-types/identifier-types/{id}": { "get": { "tags": [ "IdentifierType" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_24", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-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_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-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_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/product-types/identifier-types/{id}/deactivate": { "put": { "tags": [ "IdentifierType" ], "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-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_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-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_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-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_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-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_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/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_26", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/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_27", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-PriceModifierTemplate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-PriceModifierTemplate" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "PriceModifierTypes" ], "summary": "Delete an existing Resource", "operationId": "delete_26", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/pos/register/{posRegisterId}/tss/upsert": { "put": { "tags": [ "PosRegister" ], "summary": "Kasse beim Finanzamt melden (DSFinV-K)", "operationId": "upsert", "parameters": [ { "name": "posRegisterId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/pos/register/{posRegisterId}/tss/register": { "put": { "tags": [ "PosRegister" ], "summary": "Kasse an TSS registrieren", "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" ], "summary": "Kasse von TSS abmelden", "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_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-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_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-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_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/pos/register/{id}/deactivate": { "put": { "tags": [ "PosRegister" ], "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-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_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-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_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-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_29", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-FiscalizationBackend" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-FiscalizationBackend" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "FiscalizationBackend" ], "summary": "Delete an existing Resource", "operationId": "delete_28", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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_13", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-FiscalizationBackend" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/fiscalization/backend/{id}/activate": { "put": { "tags": [ "FiscalizationBackend" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_13", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-FiscalizationBackend" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/documents/tss-transactions/{id}/cancel": { "put": { "tags": [ "PosDocument" ], "summary": "Versucht eine TSS-Transaktion zu stornieren.", "operationId": "cancelTransaction", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/pos/depositExpenseType/{id}": { "get": { "tags": [ "PosDepositExpenseType" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_29", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-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_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-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_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/pos/depositExpenseType/{id}/deactivate": { "put": { "tags": [ "PosDepositExpenseType" ], "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-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_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-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_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-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_31", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-CashDrawer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-CashDrawer" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "CashDrawer" ], "summary": "Delete an existing Resource", "operationId": "delete_30", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/pos/cash-drawer/{id}/deactivate": { "put": { "tags": [ "CashDrawer" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_15", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-CashDrawer" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/cash-drawer/{id}/activate": { "put": { "tags": [ "CashDrawer" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_15", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-CashDrawer" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/payments/terms/{id}": { "get": { "tags": [ "PaymentTerms" ], "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-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_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-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_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/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_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-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_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-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_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-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_33", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentTemplate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentTemplate" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "PaymentTemplates" ], "summary": "Delete an existing Resource", "operationId": "delete_32", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/payments/methods/{id}": { "get": { "tags": [ "PaymentMethods" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_33", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-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_34", "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_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/payments/methods/{id}/deactivate": { "put": { "tags": [ "PaymentMethods" ], "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-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_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-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_34", "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_35", "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_34", "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": "Ändert Stammdaten am Offenen Posten wie Mahnsperre", "operationId": "update_36", "parameters": [ { "name": "openItemId", "in": "path", "description": "openItem Identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemChangeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItem" } } } } } } }, "/erp/finance/openitems/paymentplan/{openItemId}/change_paymentplan": { "put": { "tags": [ "PaymentPlan" ], "description": "Ändert einen Zahlungsplan", "operationId": "update_37", "parameters": [ { "name": "openItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-PaymentPlanChangeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemPaymentPlan" } } } } } } }, "/erp/finance/openitems/matchingrules/{id}": { "get": { "tags": [ "MatchingRules" ], "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-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_38", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemMatchingRule" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemMatchingRule" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "MatchingRules" ], "summary": "Delete an existing Resource", "operationId": "delete_35", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitems/additional-functions/{openItemId}/UpdateTags": { "put": { "tags": [ "OpenItem" ], "summary": "Update Tags", "operationId": "setOpenItemTags", "parameters": [ { "name": "openItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItem" } } } } } } }, "/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_36", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-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_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-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_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/ledger-assignment/{id}": { "get": { "tags": [ "LedgerAssignment" ], "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-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_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-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_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/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/dunnings/{id}": { "get": { "tags": [ "Dunning" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_38", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-Dunning" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Dunning" ], "operationId": "updateDunning", "parameters": [ { "name": "id", "in": "path", "description": "dunning identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-Dunning" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-Dunning" } } } } } }, "delete": { "tags": [ "Dunning" ], "operationId": "deleteDunning", "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/dunnings/{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/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_levels/{id}": { "get": { "tags": [ "DunningLevel" ], "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": { "*/*": { "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_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-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_38", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/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_levels/{id}/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_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/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_42", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-CostCenter" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-CostCenter" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Cost Center" ], "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/finance/business_transaction/{id}": { "get": { "tags": [ "BusinessTransaction" ], "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-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_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-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_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/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/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ängert eine Sperre", "operationId": "refreshLeasableLock", "parameters": [ { "name": "id", "in": "path", "description": "ID der gesperrten Resource", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lockToken", "in": "path", "description": "Token der zu verlängernden Sperre", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "leasePeriod", "in": "query", "description": "Optionale Lease-Dauer in Sekunden", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } }, "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": { "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true } } }, "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 ändern", "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 ändern", "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ür Belegposition ändern", "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ür Belegposition löschen", "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 ändern", "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_42", "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_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-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_41", "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_18", "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_18", "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_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/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_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-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_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/delivery/terms/{id}": { "get": { "tags": [ "DeliveryTerm" ], "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": { "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_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-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_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/delivery/terms/{id}/deactivate": { "put": { "tags": [ "DeliveryTerm" ], "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-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_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-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_45", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-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_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-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_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/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_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/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_48", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Typen von 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/types/{id}/deactivate": { "put": { "tags": [ "Typen von Aufgaben" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_20", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-tasks/types/{id}/activate": { "put": { "tags": [ "Typen von Aufgaben" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_20", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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_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-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_49", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmState" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmState" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Status zu Aufgaben" ], "summary": "Delete an existing Resource", "operationId": "delete_46", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/crm-tasks/states/{id}/deactivate": { "put": { "tags": [ "Status zu Aufgaben" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_21", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmState" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-tasks/states/{id}/activate": { "put": { "tags": [ "Status zu Aufgaben" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_21", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmState" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-tasks/priorities/{id}": { "get": { "tags": [ "Prioritäten zu Aufgaben" ], "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-crm-CrmPriority" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Prioritäten zu Aufgaben" ], "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-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äten zu Aufgaben" ], "summary": "Delete an existing Resource", "operationId": "delete_47", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/crm-tasks/priorities/{crmTaskPriorityId}/move/{position}": { "put": { "tags": [ "Prioritäten 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_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-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_51", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Typen von 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/types/{id}/deactivate": { "put": { "tags": [ "Typen von Projekten" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_22", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-projects/types/{id}/activate": { "put": { "tags": [ "Typen von Projekten" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_22", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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_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-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_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-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_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/states/{id}/deactivate": { "put": { "tags": [ "Status zu Projekten" ], "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-projects/states/{id}/activate": { "put": { "tags": [ "Status zu Projekten" ], "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-projects/priorities/{id}": { "get": { "tags": [ "Priorität zu Projekten" ], "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-CrmPriority" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Priorität zu Projekten" ], "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-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ät zu Projekten" ], "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-projects/priorities/{crmProjectPriorityId}/move/{position}": { "put": { "tags": [ "Priorität 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_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-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_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-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_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-projects/phases/{id}/deactivate": { "put": { "tags": [ "Projekt-Phasen" ], "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-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_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-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_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-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_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-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_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/types/{id}": { "get": { "tags": [ "Typen von Deals" ], "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 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-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_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/types/{id}/deactivate": { "put": { "tags": [ "Typen von Deals" ], "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-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_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-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_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-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_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-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_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/topics/{id}/deactivate": { "put": { "tags": [ "Themen zu Deals" ], "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-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_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-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_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-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_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-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_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/states/{id}/deactivate": { "put": { "tags": [ "Status zu 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-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_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-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äten zu Deals" ], "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-CrmPriority" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Prioritäten 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-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äten zu Deals" ], "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-deals/priorities/{crmDealPriorityId}/move/{position}": { "put": { "tags": [ "Prioritäten 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/health/{id}": { "get": { "tags": [ "Gesundheitsstatus zu 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-CrmDealHealth" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Gesundheitsstatus zu Deals" ], "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-CrmDealHealth" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealHealth" } } } }, "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": [ "Gesundheitsstatus zu Deals" ], "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-deals/health/{id}/deactivate": { "put": { "tags": [ "Gesundheitsstatus 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-CrmDealHealth" } } } }, "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/health/{id}/activate": { "put": { "tags": [ "Gesundheitsstatus 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-CrmDealHealth" } } } }, "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/health/{dealHealthId}/move/{position}": { "put": { "tags": [ "Gesundheitsstatus zu Deals" ], "summary": "moves a line to a new position", "operationId": "moveLine_12", "parameters": [ { "name": "dealHealthId", "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-CrmDealHealth" } } } } } } }, "/erp/crm-deals/closing-reasons/{id}": { "get": { "tags": [ "Abschlußgründe zu 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-CrmDealClosingReason" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Abschlußgründe zu Deals" ], "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-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ßgründe zu Deals" ], "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-deals/closing-reasons/{id}/deactivate": { "put": { "tags": [ "Abschlußgründe 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-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ßgründe 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-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ßgründe zu Deals" ], "summary": "moves a line to a new position", "operationId": "moveLine_13", "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äten" ], "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-CrmActivity" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Aktivitäten" ], "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-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äten" ], "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/crm-activities/types/{id}": { "get": { "tags": [ "Aktivitätsarten" ], "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-CrmActivityType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Aktivitätsarten" ], "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-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ätsarten" ], "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/crm-activities/types/{id}/deactivate": { "put": { "tags": [ "Aktivitätsarten" ], "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-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ätsarten" ], "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-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ätsarten" ], "summary": "moves a line to a new position", "operationId": "moveLine_14", "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ätstypen pro Benutzer" ], "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-CrmActivityTypePerUser" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Aktivitätstypen pro Benutzer" ], "summary": "Update existing Resource ", "operationId": "update_64", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityTypePerUser" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityTypePerUser" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Aktivitätstypen pro Benutzer" ], "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/crm-activities/set-billed": { "put": { "tags": [ "Aktivitäten" ], "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äten" ], "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-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äten" ], "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-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äten" ], "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/contact-types/{id}": { "get": { "tags": [ "ContactType" ], "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-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_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-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_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/contact-types/{id}/deactivate": { "put": { "tags": [ "ContactType" ], "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-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_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-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_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-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_67", "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_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/bundle-schemata/{id}": { "get": { "tags": [ "bundle schema" ], "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-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_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-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_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/{id}": { "get": { "tags": [ "Bank" ], "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-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_69", "parameters": [ { "name": "id", "in": "path", "description": "ID der Bank", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-Bank" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-Bank" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Bank" ], "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/{id}/deactivate": { "put": { "tags": [ "Bank" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_32", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-Bank" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/bank/{id}/activate": { "put": { "tags": [ "Bank" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_32", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-Bank" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/bank/transactions/{id}": { "get": { "tags": [ "BankTransactions" ], "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-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_70", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankTransaction" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankTransaction" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "BankTransactions" ], "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/payments/{paymentId}/records/{recordId}": { "put": { "tags": [ "BankPayment" ], "operationId": "updateRecord", "parameters": [ { "name": "paymentId", "in": "path", "description": "ID der BankPayment", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "recordId", "in": "path", "description": "ID des Records", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPaymentRecord" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } } } } }, "delete": { "tags": [ "BankPayment" ], "operationId": "deleteRecord", "parameters": [ { "name": "paymentId", "in": "path", "description": "ID der BankPayment", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "recordId", "in": "path", "description": "ID des Records", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "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_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-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_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-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_68", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/bank/backend/{id}": { "get": { "tags": [ "BankingBackend" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_70", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/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_72", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankingBackend" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankingBackend" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "BankingBackend" ], "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": { "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_33", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankingBackend" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/bank/backend/{id}/activate": { "put": { "tags": [ "BankingBackend" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_33", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankingBackend" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/bank/accounts/{id}": { "get": { "tags": [ "BankAccount" ], "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-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_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-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_70", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/bank/accounts/{id}/deactivate": { "put": { "tags": [ "BankAccount" ], "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-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_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-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/bank/accounts/{accountId}/balance": { "get": { "tags": [ "BankAccount" ], "operationId": "getBalance", "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": "number" } } } } } }, "put": { "tags": [ "BankAccount" ], "operationId": "setBalance", "parameters": [ { "name": "accountId", "in": "path", "description": "ID des Accounts", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "balance", "in": "query", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/assets/{id}": { "get": { "tags": [ "Asset" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-Asset" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Asset" ], "summary": "Update existing Resource ", "operationId": "update_74", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-asset-Asset" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-Asset" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Asset" ], "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": { "*/*": { "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/assets/{id}/deactivate": { "put": { "tags": [ "Asset" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_35", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-Asset" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/assets/{id}/activate": { "put": { "tags": [ "Asset" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_35", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-Asset" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/assets/types/{id}": { "get": { "tags": [ "Asset" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-AssetType" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Asset" ], "summary": "Update existing Resource ", "operationId": "update_75", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-asset-AssetType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-AssetType" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Asset" ], "summary": "Delete an existing Resource", "operationId": "delete_72", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/assets/types/{id}/deactivate": { "put": { "tags": [ "Asset" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_36", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-AssetType" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/assets/types/{id}/activate": { "put": { "tags": [ "Asset" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_36", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-AssetType" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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ünschte 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_76", "parameters": [ { "name": "id", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gewünschte 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ängert 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ängernden Sperre", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "leasePeriod", "in": "query", "description": "Optionale Lease-Dauer in Sekunden", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } }, "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_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-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_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-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ünschte 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", "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ünschte 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", "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ünschte 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_74", "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_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-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_73", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/articles/print-labels/{batchId}": { "put": { "tags": [ "Article" ], "summary": "Führt 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_75", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/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_78", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSupplier" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSupplier" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "ArticleSupplier" ], "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": { "*/*": { "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_38", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSupplier" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/article-suppliers/{id}/activate": { "put": { "tags": [ "ArticleSupplier" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_38", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSupplier" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/article-customers/{id}": { "get": { "tags": [ "ArticleCustomer" ], "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": { "*/*": { "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_79", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleCustomer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleCustomer" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "ArticleCustomer" ], "summary": "Delete an existing Resource", "operationId": "delete_75", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/article-customers/{id}/deactivate": { "put": { "tags": [ "ArticleCustomer" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_39", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleCustomer" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/article-customers/{id}/activate": { "put": { "tags": [ "ArticleCustomer" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_39", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleCustomer" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/article-actors/{id}": { "get": { "tags": [ "ArticleActor" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleActor" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "ArticleActor" ], "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/erp-product-ArticleActor" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleActor" } } } }, "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": [ "ArticleActor" ], "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/article-accessories/{id}": { "get": { "tags": [ "Article" ], "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-Accessory" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Article" ], "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/erp-product-Accessory" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Accessory" } } } }, "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": "delete_77", "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/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/{accountId}/listings/{id}": { "get": { "tags": [ "account" ], "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-account-AccountListing" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "account" ], "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/erp-account-AccountListing" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-account-AccountListing" } } } }, "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": [ "account" ], "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": { "*/*": { "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/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_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/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_83", "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_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/account-types/supplier-group/{id}/deactivate": { "put": { "tags": [ "SupplierGroup" ], "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-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_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-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_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/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_84", "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_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/account-types/customer-group/{id}/deactivate": { "put": { "tags": [ "CustomerGroup" ], "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/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_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/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/wiki/{id}": { "get": { "tags": [ "Wiki" ], "operationId": "getById_82", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-wiki-WikiPageDto" } } } } } }, "put": { "tags": [ "Wiki" ], "operationId": "update_85", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-wiki-WikiPageDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-wiki-WikiPageDto" } } } } } }, "delete": { "tags": [ "Wiki" ], "operationId": "delete_81", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "alsoDeleteChildren", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/dms/wiki/{id}/revision/{revisionId}/restore-content": { "put": { "tags": [ "Wiki" ], "operationId": "restoreRevision", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "revisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-wiki-WikiPageDto" } } } } } } }, "/dms/wiki/{id}/move": { "put": { "tags": [ "Wiki" ], "operationId": "move", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "newParentId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "newParentRefType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "newPosition", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/dms/wiki/{id}/leasable-lock/{lockToken}": { "put": { "tags": [ "Wiki" ], "summary": "Verlängert 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ängernden Sperre", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "leasePeriod", "in": "query", "description": "Optionale Lease-Dauer in Sekunden", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } }, "delete": { "tags": [ "Wiki" ], "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" } } } }, "/dms/resources/{id}": { "get": { "tags": [ "Documents" ], "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/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_86", "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/types/{id}": { "get": { "tags": [ "Document Types" ], "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-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_87", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-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_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" } } } } } } }, "/dms/attributions/{id}": { "get": { "tags": [ "Attributions" ], "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-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_88", "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_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" } } } } } } }, "/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" ], "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" ], "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" ], "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/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" ], "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/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" ], "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" } } } } } } }, "/vds/carrier/{carrierId}/parameter/{key}": { "put": { "tags": [ "Carrier" ], "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" ], "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" ], "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" ], "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": { "*/*": { "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" ], "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/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" ], "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": { "*/*": { "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" ], "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" ], "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" ], "summary": "Find an existing Instance by identifier", "operationId": "getById_88", "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" ], "summary": "Update a Instance", "operationId": "update_91", "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" ], "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" ], "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-ScenarioDesiredValue" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Scenario" ], "summary": "Update a Instance", "operationId": "update_92", "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" ], "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" ], "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-ScenarioActualValue" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Scenario" ], "summary": "Update a Instance", "operationId": "update_93", "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" ], "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_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/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_94", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-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_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" } } } } } } }, "/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_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-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_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-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_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" } } } } } } }, "/erp/pos/payment/rule/{id}": { "get": { "tags": [ "PosPaymentRule" ], "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-pos-PosPaymentRule" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "PosPaymentRule" ], "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-pos-PosPaymentRule" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentRule" } } } }, "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": [ "PosPaymentRule" ], "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" } } } } } } }, "/erp/pos/payment/orders/{externalPaymentId}/status": { "put": { "tags": [ "PosPayment" ], "summary": "Zahlungsstatus aktualisieren", "operationId": "updateStatus", "parameters": [ { "name": "externalPaymentId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "PENDING", "PROCESSING", "SUCCESSFUL", "CANCELLED", "REJECTED" ] } }, { "name": "errorMessage", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentOrder" } } } } } } }, "/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_97", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-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_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" } } } } } } }, "/erp/pos/payment/consumer/{id}/rule-value": { "put": { "tags": [ "PosPaymentConsumer" ], "operationId": "updateRuleValue", "parameters": [ { "name": "id", "in": "path", "description": "ID des Payment-Consumers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/erp/pos/payment/consumer/{id}/request-refresh": { "put": { "tags": [ "PosPaymentConsumer" ], "operationId": "requestRefresh", "parameters": [ { "name": "id", "in": "path", "description": "ID des Payment-Consumers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/pos/payment/consumer/{id}/heart-beat": { "put": { "tags": [ "PosPaymentConsumer" ], "operationId": "doHeartbeat", "parameters": [ { "name": "id", "in": "path", "description": "ID des Payment-Consumers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/pos/payment/consumer/{id}/deactivate": { "put": { "tags": [ "PosPaymentConsumer" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_47", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentConsumer" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/payment/consumer/{id}/activate": { "put": { "tags": [ "PosPaymentConsumer" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_47", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentConsumer" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/payment/consumer/{id}": { "get": { "tags": [ "PosPaymentConsumer" ], "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-PosPaymentConsumer" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "PosPaymentConsumer" ], "summary": "Update existing Resource ", "operationId": "update_98", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentConsumer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentConsumer" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "PosPaymentConsumer" ], "summary": "Delete an existing Resource", "operationId": "delete_90", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/pos/payment/backend/{id}/deactivate": { "put": { "tags": [ "PosPaymentBackend" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_48", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentBackend" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/payment/backend/{id}/activate": { "put": { "tags": [ "PosPaymentBackend" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_48", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentBackend" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/payment/backend/{id}": { "get": { "tags": [ "PosPaymentBackend" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/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_99", "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_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" } } } } } } }, "/erp/finance/backend/{id}/deactivate": { "put": { "tags": [ "FinanceBookingBackend" ], "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-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_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-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_100", "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_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" } } } } } } }, "/erp/delivery/methods/{id}/deactivate": { "put": { "tags": [ "DeliveryMethod" ], "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-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_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-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_101", "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_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" } } } } } } }, "/erp/crm-tasks/{id}/subscription/deactivate": { "put": { "tags": [ "Aufgaben" ], "summary": "Entfernt eine Subscription auf dem Geschäftsobjekt für 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-tasks/{id}/subscription/activate": { "put": { "tags": [ "Aufgaben" ], "summary": "Setzt eine Subscription auf dem Geschäftsobjekt für 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-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_102", "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_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" } } } } } }, "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": "getParents", "parameters": [ { "name": "childId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } } } } } } }, "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}/subscription/deactivate": { "put": { "tags": [ "Projekte" ], "summary": "Entfernt eine Subscription auf dem Geschäftsobjekt für 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/crm-projects/{id}/subscription/activate": { "put": { "tags": [ "Projekte" ], "summary": "Setzt eine Subscription auf dem Geschäftsobjekt für 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/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_103", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-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_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" } } } } } }, "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": "getParents_1", "parameters": [ { "name": "childId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } } } } } } }, "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äftsobjekt für den Aufrufer", "operationId": "deregisterSubscription_2", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/crm-deals/{id}/subscription/activate": { "put": { "tags": [ "Deals" ], "summary": "Setzt eine Subscription auf dem Geschäftsobjekt für den Aufrufer", "operationId": "registerSubscription_2", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/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_104", "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_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" } } } } } }, "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": "getParents_2", "parameters": [ { "name": "childId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } } } } } } }, "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äftsobjekt für den Aufrufer", "operationId": "deregisterSubscription_3", "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äftsobjekt für den Aufrufer", "operationId": "registerSubscription_3", "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ängert eine Sperre", "operationId": "refreshLeasableLock_3", "parameters": [ { "name": "id", "in": "path", "description": "ID der gesperrten Resource", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lockToken", "in": "path", "description": "Token der zu verlängernden Sperre", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "leasePeriod", "in": "query", "description": "Optionale Lease-Dauer in Sekunden", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } }, "delete": { "tags": [ "account" ], "summary": "Gibt ein Sperre frei", "operationId": "releaseLeasableLock_3", "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_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-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_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-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_105", "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_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/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_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/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_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/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_106", "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_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/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_107", "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": [ "AppScriptingProxy" ], "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": [ "AppScriptingProxy" ], "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-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": [ "AppScriptingProxy" ], "summary": "Delete an existing Resource", "operationId": "delete_99", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/system/app-message/{id}": { "get": { "tags": [ "AppMessage" ], "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": [ "AppMessage" ], "summary": "Update a Instance", "operationId": "update_109", "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": [ "AppMessage" ], "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": [ "AppMessage" ], "operationId": "deactivateEntries", "parameters": [ { "name": "appId", "in": "path", "description": "App-ID", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/secrets/{id}": { "get": { "tags": [ "Secret Storage" ], "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-system-SecretStorage" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Secret Storage" ], "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-system-SecretStorage" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-SecretStorage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Secret Storage" ], "summary": "Delete an existing Resource", "operationId": "delete_100", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/output/consumer/{id}/rule-value": { "put": { "tags": [ "Output-Consumer" ], "operationId": "updateRuleValue_1", "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_1", "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_1", "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_53", "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_53", "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_111", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-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_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/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_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-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_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/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_54", "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_54", "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_113", "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_114", "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_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-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_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/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_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-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_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/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_55", "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_55", "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": { "200": { "description": "successful operation" }, "404": { "description": "work item not found" }, "422": { "description": "work item not assigned to current user" } } } }, "/cmn/work-items/{id}/input": { "put": { "tags": [ "WorkItem" ], "operationId": "processUserDecisionInput", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } }, "required": true }, "responses": { "200": { "description": "successful operation" }, "404": { "description": "work item not found" }, "422": { "description": "work item assigned to other user" } } } }, "/cmn/work-items/{id}/assign-to-me": { "put": { "tags": [ "WorkItem" ], "operationId": "assignToMe", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "work item not found" }, "422": { "description": "work item already assigned" } } } }, "/cmn/variant/schema/{id}": { "get": { "tags": [ "VariantSchema" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_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/common-variant-VariantSchema" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "VariantSchema" ], "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-variant-VariantSchema" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantSchema" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "VariantSchema" ], "summary": "Delete an existing Resource", "operationId": "delete_105", "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/variant/schema/{id}/deactivate": { "put": { "tags": [ "VariantSchema" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_56", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantSchema" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/variant/schema/{id}/activate": { "put": { "tags": [ "VariantSchema" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_56", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantSchema" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/variant/attribute/{id}": { "get": { "tags": [ "VariantAttribute" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantAttribute" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "VariantAttribute" ], "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-variant-VariantAttribute" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantAttribute" } } } }, "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": [ "VariantAttribute" ], "summary": "Delete an existing Resource", "operationId": "delete_106", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/variant/attribute/{id}/deactivate": { "put": { "tags": [ "VariantAttribute" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantAttribute" } } } }, "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/variant/attribute/{id}/activate": { "put": { "tags": [ "VariantAttribute" ], "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": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantAttribute" } } } }, "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/variant/attribute/{attributeId}/value/{valueId}": { "put": { "tags": [ "VariantAttribute" ], "operationId": "updateValue", "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/common-variant-VariantValue" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantValue" } } } } } }, "delete": { "tags": [ "VariantAttribute" ], "operationId": "deleteValue", "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" } } } } } } }, "/cmn/variant/attribute/{attributeId}/value/{valueId}/deactivate": { "put": { "tags": [ "VariantAttribute" ], "operationId": "deactivateValue", "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/common-variant-VariantValue" } } } } } } }, "/cmn/variant/attribute/{attributeId}/value/{valueId}/activate": { "put": { "tags": [ "VariantAttribute" ], "operationId": "activateValue", "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/common-variant-VariantValue" } } } } } } }, "/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_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-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_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-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_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-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_119", "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_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/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_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-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_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-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_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-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_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-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_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/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_60", "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_60", "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_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-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_121", "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_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/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_119", "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_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-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_110", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/ui-settings/{id}": { "get": { "tags": [ "Ui-Einstellungen" ], "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": { "*/*": { "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_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-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_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/text/translations/{id}": { "get": { "tags": [ "Text" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_121", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-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_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-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_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/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_122", "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_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-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_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-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_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-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_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/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/task/{id}/tracing": { "put": { "tags": [ "Task" ], "summary": "Aktiviert das Call-Tracing für diesen Task", "description": "Bewusst ein eigener Endpunkt, damit das Flag bei einer gewöhnlichen Task-Bearbeitung nicht versehentlich mitwandert.", "operationId": "activateTrace", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Task" ], "summary": "Deaktiviert das Call-Tracing für diesen Task", "description": "Bewusst ein eigener Endpunkt, damit das Flag bei einer gewöhnlichen Task-Bearbeitung nicht versehentlich mitwandert.", "operationId": "deactivateTrace", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/tags/{id}": { "get": { "tags": [ "Tags" ], "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": { "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_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-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_114", "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_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-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_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-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_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" } } } } } } }, "/cmn/sequencer/free/{id}": { "get": { "tags": [ "FreeSequencer" ], "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": { "*/*": { "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_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-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_116", "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_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-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_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-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_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-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_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-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_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" } } } } } } }, "/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_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-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_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-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_118", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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_132", "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_119", "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_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-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_133", "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_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/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}/deactivate": { "put": { "tags": [ "Output-Module" ], "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": { "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_62", "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_134", "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öscht 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ür 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/locations/{id}": { "get": { "tags": [ "location-resource" ], "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/erp-sales_channel-Location" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "location-resource" ], "summary": "Update existing Resource ", "operationId": "update_135", "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-Location" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-Location" } } } }, "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": [ "location-resource" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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/leasable-locks/{token}": { "put": { "tags": [ "LeasableLock" ], "summary": "Verlängert eine Sperre", "operationId": "refreshLeasableLock_4", "parameters": [ { "name": "token", "in": "path", "description": "Token einer Sperre", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "leasePeriod", "in": "query", "description": "Lease-Dauer in Sekunden", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-locknlease-LeasableLockDto" } } } } } }, "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_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-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_136", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-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_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-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_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-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" ], "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" ], "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" ], "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_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-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_137", "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_122", "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_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-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_138", "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}/state": { "put": { "tags": [ "ImportRun" ], "operationId": "updateImportState", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "state", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "CREATED", "EXTRACTING_DATA", "DATA_EXTRACTED", "RUNNING", "ERRONEOUS", "COMPLETED", "IGNORED", "DUMMY" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-data_import-DataImportRun" } } } } } } }, "/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_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-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_123", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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_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-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_139", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-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_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/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/customs-measures/{id}": { "get": { "tags": [ "CustomsMeasure" ], "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-CustomsMeasure" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CustomsMeasure" ], "summary": "Update existing Resource ", "operationId": "update_140", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-CustomsMeasure" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CustomsMeasure" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "CustomsMeasure" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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/customs-measures/{id}/deactivate": { "put": { "tags": [ "CustomsMeasure" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_64", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CustomsMeasure" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/customs-measures/{id}/activate": { "put": { "tags": [ "CustomsMeasure" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_64", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CustomsMeasure" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/currency-codes/{id}": { "get": { "tags": [ "CurrencyCode" ], "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-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_141", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-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_126", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/currency-codes/{id}/deactivate": { "put": { "tags": [ "CurrencyCode" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_65", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CurrencyCode" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/currency-codes/{id}/activate": { "put": { "tags": [ "CurrencyCode" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_65", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CurrencyCode" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/currency-codes/rates/{id}": { "get": { "tags": [ "CurrencyExchangeRate" ], "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-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_142", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-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_127", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/create-templates/{id}": { "get": { "tags": [ "CreateTemplates" ], "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-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_143", "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_128", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/create-templates/groups/{id}": { "get": { "tags": [ "CreateTemplateGroups" ], "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-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_144", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-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_129", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/country-region/{id}": { "get": { "tags": [ "CountryRegion" ], "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": { "*/*": { "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_145", "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_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/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_66", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CountryRegion" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/country-region/{id}/activate": { "put": { "tags": [ "CountryRegion" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_66", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CountryRegion" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/country-codes/{id}": { "get": { "tags": [ "CountryCode" ], "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": { "*/*": { "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_146", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-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_67", "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_67", "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/connector/http/whitelist/{id}": { "get": { "tags": [ "HTTP Whitelist" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_143", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-connector-HttpWhitelist" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "HTTP Whitelist" ], "summary": "Update existing Resource ", "operationId": "update_147", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-connector-HttpWhitelist" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-connector-HttpWhitelist" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "HTTP Whitelist" ], "summary": "Delete an existing Resource", "operationId": "delete_131", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "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/connector/http/whitelist/{id}/deactivate": { "put": { "tags": [ "HTTP Whitelist" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_68", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-connector-HttpWhitelist" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/connector/http/whitelist/{id}/activate": { "put": { "tags": [ "HTTP Whitelist" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_68", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-connector-HttpWhitelist" } } } }, "404": { "description": "Resource was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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" } } } } } } }, "/cmn/computed-queries/{group-key}/{id}/presets/{presetId}/report-group": { "get": { "tags": [ "computed-queries" ], "summary": "Get the report group bound to the given query preset", "operationId": "getPresetReportGroup", "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" } } ], "responses": { "200": { "description": "Bound report group (or empty body if none)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-ComputedQueryResource.PresetReportGroupBinding" } } } } } }, "put": { "tags": [ "computed-queries" ], "summary": "Bind an existing report group to the given query preset", "operationId": "bindPresetReportGroup", "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-ComputedQueryResource.BindReportGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "Group bound to the preset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-ComputedQueryResource.PresetReportGroupBinding" } } } } } }, "post": { "tags": [ "computed-queries" ], "summary": "Create a stub report group for the given query preset", "operationId": "createPresetReportGroup", "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" } } ], "responses": { "200": { "description": "Stub group created and bound to the preset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-ComputedQueryResource.PresetReportGroupBinding" } } } } } }, "delete": { "tags": [ "computed-queries" ], "summary": "Detach the report group from the given query preset", "operationId": "unbindPresetReportGroup", "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" } } ], "responses": { "200": { "description": "Binding removed" } } } }, "/cmn/commodity-codes/{id}": { "get": { "tags": [ "CommodityCode" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_144", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CommodityCode" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CommodityCode" ], "summary": "Update existing Resource ", "operationId": "update_148", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-CommodityCode" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CommodityCode" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "CommodityCode" ], "summary": "Delete an existing Resource", "operationId": "delete_132", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "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/commodity-codes/{id}/deactivate": { "put": { "tags": [ "CommodityCode" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_69", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CommodityCode" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/commodity-codes/{id}/activate": { "put": { "tags": [ "CommodityCode" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_69", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CommodityCode" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/category/{id}": { "get": { "tags": [ "Category" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_145", "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-Category" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "Category" ], "summary": "Update existing Resource ", "operationId": "update_149", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-Category" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-Category" } } } }, "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": [ "Category" ], "summary": "Delete an existing Resource", "operationId": "delete_133", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/cmn/category/{id}/deactivate": { "put": { "tags": [ "Category" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_70", "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-Category" } } } }, "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/category/{id}/activate": { "put": { "tags": [ "Category" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_70", "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-Category" } } } }, "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/category-tree/{id}": { "get": { "tags": [ "CategoryTree" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_146", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CategoryTree" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "put": { "tags": [ "CategoryTree" ], "summary": "Update existing Resource ", "operationId": "update_150", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-CategoryTree" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CategoryTree" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "CategoryTree" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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/category-tree/{id}/deactivate": { "put": { "tags": [ "CategoryTree" ], "summary": "deaktiviert eine bestehende Resource", "operationId": "deactivate_71", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CategoryTree" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/category-tree/{id}/activate": { "put": { "tags": [ "CategoryTree" ], "summary": "aktiviert eine bestehende Resource", "operationId": "activate_71", "parameters": [ { "name": "id", "in": "path", "description": "identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CategoryTree" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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_147", "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_151", "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_135", "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", "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", "APP" ] } } ], "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", "APP" ] } } ], "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": [ "Replenishment" ], "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": [ "Replenishment" ], "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": [ "Replenishment" ], "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ört", "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/process-input-for-incorrectly-picked-goods": { "post": { "tags": [ "Picklisten" ], "operationId": "processInputForIncorrectlyPickedGoods", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistForIncorrectlyPickedGoodsProcessingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistForIncorrectlyPickedGoodsProcessingResponse" } } } } } } }, "/wms/picklists/picking-of-picklist/start-stop": { "post": { "tags": [ "Picklisten" ], "operationId": "startStopPickingOfPicklist", "parameters": [ { "name": "picklistNumber", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickingState" } } } } } } }, "/wms/picklists/picking-of-picklist/reset": { "post": { "tags": [ "Picklisten" ], "operationId": "resetPickingOfPicklist", "parameters": [ { "name": "picklistNumber", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickingState" } } } } } } }, "/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ür 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": [ "WebSocket" ], "operationId": "getToken", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/node-api-MultiTenantWebsocketTokenDto" } } } } } } }, "/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" } } } } } } }, "/rma/returns/receiving/process-input": { "post": { "tags": [ "Retouren-Handling" ], "summary": "Verarbeitet eine Eingabe für die Retouren-Annahme", "operationId": "processReceivingInput", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnReceivingRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnReceivingResponse" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/rma/returns/processing/process-input": { "post": { "tags": [ "Retouren-Handling" ], "summary": "Verarbeitet eine Eingabe für die Retouren-Verarbeitung", "operationId": "processProcessingInput", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnProcessingRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnProcessingResponse" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/variant/value-listing": { "post": { "tags": [ "VariantValueListing" ], "summary": "Create new Resource", "operationId": "create_6", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantValueListing" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantValueListing" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/variant/attribute-listing": { "post": { "tags": [ "VariantAttributeListing" ], "summary": "Create new Resource", "operationId": "create_7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantAttributeListing" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantAttributeListing" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/variant-attribute-assignment-config/": { "post": { "tags": [ "variant attribute assignment config" ], "summary": "Create new Resource", "operationId": "create_8", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-VariantAttributeAssignmentConfig" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-VariantAttributeAssignmentConfig" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/user-details": { "post": { "tags": [ "UserDescription" ], "summary": "Create new Resource", "operationId": "create_9", "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_10", "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_11", "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_12", "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_13", "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_14", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-Storage" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-Storage" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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_15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-StorageArea" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-StorageArea" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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/transfer-dummy-serial-number": { "post": { "tags": [ "Stocks" ], "operationId": "transferDummySerialNumber", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-DummySerialNumberStockTransferApi" } } }, "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 Änderungen", "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_16", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-SalesChannelStorageSchema" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-SalesChannelStorageSchema" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/rma/return-groups": { "post": { "tags": [ "ReturnGroups" ], "summary": "Create new Resource", "operationId": "create_17", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/rma/return-causes": { "post": { "tags": [ "ReturnCauses" ], "summary": "Create new Resource", "operationId": "create_18", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnCause" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-rma-ReturnCause" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/recommended-retail-price/": { "post": { "tags": [ "Recommended Retail Price" ], "summary": "Create new Resource", "operationId": "create_19", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-RecommendedRetailPrice" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-RecommendedRetailPrice" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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/recalculate-sales-prices-depending-on-purchase-price": { "post": { "tags": [ "ProductPrices" ], "operationId": "recalculateSalesPricesDependingOnPurchasePrice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-PriceRecalculationByPurchasePriceRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/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/product-variants/productVariantUpdateJob": { "post": { "tags": [ "Product-Variant" ], "summary": "Startet einen Job, der die gewählten Bereiche des Variantenhauptartikels auf alle Varianten überträgt", "operationId": "createProductVariantUpdateRequest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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-types/product-price-groups": { "post": { "tags": [ "ProductPriceGroups" ], "summary": "Create new Resource", "operationId": "create_20", "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_21", "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_22", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductMainGroup" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ProductMainGroup" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/product-types/identifier-types": { "post": { "tags": [ "IdentifierType" ], "summary": "Create new Resource", "operationId": "create_23", "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_24", "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_25", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-PriceModifierTemplate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-PriceModifierTemplate" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/register": { "post": { "tags": [ "PosRegister" ], "summary": "Create new Resource", "operationId": "create_26", "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_27", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-FiscalizationBackend" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-FiscalizationBackend" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/depositExpenseType": { "post": { "tags": [ "PosDepositExpenseType" ], "summary": "Create new Resource", "operationId": "create_28", "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_29", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-CashDrawer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-CashDrawer" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/cash-drawer/{cashDrawerId}/unlock-for-cash-journal-run": { "post": { "tags": [ "CashDrawer" ], "summary": "Entsperrt eine Kassenschublade von einem Kassenabrechnungslauf", "operationId": "unlockForCashJournalRun", "parameters": [ { "name": "cashDrawerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/pos/cash-drawer/{cashDrawerId}/lock-for-cash-journal-run": { "post": { "tags": [ "CashDrawer" ], "summary": "Sperrt eine Kassenschublade für einen Kassenabrechnungslauf", "operationId": "lockForCashJournalRun", "parameters": [ { "name": "cashDrawerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } } }, "/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_30", "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_31", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentTemplate" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentTemplate" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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_32", "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_33", "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}/calculate_discount/{discountDate}": { "post": { "tags": [ "OpenItem" ], "description": "Gibt den Skontobetrag und die Gültigkeit des Skonto für ein angegebenes Datum zurück", "operationId": "calculateDiscountForDate", "parameters": [ { "name": "openItemid", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "discountDate", "in": "path", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-DiscountCalculationResponse" } } } } } } }, "/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 oder eine Verrechnung", "operationId": "revert", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitems/{firstOpenItemId}/clear_with/{secondOpenItemId}": { "get": { "tags": [ "OpenItem" ], "description": "Gibt das Saldo nach Verrechnung zurück", "operationId": "calculateExpectedBalance", "parameters": [ { "name": "firstOpenItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "secondOpenItemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-ClearingExpectedResponse" } } } } } }, "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/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/matchingrules": { "post": { "tags": [ "MatchingRules" ], "summary": "Create new Resource", "operationId": "create_34", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemMatchingRule" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemMatchingRule" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/openitems/dunning/{openItemId}/charge": { "post": { "tags": [ "OpenItemDunning" ], "description": "Erfasst Mahngebühr/Mahnzins auf einem kreditorischen Offenen Posten und erhöht diesen", "operationId": "charge", "parameters": [ { "name": "openItemId", "in": "path", "description": "openItem Identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemDunningChargeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItem" } } } } } } }, "/erp/finance/openitems/dunning/{openItemId}/charge/{recordId}/revert": { "post": { "tags": [ "OpenItemDunning" ], "description": "Storniert eine erfasste Mahngebühr/Mahnzins auf einem kreditorischen Offenen Posten", "operationId": "revert_1", "parameters": [ { "name": "openItemId", "in": "path", "description": "openItem Identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "recordId", "in": "path", "description": "openItemRecord Identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItem" } } } } } } }, "/erp/finance/openitems/create_op_from_transaction": { "post": { "tags": [ "OpenItem" ], "description": "Creates an open item from a bank transaction", "operationId": "createFromTransaction", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-TransactionToOpenItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/finance/openitems/closure/{openItemId}/reopen": { "post": { "tags": [ "OpenItemClosure" ], "description": "Eröffnet einen manuell abgeschlossenen OP wieder", "operationId": "reopen", "parameters": [ { "name": "openItemId", "in": "path", "description": "openItem Identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemReopenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItem" } } } } } } }, "/erp/finance/openitems/closure/{openItemId}/close": { "post": { "tags": [ "OpenItemClosure" ], "description": "Schließt einen offenen Posten ab", "operationId": "close", "parameters": [ { "name": "openItemId", "in": "path", "description": "openItem Identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemCloseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItem" } } } } } } }, "/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/openitems/account/{accountId}/offset_credit_notes": { "get": { "tags": [ "OpenItem" ], "description": "Vorschau: verrechnet offene Gutschriften des Kontos gegen dessen offene Rechnungen (älteste zuerst) ohne zu buchen und meldet zurück, was verrechnet würde", "operationId": "previewOffsetCreditNotes", "parameters": [ { "name": "accountId", "in": "path", "description": "account identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemOffsetResult" } } } } } }, "post": { "tags": [ "OpenItem" ], "description": "Verrechnet offene Gutschriften des Kontos gegen dessen offene Rechnungen (älteste zuerst) und meldet zurück, was verrechnet wurde", "operationId": "offsetCreditNotes", "parameters": [ { "name": "accountId", "in": "path", "description": "account identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-OpenItemOffsetResult" } } } } } } }, "/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_35", "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_36", "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/dunnings/{id}/position/{openItemId}": { "post": { "tags": [ "Dunning" ], "operationId": "addOpenItem", "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" } } } } } }, "delete": { "tags": [ "Dunning" ], "operationId": "removeOpenItem", "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/finance/dunnings/{id}/fixate": { "post": { "tags": [ "Dunning" ], "operationId": "fixateDunning", "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/dunnings/{id}/dissolve": { "post": { "tags": [ "Dunning" ], "operationId": "dissolveDunning", "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": { "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}/fixate": { "post": { "tags": [ "DunningRun" ], "operationId": "fixateDunningRun", "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}/dissolve": { "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_levels": { "post": { "tags": [ "DunningLevel" ], "summary": "Create new Resource", "operationId": "create_37", "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_levels/{id}/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_38", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-CostCenter" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-finance-CostCenter" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/finance/business_transaction": { "post": { "tags": [ "BusinessTransaction" ], "summary": "Create new Resource", "operationId": "create_39", "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/fabrication/{fabricationOrderId}/revert/{lineId}": { "get": { "tags": [ "Produktion" ], "operationId": "getDetailsForProductionReversalOfDocumentLine", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lineId", "in": "path", "description": "ID der zu produzierenden Position", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-fabrication-DetailsForProductionReversal" } } } } } }, "post": { "tags": [ "Produktion" ], "operationId": "revertProducedArticle", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lineId", "in": "path", "description": "ID der zu stornierenden Position", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-fabrication-FabricationRevertRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-Document" } } } } } } }, "/erp/fabrication/{fabricationOrderId}/revert-all": { "get": { "tags": [ "Produktion" ], "operationId": "getDetailsForProductionReversalOfDocument", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-fabrication-DetailsForProductionReversal" } } } } } } }, "post": { "tags": [ "Produktion" ], "operationId": "revertAll", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationRevertRequest" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-Document" } } } } } } }, "/erp/fabrication/{fabricationOrderId}/produce/{lineId}": { "get": { "tags": [ "Produktion" ], "operationId": "getDetailsForProductionOfDocumentLine", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lineId", "in": "path", "description": "ID der zu produzierenden Position", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-fabrication-DetailsForProduction" } } } } } }, "post": { "tags": [ "Produktion" ], "operationId": "produceArticle", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lineId", "in": "path", "description": "ID der zu produzierenden Position", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-fabrication-FabricationProduceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-Document" } } } } } } }, "/erp/fabrication/{fabricationOrderId}/produce-all": { "get": { "tags": [ "Produktion" ], "operationId": "getDetailsForProductionOfDocument", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-fabrication-DetailsForProduction" } } } } } } }, "post": { "tags": [ "Produktion" ], "operationId": "produceAll", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationProduceRequest" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-Document" } } } } } } }, "/erp/fabrication/{fabricationOrderId}/mark-as-not-defective/{lineId}": { "post": { "tags": [ "Produktion" ], "operationId": "markAsNotDefective", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lineId", "in": "path", "description": "ID der als nicht mehr fehlerhaft zu markierenden Position", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-fabrication-FabricationDefectiveRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-Document" } } } } } } }, "/erp/fabrication/{fabricationOrderId}/mark-as-defective/{lineId}": { "get": { "tags": [ "Produktion" ], "operationId": "getDetailsForDefectiveMarking", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lineId", "in": "path", "description": "ID der als fehlerhaft zu markierenden Position", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-fabrication-DetailsForDefectiveMarking" } } } } } }, "post": { "tags": [ "Produktion" ], "operationId": "markAsDefective", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lineId", "in": "path", "description": "ID der als fehlerhaft zu markierenden Position", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-fabrication-FabricationDefectiveRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-Document" } } } } } } }, "/erp/fabrication/{fabricationOrderId}/create-picklist-to-restock-components": { "post": { "tags": [ "Produktion" ], "operationId": "createPicklistToRestockComponents", "parameters": [ { "name": "fabricationOrderId", "in": "path", "description": "ID des Produktionsbelegs", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-wms-Picklist" } } } } } } }, "/erp/fabrication/create-picklist-to-restock-components": { "post": { "tags": [ "Produktion" ], "operationId": "createPicklistToRestockComponents_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate" } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-wms-Picklist" } } } } } } }, "/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üft, ob eine Resource gesperrt ist", "operationId": "getLeasableLock", "parameters": [ { "name": "id", "in": "path", "description": "ID einer Resource", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } }, "post": { "tags": [ "Document" ], "summary": "Erstellt eine neue Sperre, optional mit einer Gültigkeitsdauer", "operationId": "createLeasableLock", "parameters": [ { "name": "id", "in": "path", "description": "ID der zu sperrenden Resource", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "leasePeriod", "in": "query", "description": "Optionale Lease-Dauer in Sekunden", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-unknownmodule-LeasableLock" } } } } } } }, "/erp/documents/{documentId}/try-transfer-into-picking/{picklistTemplateId}": { "post": { "tags": [ "Document" ], "summary": "Versucht einen Auftrag in Kommissionierung zu übernehmen und protokolliert das Ergebnis", "operationId": "tryTransferIntoPicking", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "picklistTemplateId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/erp/documents/{documentId}/process-input": { "post": { "tags": [ "Document" ], "operationId": "processInput_3", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentInputProcessingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentInputProcessingResponse" } } } } } } }, "/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}/toggle-finalized": { "post": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Wechselt den Finalisierungsstatus eines Dokuments: bei Einkaufsbelegen 'frozen', bei Verkaufsbelegen 'published'", "operationId": "toggleFinalizedDocumentState", "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}/multiple_sourcelines": { "post": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "fügt 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": "Startet den Hintergrundjob zum Erzeugen einer Sammelrechnung", "operationId": "createSalesCollectiveInvoice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-SalesSingleCollectiveInvoiceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/documents/additional-functions/collective-invoice-runs": { "post": { "tags": [ "CollectiveInvoiceRun" ], "summary": "Startet den Hintergrundjob zum Erzeugen eines Sammelrechnungslaufs", "operationId": "startRun", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-SalesMultiCollectiveInvoiceRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "422": { "description": "invalid request (e.g. Periodicity MANUAL or missing)", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/documents/additional-functions/collective-invoice-runs/{runId}/dissolve": { "post": { "tags": [ "CollectiveInvoiceRun" ], "summary": "Storniert den Sammelrechnungslauf", "operationId": "dissolve", "parameters": [ { "name": "runId", "in": "path", "description": "collective invoice run identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "422": { "description": "run already processed or already canceled", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/document-types": { "post": { "tags": [ "DocumentType" ], "summary": "Create new Resource", "operationId": "create_40", "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_41", "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_42", "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_43", "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/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_44", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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_45", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmState" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmState" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-tasks/priorities": { "get": { "tags": [ "Prioritäten 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äten zu Aufgaben" ], "summary": "Create new Resource", "operationId": "create_46", "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_47", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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_48", "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ät 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ät zu Projekten" ], "summary": "Create new Resource", "operationId": "create_49", "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_50", "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_51", "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_52", "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_53", "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_54", "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äten 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äten zu Deals" ], "summary": "Create new Resource", "operationId": "create_55", "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/health": { "post": { "tags": [ "Gesundheitsstatus zu Deals" ], "summary": "Create new Resource", "operationId": "create_56", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealHealth" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDealHealth" } } } }, "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ßgründe zu Deals" ], "summary": "Create new Resource", "operationId": "create_57", "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äten" ], "summary": "Create new Resource", "operationId": "create_58", "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ätsarten" ], "summary": "Create new Resource", "operationId": "create_59", "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ätstypen pro Benutzer" ], "summary": "Create new Resource", "operationId": "create_60", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityTypePerUser" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmActivityTypePerUser" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/crm-activities/perform-billing": { "post": { "tags": [ "Aktivitäten" ], "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äten" ], "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äten" ], "summary": "Create new Resource", "operationId": "create_61", "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_62", "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_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-commission-CommissionRunRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/commission/commission-assignment": { "post": { "tags": [ "CommissionAssignment" ], "summary": "Create new Resource", "operationId": "create_63", "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_64", "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_65", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-Bank" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-Bank" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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": "Referenz-IDs der zu importierenden Konten", "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_66", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankTransaction" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankTransaction" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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ür einen Account bis zum angegebenen Datum als nicht relevant", "operationId": "markAsNotRelevant", "parameters": [ { "name": "accountId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/bank/sync/{backendType}/{providerId}": { "post": { "tags": [ "Bank" ], "operationId": "syncBank", "parameters": [ { "name": "backendType", "in": "path", "description": "Bankschnittstelle", "required": true, "schema": { "type": "string", "enum": [ "OFFLINE", "FINAPI", "FINAPI_SANDBOX", "MOCKBANK", "APP" ] } }, { "name": "providerId", "in": "path", "description": "ID des Banking-Providers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-bank-Bank" } } } } } } } }, "/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_67", "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}/update_status/{status}": { "post": { "tags": [ "BankPayment" ], "operationId": "updateStatus_1", "parameters": [ { "name": "paymentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "READY_FOR_SUBMISSION", "PREPARED", "SENT", "CANCELLED", "UNKNOWN", "ERRONEOUS" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } } } } } }, "/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": { "$ref": "#/components/schemas/erp-payment-PaymentSendingResponse" } } } } } } }, "/erp/bank/payments/{paymentId}/revalidate": { "post": { "tags": [ "BankPayment" ], "operationId": "revalidate", "parameters": [ { "name": "paymentId", "in": "path", "description": "ID der BankPayment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } } } } } }, "/erp/bank/payments/{paymentId}/refresh-from-account": { "post": { "tags": [ "BankPayment" ], "operationId": "refreshFromAccount", "parameters": [ { "name": "paymentId", "in": "path", "description": "ID der BankPayment", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } } } } } }, "/erp/bank/payments/{paymentId}/records/{recordId}/revalidate": { "post": { "tags": [ "BankPayment" ], "operationId": "revalidateRecord", "parameters": [ { "name": "paymentId", "in": "path", "description": "ID der BankPayment", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "recordId", "in": "path", "description": "ID des Records", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } } } } } }, "/erp/bank/payment_runs": { "post": { "tags": [ "BankPaymentRun" ], "description": "Erzeugt einen Zahlungsvorschlag-Job aus konkreten OP-IDs und/oder einer CUnit-Selektion", "operationId": "createBankPaymentRun", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPaymentRunBuildRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/bank/payment_runs/{runId}/process": { "post": { "tags": [ "BankPaymentRun" ], "description": "Verarbeitet den Zahlungsvorschlag — schaltet alle nicht-ERRONEOUS Sammler für den Versand frei", "operationId": "processBankPaymentRun", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-finance-PaymentCreationResponse" } } } } } } }, "/erp/bank/payment_runs/{runId}/dissolve": { "post": { "tags": [ "BankPaymentRun" ], "description": "Storniert den Zahlungsvorschlag", "operationId": "dissolveBankPaymentRun", "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/erp/bank/backend": { "post": { "tags": [ "BankingBackend" ], "summary": "Create new Resource", "operationId": "create_68", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankingBackend" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankingBackend" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/bank/accounts": { "post": { "tags": [ "BankAccount" ], "summary": "Create new Resource", "operationId": "create_69", "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": { "$ref": "#/components/schemas/erp-bank-TransactionSyncResponse" } } } } } } }, "/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/assets/{id}/copy": { "post": { "tags": [ "Asset" ], "operationId": "copy_1", "parameters": [ { "name": "id", "in": "path", "description": "Asset-Id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "newAssetNumber", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-Asset" } } } } } } }, "/erp/assets/types/": { "post": { "tags": [ "Asset" ], "summary": "Create new Resource", "operationId": "create_70", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-asset-AssetType" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-AssetType" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/assets/create-by-template": { "post": { "tags": [ "Asset" ], "summary": "Neues Asset erzeugen", "operationId": "createByTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-asset-AssetCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-Asset" } } } } } } }, "/erp/assets/": { "post": { "tags": [ "Asset" ], "summary": "Create new Resource", "operationId": "create_71", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-asset-Asset" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-asset-Asset" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/articles": { "post": { "tags": [ "Article" ], "summary": "Neuen Artikel (ggf. mit Produkt) erzeugen", "operationId": "create_72", "parameters": [ { "name": "languageCode", "in": "query", "description": "Gewünschte 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}/leasable-lock": { "get": { "tags": [ "Article" ], "summary": "Prüft, 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ültigkeitsdauer", "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": { "get": { "tags": [ "Article" ], "operationId": "getFabricationComponents", "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": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ArticleFabricationComponent" } } } } } } }, "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}/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ünschte 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", "parameters": [ { "name": "articleId", "in": "path", "description": "an article id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "languageCode", "in": "query", "description": "Gewünschte 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_73", "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/articles/convert-bundle": { "post": { "tags": [ "ArticleStorage" ], "operationId": "convertBundle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-stock-ArticleBundleConversionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-stock-ArticleStorage" } } } } } } } }, "/erp/article-suppliers": { "post": { "tags": [ "ArticleSupplier" ], "summary": "Create new Resource", "operationId": "create_74", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSupplier" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleSupplier" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/article-customers": { "post": { "tags": [ "ArticleCustomer" ], "summary": "Create new Resource", "operationId": "create_75", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleCustomer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleCustomer" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/article-actors": { "post": { "tags": [ "ArticleActor" ], "summary": "Create new Resource", "operationId": "create_76", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleActor" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleActor" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/article-accessories/": { "post": { "tags": [ "Article" ], "summary": "Create new Resource", "operationId": "create_77", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-Accessory" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-Accessory" } } } }, "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/accounts/{accountId}/listings": { "post": { "tags": [ "account" ], "summary": "Create new Resource", "operationId": "create_78", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-account-AccountListing" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-account-AccountListing" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/account-types/supplier-group": { "post": { "tags": [ "SupplierGroup" ], "summary": "Create new Resource", "operationId": "create_79", "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_80", "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/wiki": { "get": { "tags": [ "Wiki" ], "operationId": "findAllByParent", "parameters": [ { "name": "refId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "refType", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/dms-wiki-WikiPageDto" } } } } } } }, "post": { "tags": [ "Wiki" ], "operationId": "create_81", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-wiki-WikiPageDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-wiki-WikiPageDto" } } } } } } }, "/dms/wiki/{id}/leasable-lock": { "get": { "tags": [ "Wiki" ], "summary": "Prüft, 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": [ "Wiki" ], "summary": "Erstellt eine neue Sperre, optional mit einer Gültigkeitsdauer", "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" } } } } } } }, "/dms/resources": { "post": { "tags": [ "Documents" ], "summary": "Create new Resource", "operationId": "create_82", "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änkung auf eine bestimmte Transformation", "required": false, "schema": { "type": "string" } }, { "name": "disposition", "in": "query", "description": "optional: gewünschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } }, "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" } } } } } }, "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": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } }, "required": [ "file" ] } } } }, "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_83", "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-ShelfDocumentEntryResource.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üpfungen, die zu einem ERP-Objekt gehören.", "operationId": "findAttributions", "parameters": [ { "name": "refId", "in": "query", "description": "ID des ERP-Objekts", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "refType", "in": "query", "description": "Um was für ein ERP-Objekt handelt es sich?", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentAttribution" } } } } } } }, "post": { "tags": [ "Attributions" ], "summary": "Create new Resource", "operationId": "create_84", "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" ], "summary": "Create new Resource", "operationId": "create_85", "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" ], "summary": "Create new Resource", "operationId": "create_86", "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" ], "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" ], "summary": "Create a Instance", "operationId": "create_87", "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" ], "summary": "Create a Instance", "operationId": "create_88", "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" ], "summary": "Create a Instance", "operationId": "create_89", "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_90", "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_91", "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/rule": { "post": { "tags": [ "PosPaymentRule" ], "summary": "Create new Resource", "operationId": "create_92", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentRule" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentRule" } } } }, "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_93", "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/consumer/{id}/request-next": { "post": { "tags": [ "PosPaymentConsumer" ], "operationId": "requestNextOrder", "parameters": [ { "name": "id", "in": "path", "description": "ID des Payment-Consumers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentOrder" } } } } } } }, "/erp/pos/payment/consumer": { "post": { "tags": [ "PosPaymentConsumer" ], "summary": "Create new Resource", "operationId": "create_94", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentConsumer" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentConsumer" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/pos/payment/backend": { "post": { "tags": [ "PosPaymentBackend" ], "summary": "Create new Resource", "operationId": "create_95", "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_2", "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_96", "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_97", "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_1", "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_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CreateCrmDealRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-crm-CrmDeal" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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üft, ob eine Resource gesperrt ist", "operationId": "getLeasableLock_3", "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ültigkeitsdauer", "operationId": "createLeasableLock_3", "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_98", "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_99", "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": [ "AppScriptingProxy" ], "operationId": "executeScript", "parameters": [ { "name": "appIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "triggerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } } } } } }, "/cmn/system/app-scripting-proxy": { "post": { "tags": [ "AppScriptingProxy" ], "summary": "Create new Resource", "operationId": "create_100", "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": [ "AppMessage" ], "summary": "register 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": [ "AppMessage" ], "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": [ "AppMessage" ], "summary": "Create a Instance", "operationId": "create_101", "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/secrets": { "post": { "tags": [ "Secret Storage" ], "summary": "Create new Resource", "operationId": "create_102", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-SecretStorage" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-SecretStorage" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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_103", "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_104", "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_105", "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_106", "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_107", "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_108", "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/variant/schema": { "post": { "tags": [ "VariantSchema" ], "summary": "Create new Resource", "operationId": "create_109", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-variant-VariantSchema" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantSchema" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/variant/attribute": { "post": { "tags": [ "VariantAttribute" ], "summary": "Create new Resource", "operationId": "create_110", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-variant-VariantAttribute" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantAttribute" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/variant/attribute/{attributeId}/value": { "get": { "tags": [ "VariantAttribute" ], "summary": "find all values to attribute", "operationId": "findAllValues", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-variant-VariantValue" } } } } } } }, "post": { "tags": [ "VariantAttribute" ], "operationId": "createValue", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-variant-VariantValue" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-variant-VariantValue" } } } } } } }, "/cmn/variant/attribute/{attributeId}/value/create-all": { "post": { "tags": [ "VariantAttribute" ], "operationId": "createValues", "parameters": [ { "name": "attributeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-variant-VariantValue" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-variant-VariantValue" } } } } } } } }, "/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_111", "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_112", "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_113", "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_114", "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/unit-type-ratio/convert": { "post": { "tags": [ "UnitTypeRatio" ], "operationId": "convertMultipleUnits", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-masterdata-UnitTypeConversion" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-masterdata-UnitTypeConversion" } } } } } } } }, "/cmn/ui-settings": { "post": { "tags": [ "Ui-Einstellungen" ], "summary": "Create new Resource", "operationId": "create_115", "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_116", "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_117", "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/{id}/cancel": { "post": { "tags": [ "Task" ], "summary": "Cancel a running task", "description": "Requests cancellation of a currently running task. The running job is aborted cooperatively at its next interaction and ends with status CANCELLED.", "operationId": "triggerTaskCancel", "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": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/cmn/tags": { "post": { "tags": [ "Tags" ], "summary": "Create new Resource", "operationId": "create_118", "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_119", "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_120", "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_121", "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_122", "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/output/modules/{moduleKey}/print/{masterId}": { "post": { "tags": [ "Output-Module" ], "summary": "Allgemeiner EP zum Reporte drucken", "operationId": "printReport", "parameters": [ { "name": "moduleKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "masterId", "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": { "application/json": { "schema": { "type": "object" } } } } } } }, "/cmn/locations": { "post": { "tags": [ "location-resource" ], "summary": "Create new Resource", "operationId": "create_123", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-Location" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-Location" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/language-codes": { "post": { "tags": [ "LanguageCode" ], "summary": "Create new Resource", "operationId": "create_124", "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": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-ftsearch-SearchResult" } } } } }, "422": { "description": "query was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/data-import/scheduled-import": { "post": { "tags": [ "eingeplante Importe" ], "summary": "Create new Resource", "operationId": "create_125", "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_126", "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ätze erst ab Eintrag ... validieren. null = ohne Einschränkung", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "to", "in": "query", "description": "Optional: Datensätze nur bis Eintrag ... validieren. null = ohne Einschränkung", "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_127", "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/customs-measures": { "post": { "tags": [ "CustomsMeasure" ], "summary": "Create new Resource", "operationId": "create_128", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-CustomsMeasure" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CustomsMeasure" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/currency-codes": { "post": { "tags": [ "CurrencyCode" ], "summary": "Create new Resource", "operationId": "create_129", "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_130", "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_131", "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_132", "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_133", "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_134", "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/connector/http/whitelist": { "post": { "tags": [ "HTTP Whitelist" ], "summary": "Create new Resource", "operationId": "create_135", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-connector-HttpWhitelist" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-connector-HttpWhitelist" } } } }, "422": { "description": "Resource was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-cunit-CuResult" } } } }, "422": { "description": "query was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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": { "200": { "description": "Request is processed and returned as Stream", "content": { "*/*": {} } }, "202": { "description": "Request is accepted and processing in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-OutputQueue" } } } } } } }, "/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/{presetId}/report-group/sync": { "post": { "tags": [ "computed-queries" ], "summary": "Sync the stub report group with the current preset state", "operationId": "syncPresetReportGroup", "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": "fullRewrite", "in": "query", "description": "If true, the entire JRXML is regenerated and any JasperStudio layout customizations are discarded. Default false keeps customizations and only refreshes the query string and field declarations.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Stub regenerated (created if missing)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-cunit-ComputedQueryResource.PresetReportGroupBinding" } } } } } } }, "/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/commodity-codes": { "post": { "tags": [ "CommodityCode" ], "summary": "Create new Resource", "operationId": "create_136", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-CommodityCode" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CommodityCode" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/category/tree/{categoryTreeId}": { "post": { "tags": [ "Category" ], "summary": "Erstellt eine neue Kategorie unter einem Kategorie-Baum", "operationId": "createWithParentTree", "parameters": [ { "name": "categoryTreeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-Category" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-Category" } } } } } } }, "/cmn/category/parent/{parentCategoryId}": { "post": { "tags": [ "Category" ], "summary": "Erstellt eine neue Kind-Kategorie unter einer bestehenden Kategorie", "operationId": "createWithParentCategory", "parameters": [ { "name": "parentCategoryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-Category" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-Category" } } } } } } }, "/cmn/category-tree": { "post": { "tags": [ "CategoryTree" ], "summary": "Create new Resource", "operationId": "create_137", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-CategoryTree" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-CategoryTree" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/apps/{identifier}/token": { "post": { "tags": [ "TenantApp" ], "operationId": "issueInstalledAppToken", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/node-api-AppTokenDto" } } } } } } }, "/cmn/apps/{identifier}/refresh-token": { "post": { "tags": [ "TenantApp" ], "operationId": "issueInstalledAppToken_1", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "text/plain": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/node-api-AppTokenDto" } } } } } } }, "/cmn/apps/{identifier}/permitted-token": { "post": { "tags": [ "TenantApp" ], "operationId": "issueTokenByPermission", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/node-api-PermittedTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/node-api-AppTokenDto" } } } } } } }, "/cmn/apps/{appIdentifier}/settings": { "get": { "tags": [ "AppSettings" ], "summary": "find settings by app-identifier", "operationId": "get", "parameters": [ { "name": "appIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-api-AppSettings" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "post": { "tags": [ "AppSettings" ], "summary": "create/update settings", "operationId": "update_152", "parameters": [ { "name": "appIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-api-AppSettings" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-api-AppSettings" } } } }, "422": { "description": "Resource was not valid to process", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "AppSettings" ], "summary": "deletes a settings entry", "operationId": "delete_136", "parameters": [ { "name": "appIdentifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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_138", "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/variant/value-listing/{listingId}": { "patch": { "tags": [ "VariantValueListing" ], "summary": "Partial update existing listing", "operationId": "partialUpdateListing_1", "parameters": [ { "name": "listingId", "in": "path", "description": "Listing-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantValueListing" } } } } } } }, "/erp/variant/attribute-listing/{listingId}": { "patch": { "tags": [ "VariantAttributeListing" ], "summary": "Partial update existing listing", "operationId": "partialUpdateListing_2", "parameters": [ { "name": "listingId", "in": "path", "description": "Listing-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-sales_channel-VariantAttributeListing" } } } } } } }, "/erp/documents/{id}": { "get": { "tags": [ "Document" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_148", "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" } } } } } }, "patch": { "tags": [ "Document" ], "operationId": "patchDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentPatchRequest" } } }, "required": true }, "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/erp/accounts/{accountId}/listings/{listingId}": { "patch": { "tags": [ "account" ], "summary": "Partial update existing listing", "operationId": "partialUpdateListing_3", "parameters": [ { "name": "accountId", "in": "path", "description": "Account-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-account-AccountListing" } } } } } } }, "/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" } } } } } } }, "/cmn/category/{categoryId}": { "patch": { "tags": [ "Category" ], "summary": "Partial update existing category", "operationId": "partialUpdateCategory", "parameters": [ { "name": "categoryId", "in": "path", "description": "Kategorie-ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-masterdata-Category" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common-masterdata-Category" } } } } } } }, "/wms/scannable-code-recognition/process-input/{inputData}": { "get": { "tags": [ "Scanbare-Code-Erkennung" ], "operationId": "processInput_4", "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_149", "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ögliche Skript-Typen für 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/picklists/picking-of-picklist/state": { "get": { "tags": [ "Picklisten" ], "operationId": "getStateOfPickingOfPicklist", "parameters": [ { "name": "picklistNumber", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-wms-PickingState" } } } } } } }, "/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" ], "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": [ "ThirdPartyInfo" ], "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": [ "ShelfPublicAccess" ], "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": { "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" } } } } } } }, "/public/dms-presigned/{id}/download": { "get": { "tags": [ "LocalStorage" ], "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": { "200": { "description": "Response contains File", "content": { "application/*": { "schema": { "type": "object" } } } }, "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" } } } } } } }, "/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ändercode", "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/rma/{documentId}/lines-to-transfer-to-shipping-order": { "get": { "tags": [ "RMA" ], "summary": "Lists goods exchange lines eligible for transfer to shipping order", "operationId": "getGoodsExchangeLinesToTransferIntoShippingOrder", "parameters": [ { "name": "documentId", "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-GoodsExchangeLine" } } } } } } } }, "/erp/rma/{documentId}/lines-to-transfer-to-return": { "get": { "tags": [ "RMA" ], "summary": "Lists all returnable document lines (rooted on the delivery) for transfer", "operationId": "getReturnableLines", "parameters": [ { "name": "documentId", "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-ReturnableLine" } } } } } } } }, "/erp/rma/{documentId}/lines-to-transfer-to-customer-order": { "get": { "tags": [ "RMA" ], "summary": "Lists goods exchange lines eligible for transfer to customer order", "operationId": "getGoodsExchangeLinesToTransferIntoCustomerOrder", "parameters": [ { "name": "documentId", "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-GoodsExchangeLine" } } } } } } } }, "/erp/products/{id}/suppliers": { "get": { "tags": [ "Product" ], "summary": "Für Gebinde: Alle Lieferanten zu Artikeln des Gebindes", "operationId": "getSuppliersByProduct", "parameters": [ { "name": "id", "in": "path", "description": "a product id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ArticleSupplier" } } } } } } } }, "/erp/products/{id}/customers": { "get": { "tags": [ "Product" ], "summary": "Für Gebinde: Alle Kunden zu Artikeln des Gebindes", "operationId": "getCustomersByProduct", "parameters": [ { "name": "id", "in": "path", "description": "a product id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-product-ArticleCustomer" } } } } } } } }, "/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ür den der Preis gilt" } }, { "name": "convertToUnitTypeId", "in": "query", "required": true, "style": "form", "schema": { "type": "string", "description": "Id der Mengeneinheit für 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": "null", "format": "int64", "description": "Ein Produkt" } }, { "name": "accessoryMainArticleId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Ein Hauptprodukt eines Zubehörs" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Ein Account" } }, { "name": "productGroupId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Eine Warengruppe" } }, { "name": "priceGroupId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Eine Preisgruppe" } }, { "name": "manufacturerId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Ein Hersteller" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "null", "format": "date", "description": "Ein Datum" } }, { "name": "quantity", "in": "query", "required": false, "schema": { "type": "null", "format": "double", "description": "Eine Menge" } }, { "name": "noteSpecialOfferPrice", "in": "query", "required": false, "schema": { "type": "null", "description": "Soll ein Aktionspreis beachtet werden?" } }, { "name": "salesChannelId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Ein Verkaufskanal" } }, { "name": "customerGroupId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Eine Kundengruppe" } }, { "name": "supplierGroupId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Eine Lieferantengruppe" } } ], "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ür 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": "null", "format": "int64", "description": "Ein Produkt" } }, { "name": "accessoryMainArticleId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Ein Hauptprodukt eines Zubehörs" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Ein Account" } }, { "name": "productGroupId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Eine Warengruppe" } }, { "name": "priceGroupId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Eine Preisgruppe" } }, { "name": "manufacturerId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Ein Hersteller" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "null", "format": "date", "description": "Ein Datum" } }, { "name": "quantity", "in": "query", "required": false, "schema": { "type": "null", "format": "double", "description": "Eine Menge" } }, { "name": "noteSpecialOfferPrice", "in": "query", "required": false, "schema": { "type": "null", "description": "Soll ein Aktionspreis beachtet werden?" } }, { "name": "salesChannelId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Ein Verkaufskanal" } }, { "name": "customerGroupId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Eine Kundengruppe" } }, { "name": "supplierGroupId", "in": "query", "required": false, "schema": { "type": "null", "format": "int64", "description": "Eine Lieferantengruppe" } } ], "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/schema/{variantSchemaId}": { "get": { "tags": [ "Product-Variant" ], "operationId": "getProductVariantSchema", "parameters": [ { "name": "variantSchemaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-ProductVariantSchema" } } } } } } }, "/erp/pos/register/{posRegisterId}/tss/state": { "get": { "tags": [ "PosRegister" ], "summary": "TSS-Client-Status abfragen", "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/pos/documents/cash-journal-opening/open-document-for-cashdrawer/{cashDrawerId}": { "get": { "tags": [ "PosDocument" ], "summary": "Findet die Kassenbucheröffnung im Status EDIT für eine Kassenschublade", "operationId": "findCashJournalOpeningInEditForCashDrawer", "parameters": [ { "name": "cashDrawerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } } } } }, "/erp/pos/documents/cash-journal-opening/calculated-start-balances/{openingDocumentId}": { "get": { "tags": [ "PosDocument" ], "summary": "Liefert pro bestandsgeführter Zahlungsart der Kasse den errechneten Anfangssaldo (Ist-Endsaldo des letzten geschlossenen Kassenbuchs der Schublade) für eine Kassenbucheröffnung im Status EDIT", "operationId": "getCalculatedStartBalances", "parameters": [ { "name": "openingDocumentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-pos-CashJournalOpeningStartBalance" } } } } } } } }, "/erp/pos/documents/cash-journal-closing/preview/{documentId}": { "get": { "tags": [ "PosDocument" ], "summary": "Liefert Vorschau-Daten zu einem Kassenabschluss-Beleg im Status EDIT: Aggregationen über alle Belege des Kassenbuchs (gruppiert nach Beleg-Kategorie, abgeschlossen vs. nicht-abgeschlossen) sowie die Anfangsbestände aller bestandsgeführten und im Kassenbuch verwendeten Zahlungsarten. Nur für ein offenes Kassenbuch; ist es bereits abgeschlossen, wird die Vorschau abgelehnt.", "operationId": "getCashJournalClosingPreview", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosDocumentClosingPreview" } } } } } } }, "/erp/pos/documents/cash-journal-closing/close-document-for-cashdrawer/{cashDrawerId}": { "get": { "tags": [ "PosDocument" ], "summary": "Findet den Kassenabschluss im Status EDIT für eine Kassenschublade", "operationId": "findCashJournalClosingInEditForCashDrawer", "parameters": [ { "name": "cashDrawerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-document-DocumentResponse" } } } } } } }, "/erp/payments/templates/get_standard": { "get": { "tags": [ "PaymentTemplates" ], "description": "gibt die Standard-Zahlungsträgervorlage für den angegeben Typ zurück", "operationId": "findStandardForType", "parameters": [ { "name": "type", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "PAYMENT_INVOICE", "PAYMENT_CREDIT_NOTE", "PAYMENT_NOT_BOUND", "DIRECT_DEBIT" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-payment-PaymentTemplate" } } } } } } }, "/erp/payments/templates/get_available_fields": { "get": { "tags": [ "PaymentTemplates" ], "description": "gibt die Felder, die in einer Zahlungsvorlage verwendet werden können, zurück", "operationId": "getAvailableFields", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-payment-PaymentTemplateField" } } } } } } } }, "/erp/order-proposal-to-orders-run/{id}": { "get": { "tags": [ "Bestellvorschlag-zu-Bestellungen-Lauf" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_150", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "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/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_151", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/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/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_152", "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/dunnings/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/dunning_run/{id}": { "get": { "tags": [ "DunningRun" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_153", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/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_137", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } }, "404": { "description": "Resource was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } }, "409": { "description": "unable to delete Resource, due to constraints, existing references or internal state", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/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}/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ür Kopf-/Fußtexte zurück", "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ür ein Artikel einer DocumentLine", "operationId": "getPurchasePriceStatistic_1", "parameters": [ { "name": "id", "in": "path", "description": "document id", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "lineId", "in": "path", "description": "ID of the document line", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-product-PurchasePriceStatistic" } } } } } } }, "/erp/documents/{id}/lines/text-templates": { "get": { "tags": [ "Document" ], "summary": "Gibt die manuellen Textbausteine für Textpositionen zurück, die für das Dokument Sinn ergeben", "operationId": "getManualTemplateLines", "parameters": [ { "name": "id", "in": "path", "description": "document id", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-texttemplates-TextTemplate" } } } } } } } }, "/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": { "$ref": "#/components/schemas/erp-document-DeliveryTransferData" } } } } } } }, "/erp/documents/{id}/lines-to-transfer-to-picklist": { "get": { "tags": [ "Document" ], "summary": "List all lines allowed to transfer in customer delivery", "operationId": "getToPicklistTransferableLines", "parameters": [ { "name": "id", "in": "path", "description": "ID of customer order", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DeliveryTransferData" } } } } } } }, "/erp/documents/{id}/lines-to-transfer-to-customer-delivery": { "get": { "tags": [ "Document" ], "summary": "List all lines allowed to transfer in customer delivery", "operationId": "getToCustomerDeliveryTransferableLines", "parameters": [ { "name": "id", "in": "path", "description": "ID of customer order", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-DeliveryTransferData" } } } } } } }, "/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": "getUnassignedDocumentLinesWithBookings", "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-DocumentLineWithBooking" } } } } } } } }, "/erp/documents/{documentId}/availability": { "get": { "tags": [ "Document" ], "operationId": "getOrderLineAvailabilityInfo", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/erp-document-CompleteDocumentAvailabilityInfoApi" } } } } } } }, "/erp/documents/types": { "get": { "tags": [ "Document" ], "summary": "return all available document-state-machine starting states ", "operationId": "getDocumentTypesForCreate", "parameters": [ { "name": "qualifiers", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "SALE", "PURCHASE", "COMMISSION", "SALES_CONTRACT", "PURCHASE_CONTRACT", "POINT_OF_SALE", "FABRICATION", "RMA" ] }, "uniqueItems": true } }, { "name": "languageCode", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-document-DocumentTransitionRef" } } } } } } } }, "/erp/documents/additional-functions/{documentId}/possible-correct-state": { "get": { "tags": [ "DocumentAdditionalFunctions" ], "summary": "Möglichen 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_154", "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äten" ], "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äten" ], "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äten" ], "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_155", "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", "APP" ] } }, { "name": "searchTerm", "in": "path", "description": "Suchbegriff", "required": true, "schema": { "type": "string" } }, { "name": "providerId", "in": "path", "description": "ID des Banking-Providers", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/erp-bank-BankRef" } } } } } } } }, "/erp/bank/payments/{paymentId}/checkStatus": { "get": { "tags": [ "BankPayment" ], "operationId": "checkStatus", "parameters": [ { "name": "paymentId", "in": "path", "description": "ID der Zahlung", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-bank-BankPayment" } } } } } } }, "/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/payment_runs/{id}": { "get": { "tags": [ "BankPaymentRun" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_156", "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-bank-BankPaymentRun" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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/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}/supply-storages": { "get": { "tags": [ "ArticleStorage" ], "operationId": "getArticleSupplyStorages", "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": { "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}/languages-available-for-article": { "get": { "tags": [ "Article" ], "operationId": "getLanguagesBySalesChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "salesChannelId", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/erp/articles/{id}/bundle-conversion-info": { "get": { "tags": [ "ArticleStorage" ], "operationId": "getArticleBundleConversionInfo", "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-ArticleBundleConversionInfo" } } } } } } }, "/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, einer Pickliste 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" } }, { "name": "picklistId", "in": "query", "description": "Pickliste", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "locale", "in": "query", "description": "Sprache (ISO-Alpha2)", "required": false, "schema": { "type": "string" } } ], "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_157", "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_1", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "CUSTOMER", "SUPPLIER", "MANUFACTURER", "SERVICE_PROVIDER", "MERCHANT", "SALES_AGENT", "COMPANY", "PROSPECTIVE" ] } } } } } } } }, "/dms/wiki/{id}/tree": { "get": { "tags": [ "Wiki" ], "operationId": "readTree", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-wiki-WikiTreeNodeDto" } } } } } } }, "/dms/wiki/{id}/revision/{revisionId}": { "get": { "tags": [ "Wiki" ], "operationId": "getRevision", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "revisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-wiki-WikiPageDto" } } } } } } }, "/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ünschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } }, "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" } } } } } } }, "/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ünschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response contains File", "content": { "application/*": { "schema": { "type": "object" } } } }, "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" } } } } } } }, "/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ünschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } }, "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" } } } } } } }, "/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": { "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } }, "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" } } } } } } }, "/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ünschte Content-Disposition vom Request", "required": false, "schema": { "type": "string" } }, { "name": "If-None-Match", "in": "header", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Response contains File", "content": { "application/json": { "schema": { "type": "object" } } } }, "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" } } } } } } }, "/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/pos/payment/orders/{externalPaymentId}": { "get": { "tags": [ "PosPayment" ], "summary": "Zahlung anhand der externen Payment-ID abrufen", "operationId": "getByExternalPaymentId", "parameters": [ { "name": "externalPaymentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentOrder" } } } } } } }, "/erp/finance/booking/{id}": { "get": { "tags": [ "FinanceBooking" ], "operationId": "getById_158", "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}/subscription": { "get": { "tags": [ "Aufgaben" ], "summary": "Liefert alle Subscription auf dem Geschäftsobjekt", "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-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}/subscription": { "get": { "tags": [ "Projekte" ], "summary": "Liefert alle Subscription auf dem Geschäftsobjekt", "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/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äftsobjekt", "operationId": "getSubscriber_2", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } } } } } } }, "/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äftsobjekt", "operationId": "getSubscriber_3", "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/create-template-meta": { "get": { "tags": [ "account" ], "summary": "Liefert die Parameter-Meta-Beschreibung der Adressvorlage", "operationId": "getCreateTemplateMeta", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/cmn/system/app-message-webhook/destinations": { "get": { "tags": [ "AppMessage" ], "summary": "list all available webhook-queues", "operationId": "getDestinations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-system-AppMessageQueueDefinition.QueueDestinationDescription" } } } } } } } }, "/cmn/secrets/by-name/{name}": { "get": { "tags": [ "Secret Storage" ], "summary": "Secret anhand des Namens laden", "operationId": "getByName", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-SecretStorage" } } } } } }, "delete": { "tags": [ "Secret Storage" ], "summary": "Secret anhand des Namens löschen", "operationId": "deleteByName", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/cmn/scripting/typescript-declarations": { "get": { "tags": [ "Scripting" ], "operationId": "getTypeScriptDeclarations", "parameters": [ { "name": "onlyEav", "in": "query", "description": "Sollen nur EAV-Typen ausgespielt werden?", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/cmn/scripting/script/runs/{runId}": { "get": { "tags": [ "Scripting" ], "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": [ "Scripting" ], "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": [ "Scripting" ], "operationId": "getModules", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/cmn/scripting/markdown-documentation": { "get": { "tags": [ "Scripting" ], "operationId": "getMarkdownDocumentation", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/cmn/scripting/deprecation-log/{id}": { "get": { "tags": [ "Scripting" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_159", "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-ScriptDeprecationLog" } } } }, "404": { "description": "Resource with given ID was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } }, "delete": { "tags": [ "Scripting" ], "summary": "Delete an existing Resource", "operationId": "delete_138", "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/queue/{id}": { "get": { "tags": [ "Output-Queue" ], "summary": "Find an existing Resource by identifier", "operationId": "getById_160", "parameters": [ { "name": "id", "in": "path", "description": "an identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "successful operation", "content": { "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_161", "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/variant/schema/{id}/attributes": { "get": { "tags": [ "VariantSchema" ], "operationId": "getAllAttributesForVariantSchema", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-variant-VariantAttribute" } } } } } } } }, "/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": "convertOneUnit", "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", "SALES_AGENT", "POS_REGISTER", "CASH_DRAWER", "POS_PAYMENT_METHOD", "POS_DEPOSIT_EXPENSE_TYPE", "COMMISSION_RUN_SALES_AGENT" ] } } ], "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", "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ähigen' 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ür 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": {} } } } } } } }, "/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": { "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" } } } } } } }, "/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/{id}/parameter": { "get": { "tags": [ "Output-Module" ], "operationId": "getParameter_1", "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/{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_162", "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ür 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": {} } } } } } } }, "/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/output/modules/{moduleKey}/additional-options-meta": { "get": { "tags": [ "Output-Module" ], "summary": "Parameter-Meta-Beschreibung der modulspezifischen Zusatz-Optionen", "operationId": "getAdditionalOptionsMeta", "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": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/common-ftsearch-SearchResult" } } } } }, "422": { "description": "query was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/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": { "type": "array", "items": { "type": "string" }, "uniqueItems": true } } } } } } }, "/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": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-ftsearch-SearchResult" } } } }, "422": { "description": "query was not valid to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/core-error-ApiError" } } } } } } }, "/cmn/emails/failures/{failureId}": { "get": { "tags": [ "Email" ], "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": { "type": "array", "items": { "type": "string", "enum": [ "NOT_YET_RUN", "ERRONEOUS", "SUCCESSFUL", "IGNORED", "OUT_OF_BOUNDS", "MANUALLY_IGNORED", "MANUALLY_COMPLETED" ] }, "uniqueItems": true } }, { "name": "validationStates", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "NOT_YET_RUN", "ERRONEOUS", "SUCCESSFUL", "IGNORED", "OUT_OF_BOUNDS", "ALREADY_COMPLETED" ] }, "uniqueItems": true } }, { "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/data-import/rule-sets/importable-types/{key}": { "get": { "tags": [ "ImportRuleSet" ], "operationId": "getImportableType", "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$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" ] } }, { "name": "depth", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "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/fields": { "get": { "tags": [ "computed-queries" ], "operationId": "getFields", "parameters": [ { "name": "entityIdentifier", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "visibility", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "INTERNAL", "SUPPORT", "API", "PUBLIC" ] } }, { "name": "verbose", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-cunit-CuEntityInfo" } } } } } } } }, "/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": [ "Änderungsprotokoll" ], "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": [ "Änderungsprotokoll" ], "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_1", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/core-api-AfterTenantMigrationActionExecutionHistory" } } } } } } } }, "/cmn/apps/installed": { "get": { "tags": [ "TenantApp" ], "operationId": "getInstalledApps", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/node-api-InstalledAppDto" } } } } } } } }, "/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_163", "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_139", "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_2", "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", "APP" ] } } ], "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", "APP" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/banking-api-BankInitializerParameter" } } } } } } } }, "/app-traces": { "get": { "tags": [ "Trace" ], "operationId": "allTraces", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/app-traces/{key}": { "get": { "tags": [ "Trace" ], "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/finance/dunning_run/{id}/dunnings": { "delete": { "tags": [ "DunningRun" ], "operationId": "deleteDunnings", "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/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", "APP" ] } } ], "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ünschte 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. über Systemeinstellungen", "operationId": "customRemoveLock", "parameters": [ { "name": "token", "in": "path", "description": "Token einer Sperre", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/core-api-OperationMessage" } } } } } } }, "/banking/banking-webform/{id}": { "delete": { "tags": [ "BankingWebform" ], "summary": "Delete an existing Resource", "operationId": "delete_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/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": { "description": "Abschluss-Protokoll", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "logTime": { "type": "string", "format": "date-time", "description": "logTime", "readOnly": true }, "origin": { "type": "string", "description": "log level", "enum": [ "DEBUG", "INFO", "WARNING", "ERROR", "CONSOLE", "STACKTRACE" ], "readOnly": true }, "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } } }, "core-api-ApiObjectReference": { "description": "Übergeordnete Kategorie", "properties": { "id": { "type": "string", "description": "Identifier" }, "label": { "type": "string", "description": "a label", "readOnly": true }, "description": { "type": "string", "description": "a short description", "readOnly": true }, "active": { "type": "boolean", "description": "Activ", "readOnly": true } }, "required": [ "id" ] }, "core-api-LocalizeableMessage": { "description": "localizeable message", "properties": { "messageCode": { "type": "string", "description": "Internal unique identifier/key for this message" }, "messageParameters": { "type": "object", "additionalProperties": { "type": "object", "description": "list of parameters to fill a formattable message" }, "description": "list of parameters to fill a formattable message" }, "formattedMessage": { "type": "string", "description": "formatted message (default language)" } } }, "core-api-MetaInfo": { "description": "MetaInformations for this Object", "properties": { "createdAt": { "type": "string", "format": "date-time", "description": "Created At Timestamp", "readOnly": true }, "createdFrom": { "type": "string", "description": "TenantUser-Identifier of the creator", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last Updated AT Timestamp", "readOnly": true }, "updatedFrom": { "type": "string", "description": "TenantUser-Identifier of most recent updater", "readOnly": true } } }, "erp-document-DocumentRef": { "description": "Referenz auf ein Document", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID" }, "category": { "type": "string", "description": "Dokumenttypen", "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_PROFORMA_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PROGRESS_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PROGRESS_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_DEPOSIT_INVOICE", "CUSTOMER_DEPOSIT_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "CUSTOMER_RETURN_ANNOUNCEMENT", "CUSTOMER_GOODS_RETURN", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "SUPPLIER_DEPOSIT_INVOICE", "SUPPLIER_PROGRESS_INVOICE", "SUPPLIER_PARTIAL_INVOICE", "SUPPLIER_FINAL_INVOICE", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "SUPPLIER_COMMISSION_CREDIT_NOTE", "SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_RETURN_CASH_RECEIPT", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_WITHDRAWAL", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ] }, "documentType": { "type": "string", "description": "Belegart" }, "documentState": { "type": "string", "description": "Belegstatus" }, "number": { "type": "string", "description": "Belegnummer" } }, "required": [ "id" ] }, "erp-product-ArticleSerialNumber": { "description": "Seriennummer", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumber1": { "type": "string", "description": "Seriennummer 1", "maxLength": 255, "minLength": 0 }, "serialNumber2": { "type": "string", "description": "Seriennummer 2", "maxLength": 255, "minLength": 0 }, "expiryDate": { "type": "string", "format": "date", "description": "Haltbarkeitsdatum" }, "note": { "type": "string", "description": "Notiz" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "udi": { "type": "string", "description": "Unique Device Identifier (UDI)" } }, "required": [ "articleRef", "serialNumber1" ] }, "erp-stock-StorageBinRef": { "description": "Lagerplatz", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID" }, "displayName": { "type": "string", "description": "Anzeigename" }, "routePosition": { "type": "integer", "format": "int32", "description": "Laufwegposition" }, "color": { "type": "string", "description": "Anzeigefarbe" }, "storageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-wms-ReplenishmentProposal": { "description": "Nachschubvorschlag", "properties": { "version": { "type": "string", "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", "enum": [ "OPEN", "FINISHED", "CANCELLED" ], "readOnly": true }, "picklistRefs": { "type": "array", "description": "Nachschub-Picklisten", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true }, "sourceDocumentRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "targetDocumentRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "finishLogLines": { "type": "array", "description": "Abschluss-Protokoll", "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" }, "readOnly": true }, "lines": { "type": "array", "description": "Positionen", "items": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalLine" } } } }, "erp-wms-ReplenishmentProposalLine": { "description": "Position vom Nachschubvorschlag", "properties": { "version": { "type": "string", "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" }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ], "readOnly": true }, "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ächliche Nachschubmenge" }, "bookings": { "type": "array", "description": "Buchungsdetails", "items": { "$ref": "#/components/schemas/erp-wms-ReplenishmentProposalLineBooking" } } }, "required": [ "articleRef", "proposedQuantity", "replenishedQuantity", "sourceStorageRef", "targetStorageRef" ] }, "erp-wms-ReplenishmentProposalLineBooking": { "description": "Buchungsdetails vom Nachschubvorschlag", "properties": { "version": { "type": "string", "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" } }, "required": [ "quantity", "storageBinRef" ] }, "unknownservice-unknownmodule-JsonNode": { "description": "Search-Dialog", "properties": { "empty": { "type": "boolean" }, "array": { "type": "boolean" }, "null": { "type": "boolean" }, "object": { "type": "boolean" }, "float": { "type": "boolean" }, "binary": { "type": "boolean" }, "pojo": { "type": "boolean" }, "valueNode": { "type": "boolean" }, "container": { "type": "boolean" }, "integralNumber": { "type": "boolean" }, "floatingPointNumber": { "type": "boolean" }, "bigDecimal": { "type": "boolean" }, "bigInteger": { "type": "boolean" }, "textual": { "type": "boolean", "deprecated": true }, "boolean": { "type": "boolean" }, "nodeType": { "type": "string", "enum": [ "ARRAY", "BINARY", "BOOLEAN", "MISSING", "NULL", "NUMBER", "OBJECT", "POJO", "STRING" ] }, "string": { "type": "boolean" }, "short": { "type": "boolean" }, "int": { "type": "boolean" }, "long": { "type": "boolean" }, "double": { "type": "boolean" }, "missingNode": { "type": "boolean" }, "number": { "type": "boolean" }, "embeddedValue": { "type": "boolean" } } }, "core-error-ApiError": { "properties": { "instance": { "type": "string", "description": "the resource that produced the error", "readOnly": true }, "trackingId": { "type": "string", "description": "Internal tracking number for this Error", "readOnly": true }, "timeOfOccurence": { "type": "string", "format": "date-time", "description": "Internal timestamp, when this error happened", "readOnly": true }, "errors": { "$ref": "#/components/schemas/core-error-ApiError.Errors" }, "decisions": { "type": "array", "description": "all decisions, we need to take care of", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDecision" }, "readOnly": true, "uniqueItems": true }, "httpStatus": { "type": "integer", "format": "int32", "description": "HTTP-Status code" }, "debug-info-url": { "type": "string", "format": "uri", "description": "optional url to get a more detailed stack trace", "readOnly": true } }, "required": [ "decisions", "errors", "instance", "timeOfOccurence", "trackingId" ] }, "core-error-ApiError.Errors": { "description": "all occured errors", "properties": { "fieldErrors": { "type": "object", "additionalProperties": { "type": "array", "description": "One or more validation errors", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" }, "readOnly": true, "uniqueItems": true }, "description": "One or more validation errors", "readOnly": true }, "services": { "type": "array", "description": "One or more generel service errors", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" }, "readOnly": true, "uniqueItems": true } }, "readOnly": true, "required": [ "fieldErrors", "services" ] }, "core-error-ApiErrorDecision": { "description": "all decisions, we need to take care of", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "title": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "multipleAnswersAllowed": { "type": "boolean", "default": false, "description": "true, if an array of answers is required", "readOnly": true }, "textInput": { "type": "boolean", "default": false, "description": "true, if text input instead of decisions is required", "readOnly": true }, "options": { "type": "array", "description": "possible options for this decision", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDecision.DecisionOption" }, "readOnly": true }, "answerProperty": { "type": "string", "description": "property to fill the decision into", "readOnly": true }, "answerPropertyType": { "type": "string", "description": "type of the target property", "enum": [ "FIELD", "PARAMETER" ], "readOnly": true }, "searchDialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "readOnly": true }, "core-error-ApiErrorDecision.DecisionOption": { "description": "possible options for this decision", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "value": { "type": "string", "description": "value for this decision", "readOnly": true }, "defaultOption": { "type": "boolean", "default": false, "description": "default option", "readOnly": true }, "searchDialogs": { "type": "array", "description": "Zu verwendende Search-Dialogs", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog" }, "readOnly": true } } }, "core-error-ApiErrorDecision.DecisionOptionSearchDialog": { "description": "Zu verwendende Search-Dialogs", "properties": { "dialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "answerKey": { "type": "string", "description": "Schlüssel für das Ergebnis vom Search-Dialog", "readOnly": true } } }, "core-error-ApiErrorDetail": { "description": "One or more generel service errors", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "property": { "type": "string", "description": "property that has a constraint violation (optional)" } }, "readOnly": true }, "common-output-OutputRecipient.MailRecipient": { "description": "Empfänger", "properties": { "type": { "type": "string", "description": "(mail) recipient type", "enum": [ "TO", "CC", "BCC" ] }, "address": { "type": "string", "description": "(mail) recipient address" }, "name": { "type": "string", "description": "(mail) recipient name" } } }, "common-output-OutputRequest": { "properties": { "exportFormat": { "type": "string", "description": "output-format für mail/file-export", "enum": [ "PDF", "XLSX", "JSON_RAW", "REPORT_TEMPLATE" ] }, "exportFilename": { "type": "string", "description": "filename (ohne extension) bei einem file-export" }, "mailRecipients": { "type": "array", "description": "Empfänger", "items": { "$ref": "#/components/schemas/common-output-OutputRecipient.MailRecipient" } }, "outputType": { "type": "string", "description": "outputType" }, "groupIdentifier": { "type": "string", "description": "OutputReportGroup Identifier (optional), sonst Default-Group des Moduls" }, "published": { "type": "boolean", "default": false, "description": "sollen nur bereits veröffentlichte Dokumente beachtet werden?" } } }, "erp-wms-ReplenishmentProposalTemplate": { "description": "Vorlage zur Erstellung von Nachschubvorschlägen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Name der Vorlage", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung der Vorlage" }, "active": { "type": "boolean", "description": "Aktiv?" }, "finishingType": { "type": "string", "default": "PICKLISTS", "description": "Wie soll die Umlagerung des Nachschubs durchgeführt werden?", "enum": [ "PICKLISTS", "DOCUMENTS", "PRINT_AND_TRANSFER" ] }, "cycleToCreateReplenishmentProposalCronExpression": { "type": "string", "description": "Zyklus zur Erstellung von Nachschubvorschlägen (für 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ätzliche Exists-Statements in VQL", "items": { "type": "string", "description": "Zusätzliche Exists-Statements in VQL" } }, "targetStorageId": { "type": "integer", "format": "int64", "description": "Bestimmtes Ziel-Lager für den Nachschubvorschlag" }, "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", "format": "int32", "description": "Nur Artikel mit Verkäufen in den letzten n Tagen" }, "onlySalesStoragesAsTarget": { "type": "boolean", "default": false, "description": "Nur Verkaufslager beachten" }, "considerReservedQuantities": { "type": "boolean", "default": false, "description": "Reserviert-Mengen beachten" }, "considerOrderedQuantities": { "type": "boolean", "default": false, "description": "Bestellt-Mengen beachten" }, "considerActualAvailableQuantities": { "type": "boolean", "default": true, "description": "Tatsächliche verfügbare Mengen beachten. Optionen zu Reserviert- und Bestellt-Mengen werden dabei nicht mehr beachtet, da diese Werte ggf. schon in die Verfügbarkeitsermittlung eingeflossen sind" }, "sortByRoutePosition": { "type": "boolean", "default": true, "description": "Positionen der Pickliste nach Laufwegposition sortieren" }, "specifyStorageBins": { "type": "boolean", "default": true, "description": "Lagerplätze vorgeben" }, "specifySerialWithOldestExpiryDate": { "type": "boolean", "default": false, "description": "Automatische Ermittlung von S/N oder Chargen sortiert über das Verfallsdatum" }, "replenishBaseArticleOfBundle": { "type": "boolean", "default": false, "description": "Basisgebinde nachlegen" }, "replenishmentProposalOutputReportGroupId": { "type": "integer", "format": "int64", "description": "ID der Reportgruppe zum Druck des Nachschubvorschlags" } }, "required": [ "label" ] }, "erp-wms-PickTrolley": { "description": "Pickwagen", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "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", "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" ], "readOnly": true }, "processedByUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "currentPicklistId": { "type": "integer", "format": "int64", "description": "Wagen gehört aktuell zu dieser Pickliste", "readOnly": true }, "pickTrolleyGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "storageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "pickTrolleyBoxes": { "type": "array", "description": "Zu diesem Wagen gehörende Boxen", "items": { "$ref": "#/components/schemas/erp-wms-PickTrolleyBox" } }, "picklistTemplateRefs": { "type": "array", "description": "Picklistenvorlagen, welche genutzt werden können, um in der MDE Picklisten zu dem Wagen zu erzeugen", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "required": [ "label" ] }, "erp-wms-PickTrolleyBox": { "description": "Pickbox", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung der Box" }, "identifier": { "type": "string", "description": "Barcode zur Selektion der Box" }, "state": { "type": "string", "description": "Status der Pickbox", "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" ], "readOnly": true }, "currentDocumentId": { "type": "integer", "format": "int64", "description": "Aktuell kommissionierter Beleg" }, "pickTrolleyId": { "type": "integer", "format": "int64", "description": "Box gehört zu diesem Pickwagen" } }, "required": [ "label", "pickTrolleyId" ] }, "erp-wms-PickTrolleyGroup": { "description": "Pickwagen-Gruppe", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung der Gruppe" }, "pickTrolleys": { "type": "array", "description": "Zur Gruppe gehörende Pickwagen", "items": { "$ref": "#/components/schemas/erp-wms-PickTrolley" } } }, "required": [ "label" ] }, "erp-wms-PicklistCancellationResult": { "description": "Ergebnis der Stornierung einer Pickliste", "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äge", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } } }, "erp-wms-PicklistTemplate": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "picklistCreationOptions": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate.PicklistCreationOptions" }, "orderSelectionOptions": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate.OrderSelectionOptions" }, "picklistProcessingOptions": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate.PicklistProcessingOptions" }, "label": { "type": "string", "description": "Name der Vorlage", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung der Vorlage" }, "pickingType": { "type": "string", "description": "Art der Kommissionierung", "enum": [ "FAST_ORDER_PICKING", "SINGLE_ORDER_PICKING", "COLLECTIVE_ORDER_PICKING", "ROLLING_ORDER_PICKING", "CONSOLIDATION", "REPLENISHMENT", "FABRICATION", "MISSING_GOODS_PICKING", "INCORRECTLY_PICKED_GOODS" ] }, "defaultTemplate": { "type": "boolean", "default": false, "description": "Handelt es sich um eine Standard-Vorlage?" }, "active": { "type": "boolean", "default": true, "description": "Is Template active?", "readOnly": true }, "picklistScripts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate.PicklistScript" }, "description": "Skripte für die Erstellung und Verarbeitung von Picklisten" } }, "required": [ "label", "pickingType" ] }, "erp-wms-PicklistTemplate.DateRange": { "description": "Selektion über einen Datumsbereich", "properties": { "from": { "type": "string", "description": "Datum von (ggf. als relatives Datum)" }, "to": { "type": "string", "description": "Datum bis (ggf. als relatives Datum)" }, "allowEmpty": { "type": "boolean", "default": true, "description": "Datumsbereich darf leer sein" } } }, "erp-wms-PicklistTemplate.OrderSelectionOptions": { "description": "Optionen zur Selektion von Aufträgen", "properties": { "maxOrderCount": { "type": "integer", "format": "int64", "description": "Nur für Einzelkommissionierung und Konsolidierung: maximale Anzahl zu übernehmender Aufträge" }, "alternativeSelectionInVql": { "type": "string", "description": "Alternative Selektion in VQL" }, "additionalExistsStatementsInVql": { "type": "array", "description": "Zusätzliche Exists-Statements in VQL", "items": { "type": "string", "description": "Zusätzliche Exists-Statements in VQL" } }, "deliveryMethodRefs": { "type": "array", "description": "Liste der gültigen Lieferarten", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "allowOnlyDefinedDeliveryMethods": { "type": "boolean", "description": "dürfen nur gültige Lieferarten genutz werden?" }, "documentTypeRefs": { "type": "array", "description": "Liste der Belegarten vom Belegtyp \"Auftrag\"", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "documentDateRange": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate.DateRange" }, "deliveryDateRange": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate.DateRange" }, "confirmedDeliveryDateRange": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate.DateRange" }, "onlyFullDeliverableOrders": { "type": "boolean", "default": false, "description": "Nur vollständig lieferbare Aufträge" }, "onlyFullDeliverableOrderLines": { "type": "boolean", "default": false, "description": "Nur vollständig lieferbare Positionen" }, "storageAreaRefs": { "type": "array", "description": "Liste von gültigen Lagerbereichen", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "salesChannelId": { "type": "integer", "format": "int64", "description": "Id des salesChannels der bei der Selektion berücksichtigt wird" }, "minArticleCountPerOrder": { "type": "integer", "format": "int32", "description": "Minimale Anzahl Artikel pro Auftrag" }, "maxArticleCountPerOrder": { "type": "integer", "format": "int32", "description": "Maximale Anzahl Artikel pro Auftrag" }, "maxShippingWeightPerOrder": { "type": "number", "description": "Maximales Versandgewicht pro Auftrag" }, "maxTotalVolumePerOrderInCCM": { "type": "number", "description": "Maximales Gesamtvolumen pro Auftrag (in ccm)" }, "maxOrderValue": { "type": "number", "description": "Maximaler Auftragswert" } } }, "erp-wms-PicklistTemplate.PicklistCreationOptions": { "description": "Optionen zur Erstellung von Picklisten", "properties": { "sortByRoutePosition": { "type": "boolean", "default": true, "description": "Positionen der Pickliste nach Laufwegposition sortieren" }, "maxPicklistLineCount": { "type": "integer", "format": "int64", "description": "Maximale Anzahl an Positionen einer Pickliste" }, "maxQuantityOfOrderLineForFastOrderPicking": { "type": "integer", "format": "int64", "default": 1, "description": "Maximale Menge einer Auftragsposition für Schnellkommissionierungs-Picklisten" }, "orderPickingTrolleyRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "orderPickingTrolleyGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "useAllAvailOrderPickingTrolleys": { "type": "boolean", "default": false, "description": "Sollen alle verfügbaren Pickwagen verwendet werden?" }, "cycleToCreatePicklistsCronExpression": { "type": "string", "description": "Zyklus zur Erstellung von Picklisten (für Background-Jobs, als Quartz-Cron-Expression) (https://www.freeformatter.com/cron-expression-generator-quartz.html)" }, "specifyStorageBins": { "type": "boolean", "default": true, "description": "Lagerplätze vorgeben" }, "specifySerialWithOldestExpiryDate": { "type": "boolean", "default": false, "description": "Für Serien-Artikel mit Verfallsdatum/MHD: älteste Serie in Pickliste vorgeben" }, "firstCreateFastOrderPickingPicklists": { "type": "boolean", "default": false, "description": "Sollen zuerst noch Picklisten für die Schnellkommissionierung erzeugt werden?" }, "fastOrderPickingTemplateToUseRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "printPicklist": { "type": "boolean", "default": false, "description": "Soll die Pickliste gedruckt werden?" }, "picklistOutputReportGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "printLabelsOnCreation": { "type": "boolean", "default": false, "description": "Soll nach der Erstellung automatisch die Etiketten gedruckt werden?" } } }, "erp-wms-PicklistTemplate.PicklistProcessingOptions": { "description": "Optionen für die Verarbeitung von Picklisten", "properties": { "autoPrintDeliveryDocument": { "type": "boolean", "default": false, "description": "Soll die Lieferbelege automatisch nach Abschluss der Kommissionierung gedruckt werden?" }, "autoPrintShippingLabel": { "type": "boolean", "default": false, "description": "Sollen die Paketlabel automatisch nach Abschluss der Kommissionierung gedruckt werden?" }, "alwaysRequireScanOfStorageBin": { "type": "boolean", "default": false, "description": "Lagerplätze müssen erfasst werden, trotz Vorgabe" }, "articleScanRequirement": { "type": "string", "default": "FREE", "description": "Erfassungsbedingung für Artikel", "enum": [ "FREE", "SCAN_ONCE", "SCAN_ALWAYS" ] }, "autoDeterminationOfLots": { "type": "boolean", "default": false, "description": "Chargen automatisch bestätigen, wenn sie vorgegeben oder bereits beim Picken erfasst wurden" }, "hideTargetQuantityInViews": { "type": "boolean", "default": false, "description": "Zielmengen in Masken verstecken?" }, "allowPickingOfServiceArticles": { "type": "boolean", "default": false, "description": "Sollen Dienstleistungen kommissioniert werden?" }, "allowPickingOfNonInventoryManagedArticles": { "type": "boolean", "default": false, "description": "Sollen nicht-bestandsgeführte Artikel kommissioniert werden?" }, "allowFullConfirmation": { "type": "boolean", "default": false, "description": "Sammelbestätigung erlauben" }, "deviatingQuantity": { "type": "string", "description": "Kommissionierung von abweichenden Mengen", "enum": [ "ALLOW_ONLY_ORDERED_QUANTITY", "ALLOW_MINOR_QUANTITY", "ALLOW_OVER_DELIVERY", "ALLOW_DEVIATING_QUANTITY" ] }, "assemblyGroupAtOnce": { "type": "boolean", "default": false, "description": "Baugruppen als Ganzes kommissionieren" }, "alwaysShowDeliveryMethod": { "type": "boolean", "default": true, "description": "Immer die Lieferbedingung in Masken zeigen" }, "showShippingFormOnPickingFinish": { "type": "boolean", "default": false, "description": "Versand-Dialog beim Abschluss zeigen" }, "autoPickingFinishAfterLastArticleInOrder": { "type": "boolean", "default": false, "description": "Automatischer Abschluss nach letztem Artikel vom aktuellen Auftrag" }, "useDigitalPicklist": { "type": "boolean", "default": false, "description": "Digitale Pickliste verwenden: dabei werden nur die Positionen im Frontend gezeigt und durch Tippen oder Wischen bestätigt" }, "usePickNPack": { "type": "boolean", "default": false, "description": "Pick'n'Pack verwenden" }, "scanDeliveryDocumentAndShippingLabelOnFinish": { "type": "boolean", "default": false, "description": "Nur für Konsolidierung: Lieferbeleg und Versandlabel zum Abschluss scannen" }, "scanPickTrolleyBoxToConfirmPickedArticle": { "type": "boolean", "default": false, "description": "Rollende Kommissionierung/Konsolidierung: beim Sammeln muss die Box nach dem Scan eines Artikels per Scan bestätigt werden" }, "blockIfMaximumPackageWeightIsExceeded": { "type": "boolean", "default": true, "description": "Überschreitung vom maximalen Paketgewicht blockieren?" }, "useSalesUnit": { "type": "boolean", "default": false, "description": "Verwende die Verkaufseinheit als Standardmenge" }, "printLabelOnScan": { "type": "boolean", "default": false, "description": "Sollen bei der Erfassung automatisch die Etiketten gedruckt werden?" }, "printLabelOnCompleteOrder": { "type": "boolean", "default": false, "description": "Sollen bei Abschluss des Auftrages automatisch die Etiketten gedruckt werden?" }, "printLabelAfterPicking": { "type": "boolean", "default": false, "description": "Sollen bei Abschluss des des Pickens automatisch die Etiketten gedruckt werden?" }, "allowSkipPosition": { "type": "boolean", "default": false, "description": "Ist das Überspringen von Positionen erlaubt?" } } }, "erp-wms-PicklistTemplate.PicklistScript": { "description": "Ein Picklisten-Skript", "properties": { "source": { "type": "string", "description": "Der Quelltext vom Skript" }, "active": { "type": "boolean", "default": false, "description": "Ist das Skript aktiv?" } } }, "erp-wms-Inventory": { "description": "Inventurkopf", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung dieser Inventur" }, "type": { "type": "string", "description": "Inventurarten", "enum": [ "INITIAL", "CLOSING_DATE" ] }, "state": { "type": "string", "description": "Status der Inventur", "enum": [ "CREATED", "OPENED", "CLOSED", "FINISHED", "DELETED" ], "readOnly": true }, "deadline": { "type": "string", "format": "date", "description": "Stichtag der Inventur" }, "currentRevision": { "type": "integer", "format": "int32", "description": "Aktuelle Revision der Inventur", "readOnly": true }, "storage": { "$ref": "#/components/schemas/erp-wms-InventoryStorage" } }, "required": [ "deadline", "label", "storage", "type" ] }, "erp-wms-InventoryStorage": { "description": "Lager in der Inventur", "properties": { "version": { "type": "string", "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ählt werden sollen", "items": { "$ref": "#/components/schemas/erp-wms-InventoryStorageArea" } }, "inventoryStorageBins": { "type": "array", "description": "Bestimmte Lagerplätze des Lagers, welche dann nur gezählt werden sollen", "items": { "$ref": "#/components/schemas/erp-wms-InventoryStorageBin" } }, "areas": { "type": "array", "description": "Für diese Inventur definitierte Bereiche im Lager (zur Unterscheidung der Zähllisten", "items": { "type": "string", "description": "Für diese Inventur definitierte Bereiche im Lager (zur Unterscheidung der Zähllisten" } } }, "required": [ "storageRef" ] }, "erp-wms-InventoryStorageArea": { "description": "Lagerbereich in der Inventur", "properties": { "version": { "type": "string", "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" } } }, "erp-wms-InventoryStorageBin": { "description": "Lagerplatz in der Inventur", "properties": { "version": { "type": "string", "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" } } }, "common-api-AdditionalParameter": { "description": "Zusätzliche Parameter", "properties": { "key": { "type": "string", "description": "key for this parameter" }, "value": { "type": "object", "description": "value for this parameter" } }, "required": [ "key" ] }, "erp-wms-FoundArticleToBookIntoInventory": { "description": "Gefundener Artikel der noch in eine Inventur gebucht werden soll", "properties": { "articleId": { "type": "integer", "format": "int64", "description": "ID vom nachzubuchenden Artikel" }, "storageId": { "type": "integer", "format": "int64", "description": "Nur ohne Lagerplätze: ID des Lagers, in dem sich der Artikel befinden soll" }, "storageBinId": { "type": "integer", "format": "int64", "description": "Nur bei Lagern mit Lagerplätzen: ID vom Lagerplatz, auf dem sich der Artikel befinden soll" }, "serialNumberId": { "type": "integer", "format": "int64", "description": "Ggf. die nachzubuchende Seriennummer" }, "quantity": { "type": "number", "description": "Zu buchende Menge" } } }, "erp-wms-InventoryStateTransitionRequest": { "description": "Request zur State-Transition einer Inventur", "properties": { "transitionId": { "type": "integer", "format": "int64", "description": "ID der Transition" }, "parameters": { "type": "array", "description": "Zusätzliche Parameter für die Transition", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } }, "foundArticlesToBookIntoInventory": { "type": "array", "description": "Nur für eine geschlossene Inventur: Liste von nachträglich gefundenen Artikeln, die noch nachgebucht werden sollen", "items": { "$ref": "#/components/schemas/erp-wms-FoundArticleToBookIntoInventory" } } } }, "erp-wms-ArticleWithPurchasePrice": { "description": "Artikel mit Einkaufspreis", "properties": { "articleId": { "type": "integer", "format": "int64", "description": "Artikel" }, "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" } }, "required": [ "articleId" ] }, "erp-wms-InventoryCounting": { "description": "Position der Zähllisten der Inventur", "properties": { "version": { "type": "string", "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", "format": "int64", "description": "Inventur" }, "articleId": { "type": "integer", "format": "int64", "description": "Artikel" }, "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ählte Menge" }, "revision": { "type": "integer", "format": "int32", "description": "Revision der Zählung", "readOnly": true }, "createdByFoundArticle": { "type": "boolean", "description": "Wurde diese Zählung durch einen nachträglich gefundenen Artikel erzeugt?", "readOnly": true } }, "required": [ "articleId", "inventoryId", "quantity" ] }, "common-masterdata-CurrencyReference": { "description": "Währung", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID der Währung" }, "isoAlpha3": { "type": "string", "description": "IsoAlpha3-Code der Währung" }, "label": { "type": "string", "description": "Bezeichnung der Währung", "readOnly": true }, "symbol": { "type": "string", "description": "Symbol der Währung", "readOnly": true } } }, "common-masterdata-UnitTypeReference": { "description": "net weight unit", "properties": { "id": { "type": "integer", "format": "int64", "description": "unit type id" }, "name": { "type": "string", "description": "descriptive name", "maxLength": 255, "minLength": 0 }, "abbreviation": { "type": "string", "description": "unique abbreviation", "maxLength": 255, "minLength": 0 } }, "required": [ "abbreviation" ] }, "vds-carrier-Carrier": { "description": "Versender", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "parameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "carrierTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "carrierTypeRef", "label" ] }, "vds-shipment-DeliveryAddress": { "description": "receiver address of this order", "properties": { "version": { "type": "string", "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": { "type": "string", "description": "name1", "maxLength": 255, "minLength": 0 }, "name2": { "type": "string", "description": "name2", "maxLength": 255, "minLength": 0 }, "name3": { "type": "string", "description": "name3", "maxLength": 255, "minLength": 0 }, "type": { "type": "string", "description": "kind of address", "enum": [ "CONSIGNEE", "SHIPPER" ] }, "additionalAddressLine1": { "type": "string", "description": "additional address information 1", "maxLength": 255, "minLength": 0 }, "additionalAddressLine2": { "type": "string", "description": "additional address information 2", "maxLength": 255, "minLength": 0 }, "street": { "type": "string", "description": "streetname of this address", "maxLength": 255, "minLength": 0 }, "streetAddressNumber": { "type": "string", "description": "house number or street address number of this address", "maxLength": 255, "minLength": 0 }, "city": { "type": "string", "description": "city of this address", "maxLength": 255, "minLength": 0 }, "region": { "$ref": "#/components/schemas/vds-shipment-DeliveryAddress.CountryRegion" }, "postcode": { "type": "string", "description": "postcode of this address", "maxLength": 255, "minLength": 0 }, "country": { "type": "string", "description": "country of this address", "maxLength": 255, "minLength": 0 }, "countryIso3": { "type": "string", "description": "country-iso-alpha-3 of this address", "maxLength": 255, "minLength": 0 }, "taxId": { "type": "string", "description": "tax id of this address", "maxLength": 255, "minLength": 0 }, "phone": { "type": "string", "description": "phone number of this address", "maxLength": 255, "minLength": 0 }, "fax": { "type": "string", "description": "fax number of this address", "maxLength": 255, "minLength": 0 }, "email": { "type": "string", "description": "email of this address", "maxLength": 255, "minLength": 0 }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "vds-shipment-DeliveryAddress.CountryRegion": { "description": "region of this address", "properties": { "label": { "type": "string", "description": "Label" }, "abbreviation": { "type": "string", "description": "Abkürzung" }, "regionalCode": { "type": "string", "description": "Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)" }, "iso3166_2Code": { "type": "string", "description": "ISO 3166-2 Code für die Region" } } }, "vds-shipment-Parcel": { "description": "the parcels sent within this shipping order", "properties": { "version": { "type": "string", "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", "format": "int64", "description": "The ID of the linked shipment" }, "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" } }, "required": [ "parcelState" ] }, "vds-shipment-ParcelLine": { "description": "parcel position lines", "properties": { "version": { "type": "string", "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", "format": "int64", "description": "ID of the linked parcel" }, "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" }, "countryOfOrigin": { "type": "string", "description": "Herkunftsland", "maxLength": 255, "minLength": 0 }, "customsTariffNumber": { "type": "string", "description": "Zolltarifnummer", "maxLength": 255, "minLength": 0 }, "internationalParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "dangerousGoodsParameter": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "vds-shipment-ParcelTrackingDetail": { "description": "tracking details lines", "properties": { "version": { "type": "string", "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", "format": "date-time", "description": "Zeitpunkt Tracking erstellt " }, "trackingUpdatedAt": { "type": "string", "format": "date-time", "description": "Zeitpunkt Tracking geändert" } }, "required": [ "statusCode" ] }, "vds-shipment-Shipment": { "properties": { "version": { "type": "string", "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", "format": "date", "description": "shipping 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", "format": "int64", "description": "ID der Versandart" }, "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", "format": "int64", "description": "document id" }, "carrierResponse": { "type": "string", "description": "carrier response / warning or error messages" }, "validationErrors": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "documentNumber": { "type": "string", "description": "Rechnungsnummer" }, "currencyCodeRef": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" }, "shippingCosts": { "type": "number", "description": "Versandkosten" }, "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" ] } }, "required": [ "carrier", "documentId", "receiverAddress", "shipperAddress" ] }, "vds-shipment-PrintLabelRequest": { "properties": { "parameters": { "type": "array", "description": "Zusätzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-sales_channel-VariantValueListing": { "description": "Variantenattributwert-Listing", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "variantValueRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "salesChannelRef", "variantValueRef" ] }, "erp-sales_channel-VariantAttributeListing": { "description": "Variantenattribut-Listing", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "variantAttributeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "salesChannelRef", "variantAttributeRef" ] }, "erp-product-VariantAttributeAssignmentConfig": { "description": "ERP-spezifische Konfiguration einer Varianten-Attributzuordnung", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "attributeAssignmentRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "bundleAttribute": { "type": "boolean", "default": false, "description": "Ist dieses Attribut ein Gebinde-Attribut?" } }, "required": [ "attributeAssignmentRef", "bundleAttribute" ] }, "erp-user-ErpUserDetail": { "properties": { "version": { "type": "string", "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" }, "defaultLocationRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "currentLocationRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customUserDetailFields": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "parameter": { "type": "string", "description": "parameter" }, "fields": { "type": "string" } }, "required": [ "accountRef", "parameter", "userRef" ] }, "erp-texttemplates-LocalizedTextTemplateContent": { "description": "Texte in den angebotenen Sprachen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "languageCodeIsoAlpha2": { "type": "string", "description": "Sprache des Textes" }, "content": { "type": "string", "description": "Text" } }, "required": [ "content", "languageCodeIsoAlpha2" ] }, "erp-texttemplates-TextTemplate": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung des Bausteins" }, "templateType": { "type": "string", "default": "AUTOMATIC", "description": "Verwendungszweck des Templates", "enum": [ "UI_HINT", "AUTOMATIC", "MANUAL" ] }, "uiHintTypes": { "type": "array", "description": "Wann wird ein UI-Hint angezeigt", "items": { "type": "string", "description": "Wann wird ein UI-Hint angezeigt", "enum": [ "UI_HINT_MASTER_DATA", "UI_HINT_DOCUMENT" ] } }, "accountId": { "type": "integer", "format": "int64", "description": "account für den diese Templates gelten" }, "articleId": { "type": "integer", "format": "int64", "description": "article für den diese Templates gelten" }, "targetDocumentTypes": { "type": "array", "description": "Zieldokumenttypen. Geben zusammen mit Vorbelegstypen die Transitionen an für die dieses Template gilt", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "sourceDocumentTypes": { "type": "array", "description": "Vorbelegtypen. Geben zusammen mit Zieldokumenttypen die Transitionen an für die dieses Template gilt", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "transferableIntoSubsequentDocuments": { "type": "boolean", "description": "Erzeugte DocumentTexts beim Übergang in Folgebelege übernehmen?", "default": null }, "separateLine": { "type": "boolean", "description": "Wird eine eigene DocumentLine für den Baustein angelegt?", "default": null }, "position": { "type": "string", "description": "Position für den erzeugten DocumentText", "enum": [ "HEADER_TEXT", "FOOTER_TEXT" ] }, "active": { "type": "boolean", "default": true, "description": "ist dieser Baustein aktiv?", "readOnly": true }, "languageSpecificContents": { "type": "array", "description": "Texte in den angebotenen Sprachen", "items": { "$ref": "#/components/schemas/erp-texttemplates-LocalizedTextTemplateContent" } }, "resolveContentInFollowUpDocument": { "type": "boolean", "default": false, "description": "Soll der Inhalt des Textbausteins erst bei Belegübernahme gezogen werden?" } }, "required": [ "label" ] }, "erp-tax-TaxSchema": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "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", "minLength": 1 }, "countryMappings": { "type": "array", "description": "collection of selectors for the tax-rate", "items": { "$ref": "#/components/schemas/erp-tax-TaxSchemaCountry" } }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true } }, "required": [ "defaultCountryCode", "defaultTypeRef", "label" ] }, "erp-tax-TaxSchemaCountry": { "description": "collection of selectors for the tax-rate", "properties": { "version": { "type": "string", "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", "minLength": 1 } }, "required": [ "countryCode", "typeRef" ] }, "core-api-ApiCreatableReference": { "description": "Relation type", "properties": { "id": { "type": "string", "description": "Identifier" }, "label": { "type": "string", "description": "a label" }, "description": { "type": "string", "description": "a short description", "readOnly": true } } }, "erp-tax-TaxRate": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "typeRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" }, "active": { "type": "boolean", "default": true, "description": "is this tax-rate active (selectable)", "readOnly": true }, "countryCode": { "type": "string", "description": "the country code for this tax-rate" }, "rate": { "type": "number", "description": "the rate of this tax-rate", "example": 19 }, "validFrom": { "type": "string", "format": "date", "description": "the date, this entry is valid from" } }, "required": [ "countryCode", "rate", "typeRef", "validFrom" ] }, "erp-tax-TaxEwuDeliveryLimit": { "properties": { "version": { "type": "string", "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", "default": false, "description": "is the limit exeeded" }, "validFrom": { "type": "string", "format": "date", "description": "the date, this entry is valid from" } }, "required": [ "exceeded", "validFrom" ] }, "erp-stock-Storage": { "description": "Lager", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "Ist das Lager aktiv?", "readOnly": true }, "number": { "type": "string", "description": "Lager-Nr." }, "displayName": { "type": "string", "description": "Anzeigename" }, "location": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesStorage": { "type": "boolean", "default": false, "description": "Lieferlager?" }, "purchaseOrderStorage": { "type": "boolean", "default": false, "description": "Bestelllager?" }, "useInAvailabilityDetermination": { "type": "boolean", "default": false, "description": "Soll das Lager in die Summierung der Bestände/Verfügbarkeiten mit einbezogen werden?" }, "returnOrderStorage": { "type": "boolean", "default": false, "description": "Ziel-Lager für Retouren (z.B. aus Rechnungskorrektur mit WR)" }, "pickingRequired": { "type": "boolean", "default": false, "description": "Muss in diesem Lager kommissioniert werden?" }, "withStorageBins": { "type": "boolean", "default": false, "description": "Sollen in diesem Lager Lagerplätze verwendet werden" }, "allowNegativeStock": { "type": "boolean", "default": false, "description": "Darf in diesem Lager negativer Bestand gebucht werden" }, "transit": { "type": "boolean", "default": false, "description": "Ist es das Transitlager" }, "identifier": { "type": "string", "description": "Nur bei Lagern ohne Lagerplätze: Barcode (vom Standard-Lagerplatz)" }, "onlyOneBatchPerStorageBin": { "type": "boolean", "default": false, "description": "Nur eine Charge je Artikel pro Lagerplatz" }, "supplyStorage": { "type": "boolean", "default": false, "description": "Nachschublager" }, "forFabricationComponents": { "type": "boolean", "default": false, "description": "Material-Lager" }, "defaultForFabricationComponents": { "type": "boolean", "default": false, "description": "Standard-Material-Lager" }, "fabricationWorkbenchStorage": { "type": "boolean", "default": false, "description": "Produktion: Werkbank-Lager" }, "fabricationQualityAssurance": { "type": "boolean", "default": false, "description": "Produktion: QS-Lager" }, "fabricationDefectiveStorage": { "type": "boolean", "default": false, "description": "Produktion: Defekt-Lager" }, "fabricationTargetStorage": { "type": "boolean", "default": false, "description": "Produktion: Ziel-Lager" }, "considerForOrderProposal": { "type": "boolean", "default": false, "description": "Für Bestellvorschlag berücksichtigen" } }, "required": [ "number" ] }, "erp-stock-StorageBin": { "description": "Lagerplatz", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "storageId": { "type": "string", "description": "Lager, in dem sich der Lagerplatz befindet" }, "level1": { "type": "string", "description": "Ebene1", "maxLength": 40, "minLength": 0 }, "level2": { "type": "string", "description": "Ebene2", "maxLength": 40, "minLength": 0 }, "level3": { "type": "string", "description": "Ebene3", "maxLength": 40, "minLength": 0 }, "level4": { "type": "string", "description": "Ebene4", "maxLength": 40, "minLength": 0 }, "level5": { "type": "string", "description": "Ebene5", "maxLength": 40, "minLength": 0 }, "level6": { "type": "string", "description": "Ebene6", "maxLength": 40, "minLength": 0 }, "identifier": { "type": "string", "description": "Barcode" }, "displayName": { "type": "string", "description": "Anzeigename" }, "description": { "type": "string", "description": "Beschreibung" }, "routePosition": { "type": "integer", "format": "int32", "description": "Laufwegposition" }, "shelfSpace": { "type": "boolean", "default": false, "description": "Normaler Regalplatz?" }, "forIncomingGoods": { "type": "boolean", "default": false, "description": "Für Wareneingang?" }, "palletSpace": { "type": "boolean", "default": false, "description": "Für Paletten/Nachschubmengen?" }, "clarifySpace": { "type": "boolean", "default": false, "description": "Zur Klärung?" }, "forReturnedGoods": { "type": "boolean", "default": false, "description": "Für Retouren?" }, "useInAvailabilityDetermination": { "type": "boolean", "default": false, "description": "Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?" }, "state": { "type": "string", "default": "ACTIVE", "description": "Status eines Lagerplatzes", "enum": [ "ACTIVE", "INACTIVE", "SUSPENDED", "BLOCKED_FOR_INVENTORY" ] }, "maxAllowedWeight": { "type": "number", "description": "Maximal zulässiges Gewicht" }, "heightInCM": { "type": "number", "description": "Höhe in CM" }, "widthInCM": { "type": "number", "description": "Breite in CM" }, "depthInCM": { "type": "number", "description": "Tiefe in CM" }, "color": { "type": "string", "description": "Farbe zur Anzeige", "pattern": "^#[0-9A-Fa-f]{6}$" }, "comment": { "type": "string", "description": "Kommentar" }, "storageAreaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "required": [ "displayName", "storageId" ] }, "erp-stock-StorageChangeNameAndNumberRequest": { "properties": { "number": { "type": "string", "description": "Nummer für das Lager", "minLength": 1 }, "name": { "type": "string", "description": "der Name für das Lager" } }, "required": [ "number" ] }, "common-cunit-QueryPresetPredicate": { "description": "Bedingungen zur Selektion von Lagerplätzen", "properties": { "type": { "type": "string", "description": "die Operation für diesen Filter", "enum": [ "JUNCTION", "FILTER" ] }, "operator": { "type": "string", "description": "operator", "enum": [ "AND", "OR", "EQUALS", "NOT_EQUALS", "LIKE", "NOT_LIKE", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "NOT_CONTAINS", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "IN", "NOT_IN", "RANGE", "NOT_RANGE", "IS_NULL", "IS_NOT_NULL", "IS_NULL_OR_EQUALS", "EXISTS", "NOT_EXISTS" ] }, "children": { "type": "array", "description": "(bei junction) child-definitionen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" } }, "property": { "type": "string", "description": "filter property" }, "values": { "type": "array", "description": "filter werte", "items": { "type": "string", "description": "filter werte" } }, "visible": { "type": "boolean", "default": true, "description": "Sichtbarkeit bei Variablen" }, "functions": { "type": "array", "description": "Eine SQL-Funktion, die im Predicate angewendet wird", "items": { "type": "string", "description": "Eine SQL-Funktion, die im Predicate angewendet wird" } } }, "required": [ "operator", "type" ] }, "common-cunit-QueryPresetVariable": { "description": "Die zu ersetzende Variable", "properties": { "path": { "type": "string", "description": "Der pfad, der dieses Attribut eindeutig beschreibt" }, "definition": { "$ref": "#/components/schemas/core-cunit-MetaContent" }, "mandatory": { "type": "boolean", "description": "Ob die Variable ein Pflichtfeld ist oder nicht" }, "variableName": { "type": "string", "description": "Name der Variablen" }, "visible": { "type": "boolean", "default": true, "description": "Handelt es sich um eine sichtbare Variable?" }, "alignX": { "type": "integer", "format": "int32", "description": "Anordnung im UI - X-Koordinate" }, "alignY": { "type": "integer", "format": "int32", "description": "Anordnung im UI - Y-Koordinate" }, "alignWidth": { "type": "integer", "format": "int32", "description": "Anordnung im UI - Breite" }, "searchDialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "allowDialogMultipleChoice": { "type": "boolean", "default": false, "description": "Kann eine Mehrfachauswahl erfolgen?" } } }, "common-cunit-QueryPresetVariableSubstitution": { "description": "Die Variablenbelegungen", "properties": { "variable": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariable" }, "values": { "type": "array", "description": "Die einzusetzenden Werte", "items": { "type": "string", "description": "Die einzusetzenden Werte" } } } }, "common-cunit-QueryPresetVariableSubstitutionList": { "description": "Werte von Variablen", "properties": { "variableSubstitutions": { "type": "array", "description": "Die Variablenbelegungen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitution" } } } }, "core-cunit-CuAttribute": { "allOf": [ { "$ref": "#/components/schemas/core-cunit-MetaContent" }, { "type": "object", "properties": { "key": { "type": "string", "description": "Eindeutiger Schlüssel zur Identifikation des Attributs" }, "attribute": { "type": "string", "description": "name des attributes der das ergebnis enthält" }, "path": { "type": "string", "description": "der pfad, der dieses attribut eindeutig beschreibt" }, "displayName": { "type": "string", "description": "der Name dieses Feldes" }, "displayNameOverride": { "type": "boolean", "default": false, "description": "der Name dieses Feldes wurde überschrieben (alias oder funktion)" }, "groupDisplayName": { "type": "string", "description": "der Name der Gruppe, dieses Feldes" }, "parentDisplayName": { "type": "string", "description": "der Name des Referenzierenden Feldes" }, "resultable": { "type": "boolean", "default": true, "description": "kann dieses Feld ein Ergebnisfeld sein" }, "filterable": { "type": "boolean", "default": true, "description": "kann nach diesem feld gefiltert werden" }, "sortable": { "type": "boolean", "default": true, "description": "ist dieses Feld sortierbar" }, "visible": { "type": "boolean", "default": true, "description": "soll dieses Feld angezeigt werden" }, "functions": { "type": "array", "description": "angewendete funktionen (wenn das als Result MetaData verwendet wird)", "items": { "type": "string", "description": "angewendete funktionen (wenn das als Result MetaData verwendet wird)" } }, "sortDirection": { "type": "string", "description": "Info, wie diese spalte sortiert worden ist" }, "constraint": { "$ref": "#/components/schemas/core-cunit-CuAttributeConstraint" }, "dataType": { "$ref": "#/components/schemas/core-cunit-CuAttributeDataType" }, "dataTypeIdentifier": { "type": "string", "description": "data-type-identifier für dieses Attribut (falls dataType leer ist)", "readOnly": true }, "modelType": { "type": "string", "description": "Attribut gehört zum Modelltyp 'statisch' oder 'dynamisch'", "enum": [ "STATIC", "DYNAMIC" ], "readOnly": true }, "entityIdentifier": { "type": "string", "description": "Identifier der Entity, zu der dieses Attribut gehört (z.B. 'AccountEntity')", "readOnly": true }, "referencedEntityIdentifier": { "type": "string", "description": "Bei Relation-Attributen: vollqualifizierter Klassenname der Ziel-Entity (z.B. 'ag.vario.erp.account.AccountEntity')", "readOnly": true }, "headers": { "type": "array", "description": "bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben", "items": { "$ref": "#/components/schemas/core-cunit-CuAttribute.HeaderGroup" }, "readOnly": true } } } ] }, "core-cunit-CuAttribute.HeaderGroup": { "description": "bei einem gruppierten Header (e.g. CrossTable) werden hier die einzelnen gruppen beschrieben", "properties": { "displayName": { "type": "string", "description": "der Name dieses Feldes" }, "displayNameOverride": { "type": "boolean", "default": false, "description": "der Name dieses Feldes wurde überschrieben (alias oder funktion)" }, "dataType": { "$ref": "#/components/schemas/core-cunit-CuAttributeDataType" }, "dataTypeIdentifier": { "type": "string", "description": "data-type-identifier für dieses Attribut (falls dataType leer ist)", "readOnly": true }, "groupDisplayName": { "type": "string", "description": "der Name der Gruppe, dieses Feldes" }, "data": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "core-cunit-CuAttributeConstraint": { "description": "constraints für dieses Attribut", "properties": { "minLength": { "type": "integer", "format": "int32", "description": "Minimal-Länge (von Zeichenketten oder Arrays)", "readOnly": true }, "maxLength": { "type": "integer", "format": "int32", "description": "Maximal-Länge (von Zeichenketten oder Arrays)", "readOnly": true }, "minValue": { "type": "integer", "format": "int64", "description": "minimaler Wert", "readOnly": true }, "includeMinValue": { "type": "boolean", "description": "ist der minimale Wert inklusive?", "readOnly": true }, "maxValue": { "type": "integer", "format": "int64", "description": "maximaler Wert", "readOnly": true }, "includeMaxValue": { "type": "boolean", "description": "ist der maximale Wert inklusive?", "readOnly": true }, "notNull": { "type": "boolean", "default": false, "description": "ist der Wert 'null' verboten?", "readOnly": true }, "notBlank": { "type": "boolean", "description": "Bei Strings: ist ein String nur aus Whitespace verboten?", "readOnly": true }, "digitsFraction": { "type": "integer", "format": "int32", "description": "Maximale Anzahl Nachkommastellen", "readOnly": true } } }, "core-cunit-CuAttributeDataType": { "description": "data-type für dieses Attribut (falls dataTypeIdentifier leer ist)", "properties": { "identifier": { "type": "string", "description": "Datentyp-identifier", "readOnly": true }, "jsType": { "type": "string", "description": "welcher Typ ist es", "readOnly": true }, "objectRefIdentifier": { "type": "string", "description": "bei Object_Ref: welcher Typ ist es genau", "readOnly": true }, "filterOptions": { "$ref": "#/components/schemas/core-cunit-CuAttributeFilterOptions" }, "functions": { "type": "array", "description": "welche Funktionen sind erlaubt?", "items": { "type": "string", "description": "welche Funktionen sind erlaubt?" }, "readOnly": true }, "predicateOperations": { "type": "array", "description": "welche Operations sind erlaubt?", "items": { "type": "string", "description": "welche Operations sind erlaubt?", "enum": [ "AND", "OR", "EQUALS", "NOT_EQUALS", "LIKE", "NOT_LIKE", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "NOT_CONTAINS", "GREATER_THAN", "GREATER_THAN_EQUALS", "LESS_THAN", "LESS_THAN_EQUALS", "IN", "NOT_IN", "RANGE", "NOT_RANGE", "IS_NULL", "IS_NOT_NULL", "IS_NULL_OR_EQUALS", "EXISTS", "NOT_EXISTS" ] }, "readOnly": true } } }, "core-cunit-CuAttributeFilterOptions": { "description": "CUnit Attribut Filter Optionen", "properties": { "filterValues": { "type": "array", "description": "Mögliche Filterwerte", "items": { "type": "string", "description": "Mögliche Filterwerte" } }, "filterDialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "multipleChoice": { "type": "boolean", "default": false, "description": "Kann eine Mehrfachauswahl erfolgen?" } } }, "core-cunit-CuMeta": { "allOf": [ { "$ref": "#/components/schemas/core-cunit-MetaContent" }, { "type": "object", "properties": { "definition": { "$ref": "#/components/schemas/core-cunit-CuAttribute" }, "value": { "type": "array", "description": "spaltenbeschreibung dieser zelle (bei verschachtelung)", "items": { "$ref": "#/components/schemas/core-cunit-MetaContent" } } } } ] }, "core-cunit-MetaContent": { "description": "Definition dieser Variable", "discriminator": { "propertyName": "_type" }, "oneOf": [ { "$ref": "#/components/schemas/core-cunit-CuMeta" }, { "$ref": "#/components/schemas/core-cunit-CuAttribute" } ], "properties": { "_type": { "type": "string" } }, "required": [ "_type" ] }, "erp-stock-StorageBinLabelPrintRequest": { "description": "Request zur Durchführung des Etikettendrucks von Lagerplätzen", "properties": { "variables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "exportFilename": { "type": "string", "description": "Dateiname des Ausdrucks" } } }, "erp-stock-StorageArea": { "description": "Lagerbereich", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "storageId": { "type": "integer", "format": "int64", "description": "Storage-ID" }, "label": { "type": "string", "description": "Kurzbezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" } }, "required": [ "label", "storageId" ] }, "erp-stock-BookLastPurchasePriceCorrectionRequest": { "properties": { "articleId": { "type": "integer", "format": "int64", "description": "Artikel-Id" }, "purchasePrice": { "type": "number", "description": "Der neue letzte EK, ausgedrückt pro priceUnit Einheiten" }, "priceUnit": { "type": "number", "description": "Preiseinheit, auf die sich der EK bezieht; ohne Angabe gilt die basePriceUnit des Artikels", "minimum": 0 }, "serialNumberId": { "type": "integer", "format": "int64", "description": "Die ID der Seriennummer des Artikels" }, "note": { "type": "string", "description": "Notiz zur Änderung" } }, "required": [ "articleId", "purchasePrice" ] }, "erp-stock-BookAveragePurchasePriceCorrectionRequest": { "properties": { "articleId": { "type": "integer", "format": "int64", "description": "Artikel-Id" }, "purchasePrice": { "type": "number", "description": "Der neue DEK, ausgedrückt pro priceUnit Einheiten" }, "priceUnit": { "type": "number", "description": "Preiseinheit, auf die sich der DEK bezieht; ohne Angabe gilt die basePriceUnit des Artikels", "minimum": 0 }, "note": { "type": "string", "description": "Notiz zur Änderung" } }, "required": [ "articleId", "purchasePrice" ] }, "erp-sales_channel-SalesChannelStorage": { "description": "Lagerzuordnungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "storageSchemaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "storageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "availabilityPercent": { "type": "number", "description": "Verfügbarkeit in Prozent", "maximum": 100, "minimum": 0 }, "defaultSalesStorage": { "type": "boolean", "description": "Standard-Verkaufslager" }, "defaultPurchaseStorage": { "type": "boolean", "description": "Standard-Einkaufslager" }, "modifiedByUser": { "type": "boolean", "description": "Durch Benutzer bearbeitet", "readOnly": true } }, "required": [ "storageRef" ] }, "erp-sales_channel-SalesChannelStorageSchema": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "salesChannelStorages": { "type": "array", "description": "Lagerzuordnungen", "items": { "$ref": "#/components/schemas/erp-sales_channel-SalesChannelStorage" } }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true } }, "required": [ "label" ] }, "core-api-LocalizedLabelWithDescription": { "description": "Localized label with description", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Label/name of this description", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Description text", "maxLength": 255, "minLength": 0 }, "languageCode": { "type": "string", "description": "ISO 639-1 language code (e.g. 'de', 'en')" } } }, "erp-rma-ReturnGroup": { "description": "Retourengruppe", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "applicableForCustomerReturns": { "type": "boolean", "default": true, "description": "Anwendbar für Kundenretouren?" }, "applicableForSupplierReturns": { "type": "boolean", "default": true, "description": "Anwendbar für Lieferantenretouren?" }, "barcode": { "type": "string", "description": "Barcode", "maxLength": 255, "minLength": 0 }, "publish": { "type": "boolean", "description": "Veröffentlichen?" }, "productGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "labels": { "type": "array", "description": "Beschreibungen (mehrsprachig)", "items": { "$ref": "#/components/schemas/core-api-LocalizedLabelWithDescription" } } } }, "erp-rma-ReturnCause": { "description": "Retourengrund", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "returnGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "applicableForCustomerReturns": { "type": "boolean", "default": true, "description": "Anwendbar für Kundenretouren?" }, "applicableForSupplierReturns": { "type": "boolean", "default": true, "description": "Anwendbar für Lieferantenretouren?" }, "barcode": { "type": "string", "description": "Barcode", "maxLength": 255, "minLength": 0 }, "publish": { "type": "boolean", "description": "Veröffentlichen?" }, "productGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "labels": { "type": "array", "description": "Beschreibungen (mehrsprachig)", "items": { "$ref": "#/components/schemas/core-api-LocalizedLabelWithDescription" } } } }, "common-masterdata-CountryReference": { "description": "Land (Iso-A-2)", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID des Landes" }, "isoAlpha2": { "type": "string", "description": "IsoAlpha2-Code des Landes" }, "isoAlpha3": { "type": "string", "description": "IsoAlpha3-Code des Landes" }, "label": { "type": "string", "description": "Bezeichnung des Landes", "readOnly": true } } }, "erp-product-RecommendedRetailPrice": { "description": "Unverbindliche Preisempfehlung für einen Artikel", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "currencyCode": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" }, "countryCode": { "$ref": "#/components/schemas/common-masterdata-CountryReference" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "value": { "type": "number", "description": "Preis" } }, "required": [ "articleRef", "currencyCode", "value" ] }, "common-sequencer-SequencerConfiguration": { "description": "Eigener Zählerkreis für Seriennummern", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "key": { "type": "string", "description": "Unique key to identify the sequencer configuration", "readOnly": true }, "configurationGroup": { "type": "string", "description": "Group of the sequencer configuration (e.g. Document, Account, ...)", "readOnly": true }, "configurationDetail": { "$ref": "#/components/schemas/common-sequencer-SequencerConfigurationDetail" }, "alternativeConfiguration": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "active": { "type": "boolean", "default": true, "description": "Sequencer aktiv?" } }, "required": [ "configurationDetail" ] }, "common-sequencer-SequencerConfigurationDetail": { "description": "Contains details about the sequencer configuration", "properties": { "type": { "type": "string", "description": "Typ der Sequenz", "enum": [ "NON_POOLED_SEQUENCES", "POOLED_SEQUENCES", "PREFETCHED_SEQUENCES" ] }, "assignmentMode": { "type": "string", "description": "Vergabeverfahren", "enum": [ "MANUAL", "AUTOMATIC", "SEMI_AUTOMATIC", "FREE" ] }, "length": { "type": "integer", "format": "int32", "description": "Länge", "minimum": 0 }, "padChar": { "type": "string", "description": "Auffüllzeichen", "maxLength": 1, "minLength": 1, "pattern": "^[0-9]*$" }, "expression": { "type": "string", "description": "Präfix-Ausdruck" }, "postExpression": { "type": "string", "description": "Postfix-Ausdruck" }, "initialValue": { "type": "integer", "format": "int64", "description": "Initialer Wert" }, "numberUnique": { "type": "boolean", "default": true, "description": "Eindeutigkeitsprüfung" } }, "required": [ "assignmentMode", "initialValue", "length", "padChar", "type" ] }, "common-variant-VariantValueReference": { "description": "Variantenwerte", "properties": { "id": { "type": "string", "description": "Identifier" }, "label": { "type": "string", "description": "Bezeichnung", "readOnly": true }, "description": { "type": "string", "description": "Beschreibung", "readOnly": true }, "variantAttributeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "required": [ "id" ] }, "erp-product-ArticleAvailabilityDetermination": { "description": "Verfügbarkeitsermittlung für die Artikelstammdaten/Bestandsansicht", "properties": { "inStock": { "type": "string", "description": "wie wird der Bestand behandelt", "enum": [ "IGNORE", "ADD", "SUBTRACT" ] }, "reserved": { "type": "string", "description": "wie werden Reserviert-Mengen behandelt", "enum": [ "IGNORE", "ADD", "SUBTRACT" ] }, "ordered": { "type": "string", "description": "wie werden Bestellt-Mengen behandelt", "enum": [ "IGNORE", "ADD", "SUBTRACT" ] }, "inPicking": { "type": "string", "description": "wie werden Mengen in Kommissionierung behandelt", "enum": [ "IGNORE", "ADD", "SUBTRACT" ] }, "reporting": { "type": "string", "description": "wie werden Meldebestände behandelt", "enum": [ "IGNORE", "ADD", "SUBTRACT" ] } } }, "erp-product-Product": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "bundle": { "type": "boolean", "default": false, "description": "Handelt es sich um ein Gebinde?" }, "bundleSchemaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "type": { "type": "string", "description": "Artikelarten", "enum": [ "WITH_STOCK", "WITHOUT_STOCK", "SERVICE_ARTICLE", "SERVICE_CONTINGENT", "ASSEMBLY_GROUP", "JUMBO", "SHIPPING_COSTS", "VARIANT_MAIN_ARTICLE" ] }, "articleRefs": { "type": "array", "description": "alle artikel, die zu diesem Produkt gehören", "items": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "readOnly": true }, "availabilityDetermination": { "$ref": "#/components/schemas/erp-product-ArticleAvailabilityDetermination" }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ] }, "expiryDateType": { "type": "string", "description": "Art des Haltbarkeitsdatums bei Serienartikeln", "enum": [ "NONE", "BEST_BEFORE_DATE", "EXPIRATION_DATE" ] }, "minimumRemainingDaysBeforeExpiryDateOnGoodsReceipt": { "type": "integer", "format": "int32", "description": "Mindestrestlaufzeit Eingang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel bei der Einbuchung in ein Verkaufslager noch aufweisen muss" }, "minimumRemainingDaysBeforeExpiryDateForGoodsIssued": { "type": "integer", "format": "int32", "description": "Mindestrestlaufzeit Ausgang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel beim Verkauf noch aufweisen muss" }, "warrantyInMonths": { "type": "integer", "format": "int32", "description": "Garantie in Monaten" }, "lotOnlyRequiredWhenBookedToSalesStorage": { "type": "boolean", "default": false, "description": "Charge muss bei Einbuchung in ein Verkaufslager vergeben werden (für Serientyp LOT und BEST_BEFORE)" }, "serialNumberLabelingType": { "type": "string", "description": "Seriennummer Auszeichnungsart", "enum": [ "MANUAL", "AUTOMATIC_ON_SUPPLIER_ORDER", "AUTOMATIC_ON_SUPPLIER_DELIVERY" ] }, "fabricationSerialNumberLabelingType": { "type": "string", "description": "Produktions-S/N-Auszeichnungsart", "enum": [ "QUERY_ON_START", "QUERY_ON_FINISH", "INHERITANCE", "AUTOMATICALLY_ON_START", "AUTOMATICALLY_ON_FINISH" ] }, "customsTariffNumber": { "type": "string", "description": "Zolltarifnummer", "maxLength": 15, "minLength": 0 }, "countryOfOrigin": { "$ref": "#/components/schemas/common-masterdata-CountryReference" }, "regionOfOrigin": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "useSerialSequencerConfiguration": { "type": "boolean", "description": "Soll ein eigener Zählerkreis für Seriennummern verwendet werden?" }, "serialSequencerConfiguration": { "$ref": "#/components/schemas/common-sequencer-SequencerConfiguration" }, "variantValues": { "type": "array", "description": "Variantenwerte", "items": { "$ref": "#/components/schemas/common-variant-VariantValueReference" } }, "variantSchemaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "mainVariantProductRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-product-ProductArticleRef": { "description": "alle artikel, die zu diesem Produkt gehören", "properties": { "id": { "type": "integer", "format": "int64", "description": "Article ID" }, "number": { "type": "string", "description": "Article number" }, "name": { "type": "string", "description": "Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ] }, "unit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" } }, "required": [ "unit" ] }, "erp-product-ProductPrice": { "description": "Enthält einen Verkaufs- oder Einkaufspreis zu einem Produkt", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "netPrice": { "type": "number", "description": "Netto-Preis" }, "grossPrice": { "type": "number", "description": "Brutto-Preis" }, "priceBase": { "type": "string", "description": "Preisbasis", "enum": [ "NET_PRICE", "GROSS_PRICE" ] }, "usedTaxRate": { "$ref": "#/components/schemas/erp-tax-TaxRate" }, "qualifier": { "type": "string", "description": "Bestimmt, ob es sich um einen Verkaufs- oder Einkaufspreis handelt", "enum": [ "SALES", "PURCHASE" ], "readOnly": true }, "purchasePriceSource": { "type": "string", "description": "Einkaufspreis zur Kalkulation", "enum": [ "NONE", "AVERAGE", "MOST_RECENT" ] }, "modifierValueType": { "type": "string", "description": "Typ von Werten", "enum": [ "PERCENT", "FIX" ] }, "modifierValue": { "type": "number", "description": "Wert des Aufschlags bei EK-Kalkulation" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accessoryMainArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "productGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priceGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "currencyRef": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" }, "fromQuantity": { "type": "number", "description": "Bestimmt ab welcher Menge dieser Preis gültig ist" }, "validFrom": { "type": "string", "format": "date", "description": "Gültig von" }, "validUntil": { "type": "string", "format": "date", "description": "Gültig bis" }, "specialOfferPrice": { "type": "boolean", "default": false, "description": "Aktionpreis" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customerGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "supplierGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "manufacturerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-product-ProductDiscount": { "description": "Enthält eine Preisregel bzw. einen Verkaufs- oder Einkaufsrabatt zu einem Produkt", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "qualifier": { "type": "string", "description": "Bestimmt, ob es sich um einen Verkaufs- oder Einkaufsrabatt handelt", "enum": [ "SALES", "PURCHASE" ], "readOnly": true }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accessoryMainArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "productGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priceGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "fromQuantity": { "type": "number", "description": "Bestimmt ab welcher Menge dieser Rabatt gültig ist" }, "modifierName": { "type": "string", "description": "Name des Rabatts", "maxLength": 255, "minLength": 0 }, "modifierType": { "type": "string", "description": "Bestimmt die Art des Rabatts", "enum": [ "DISCOUNT", "SURCHARGE" ] }, "modifierValueType": { "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", "format": "date", "description": "Gültig von" }, "validUntil": { "type": "string", "format": "date", "description": "Gültig bis" }, "specialOfferPrice": { "type": "boolean", "default": false, "description": "Aktionpreis" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customerGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "supplierGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "manufacturerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-product-ProductPriceGroup": { "description": "Enthält eine Preisgruppe", "properties": { "version": { "type": "string", "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" } }, "required": [ "label" ] }, "erp-product-ProductGroup": { "properties": { "version": { "type": "string", "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": "product group name", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "description": "product group description", "maxLength": 255, "minLength": 0 }, "externalReference": { "type": "string", "description": "needed for data migration from third party applications", "maxLength": 255, "minLength": 0 }, "mainGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customsTariffNumber": { "type": "string", "description": "Zolltarifnummer", "maxLength": 15, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "warengruppe aktiv ja/nein", "readOnly": true }, "targetTradingMargin": { "type": "number", "description": "Soll-Handelsspanne" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "description", "label" ] }, "erp-product-ProductMainGroup": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Hauptwarengruppe", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung der Hauptwarengruppe", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "Hauptwarengruppe aktiv ja/nein", "readOnly": true }, "targetTradingMargin": { "type": "number", "description": "Soll-Handelsspanne" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "label" ] }, "erp-product-IdentifierType": { "properties": { "version": { "type": "string", "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": "produkt-nummern-typ", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "is active", "readOnly": true } }, "required": [ "name" ] }, "erp-product-DiscountGroup": { "properties": { "version": { "type": "string", "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 Rabattgruppe", "maxLength": 255, "minLength": 0 }, "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" } } }, "required": [ "label", "type" ] }, "erp-product-DiscountGroupRule": { "description": "List of discount group rules", "properties": { "version": { "type": "string", "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 der Regel", "minLength": 1 }, "value": { "type": "number", "description": "Rabattwert" }, "valueType": { "type": "string", "description": "Typ von Werten", "enum": [ "PERCENT", "FIX" ] }, "fromQuantity": { "type": "number", "description": "Ab Menge" }, "priceGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "currencyRef": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" } }, "required": [ "name", "value", "valueType" ] }, "erp-document-PriceModifierTemplate": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Name des Templates", "minLength": 1 }, "modifierType": { "type": "string", "description": "Rabatt oder Aufschlag", "enum": [ "DISCOUNT", "SURCHARGE" ] } }, "required": [ "label", "modifierType" ] }, "erp-pos-TssAdminPin": { "description": "Request für TSS-Admin-Operationen", "properties": { "adminPin": { "type": "string", "description": "Admin-PIN für die TSS", "minLength": 1 } }, "required": [ "adminPin" ] }, "erp-pos-PosRegister": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung", "minLength": 1 }, "active": { "type": "boolean", "default": true, "description": "Aktiv?" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "cashDrawerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethods": { "type": "array", "description": "Payment Methods", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "uniqueItems": true }, "uiSettings": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "brand": { "type": "string", "description": "Marke des Herstellers" }, "model": { "type": "string", "description": "Modell" }, "softwareBrand": { "type": "string", "description": "Name der Software" }, "softwareVersion": { "type": "string", "description": "Version der Software" }, "externalReferences": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "dsfinvkExport": { "type": "boolean", "description": "DSFinV-K Export durchführen", "readOnly": true }, "exportState": { "type": "string", "description": "Zustand des automatisch getriggerten DSFinV-K Exports", "enum": [ "PENDING", "FINISHED" ], "readOnly": true }, "lastExportedBusinessDate": { "type": "string", "format": "date", "description": "Letzter Geschäftstag, der erfolgreich exportiert und im DMS gespeichert wurde", "readOnly": true }, "pendingExportBusinessDateEnd": { "type": "string", "format": "date", "description": "Geschäftstag des aktuell laufenden DSFinV-K Exports", "readOnly": true } }, "required": [ "description", "label" ] }, "erp-pos-FiscalizationBackend": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "externalReference": { "type": "string", "description": "Externe Referenz", "readOnly": true }, "backendType": { "type": "string", "description": "Backend-Typ", "enum": [ "FISKALY" ] }, "test": { "type": "boolean", "default": false, "description": "Test-Umgebung?" } }, "required": [ "backendType", "label", "test" ] }, "erp-pos-PosDepositExpenseType": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung", "minLength": 1 }, "active": { "type": "boolean", "default": true, "description": "Aktiv?" }, "taxRateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "type": { "type": "string", "description": "Typ der Einlage/Auszahlung/Abschöpfung", "enum": [ "DEPOSIT", "EXPENSE", "WITHDRAWAL" ] } }, "required": [ "description", "label" ] }, "erp-pos-CashDrawer": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung der Kassenschublade", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung", "minLength": 1 }, "active": { "type": "boolean", "default": true, "description": "Aktiv?" }, "drawerState": { "type": "string", "description": "Schubladenstatus", "enum": [ "OPEN", "CLOSED" ], "readOnly": true } }, "required": [ "description", "label" ] }, "erp-document-DocumentTypeTerm": { "description": "translations", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "languageCode": { "type": "string", "description": "sprache", "minLength": 1 } }, "required": [ "content", "languageCode" ] }, "erp-payment-PaymentTerm": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "description", "minLength": 1 }, "externalPaymentId": { "type": "string", "description": "external Payment Id" }, "paymentType": { "type": "string", "description": "payment type", "enum": [ "PREPAYMENT", "PAYMENT", "DEPOSIT" ] }, "paymentDays1": { "type": "integer", "format": "int32", "default": 0, "description": "Days for Discount 1 " }, "paymentDiscount1": { "type": "number", "default": 0, "description": "Percent for Discount 1 " }, "paymentDays2": { "type": "integer", "format": "int32", "default": 0, "description": "Days for Discount 2 " }, "paymentDiscount2": { "type": "number", "default": 0, "description": "Percent for Discount 2 " }, "paymentDaysNet": { "type": "integer", "format": "int32", "default": 0, "description": "Days for net payment " }, "remainingTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "printDescription": { "type": "string", "description": "printDescription" }, "dunningBlock": { "type": "boolean", "default": false, "description": "Mahnsperre" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?" }, "considerForCreditLimit": { "type": "boolean", "default": true, "description": "Für Kreditlimit berücksichtigen?" }, "translations": { "type": "array", "description": "translations", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeTerm" } } }, "required": [ "description", "label", "paymentType" ] }, "erp-payment-PaymentTemplate": { "description": "Zahlungsvorlage zur Vorbelegung von Feldern in einer Zahlung", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung der Zahlungsvorlage", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung der Zahlungsvorlage" }, "defaultPaymentTemplate": { "type": "boolean", "default": false, "description": "Standard-Zahlungsvorlage" }, "batchPayment": { "type": "boolean", "default": false, "description": "Sammelauftrag möglich" }, "consolidateRecords": { "type": "boolean", "default": false, "description": "Positionen je Empfänger zu einer Sammelposition zusammenfassen" }, "alwaysUseDiscount1": { "type": "boolean", "default": false, "description": "Skonto immer ziehen" }, "manuallySetExecutionDate": { "type": "boolean", "default": false, "description": "Ausführungsdatum manuell setzen" }, "offsetCreditNotesBeforeDirectDebit": { "type": "boolean", "default": false, "description": "Offene Gutschriften vor der Lastschrifterstellung mit den Rechnungen verrechnen (nur bei Vorlagentyp DIRECT_DEBIT erlaubt)" }, "paymentTemplateType": { "type": "string", "default": "PAYMENT_NOT_BOUND", "description": "Typ der Zahlungsvorlage", "enum": [ "PAYMENT_INVOICE", "PAYMENT_CREDIT_NOTE", "PAYMENT_NOT_BOUND", "DIRECT_DEBIT" ] }, "paymentTemplateEntries": { "type": "array", "description": "Die einzelnen Feldvorbelegungen der Zahlungsvorlage", "items": { "$ref": "#/components/schemas/erp-payment-PaymentTemplateEntry" } } }, "required": [ "label", "paymentTemplateType" ] }, "erp-payment-PaymentTemplateEntry": { "description": "Eintrag für eine Feldvorbelegung einer Zahlungsvorlage", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "fieldName": { "type": "string", "description": "Feldname für Vorbelegung" }, "value": { "type": "string", "description": "Wert für Vorbelegung" } } }, "erp-payment-PaymentMethod": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "description", "minLength": 1 }, "dunnable": { "type": "boolean", "default": true, "description": "dunnable" }, "externalPaymentId": { "type": "string", "description": "external Payment Id" }, "paymentType": { "type": "string", "default": "MONEY_TRANSFER", "description": "Payment Type", "enum": [ "MONEY_TRANSFER", "REALTIME_MONEY_TRANSFER", "SEPA_CORE_DIRECT_DEBIT", "SEPA_B2B_DIRECT_DEBIT", "CLEARING", "CLEARING_WITH_PREDECESSOR_DOCUMENT", "OTHER" ] }, "active": { "type": "boolean", "default": true, "description": "Aktiv?" }, "printDescription": { "type": "string", "description": "printDescription" }, "translations": { "type": "array", "description": "translations", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeTerm" } }, "closePayable": { "type": "boolean", "default": false, "description": "Verbindlichkeiten-OP abschließen?" }, "closeReceivable": { "type": "boolean", "default": false, "description": "Forderungs-OP abschließen?" }, "closeCustomerAccountType": { "type": "boolean", "default": false, "description": "Debitoren-OP abschließen?" }, "closeSupplierAccountType": { "type": "boolean", "default": false, "description": "Kreditoren-OP abschließen?" }, "businessTransaction": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "daysToAddForDirectDebit": { "type": "integer", "format": "int32", "description": "+Tage für Erstlastschrift" }, "daysToAddForFollowup": { "type": "integer", "format": "int32", "description": "+Tage für Folgelastschrift" } }, "required": [ "description", "label", "paymentType" ] }, "erp-stock-ObservationPeriod": { "description": "Beobachtungszeitraum (von/bis) für die Bedarfsermittlung über Abverkäufe", "properties": { "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" } }, "required": [ "endDate", "startDate" ] }, "erp-stock-OrderProposal": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "usedOrderProposalGenerateRequest": { "$ref": "#/components/schemas/erp-stock-OrderProposalGenerateRequest" }, "purchaseOrderStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priceRequestInsteadOfOrder": { "type": "boolean", "default": false, "description": "Soll eine Preisanfrage erstellt werden anstatt einer Bestellung", "readOnly": true }, "triggerMailOutputAfterDocumentCreation": { "type": "boolean", "default": false, "description": "Soll die erstellte Bestellung direkt per Mail versandt werden" }, "processed": { "type": "boolean", "default": false, "description": "Wurde der Bestellvorschlag verarbeitet" }, "orderProposalSuppliers": { "type": "array", "description": "Bestellvorschlag-Lieferanten-Beziehungen", "items": { "$ref": "#/components/schemas/erp-stock-OrderProposalSupplier" } } } }, "erp-stock-OrderProposalGenerateRequest": { "description": "Infos zur Erzeugung eines Bestellvorschlags", "properties": { "generateTemplateId": { "type": "integer", "format": "int64", "description": "Template Vorlage" }, "purchaseStorageId": { "type": "integer", "format": "int64", "description": "ID des Bestell-Lagers" }, "supplierPreference": { "type": "string", "description": "Lieferanten-Präferenz", "enum": [ "CHEAPEST", "FASTEST", "SPECIFIC_SUPPLIER", "MAIN_SUPPLIER", "ALL" ] }, "needsAssessmentPreference": { "type": "string", "description": "Art der Bedarfsermittlung", "enum": [ "REORDER_POINT", "SALES" ] }, "salesNeedsAssessmentBase": { "type": "string", "description": "Grundlage für die SALES-Bedarfsermittlung", "enum": [ "ORDERS", "DELIVERIES" ] }, "averageMethod": { "type": "string", "description": "Mittelwertverfahren für die SALES-Bedarfsermittlung", "enum": [ "ARITHMETIC_MEAN", "MEDIAN", "WEIGHTED_MOVING_AVERAGE", "TRIMMED_MEAN" ] }, "trimmingPercentage": { "type": "number", "description": "Trim-Prozentsatz pro Seite, 0 bis < 50 (Pflichtfeld bei TRIMMED_MEAN)" }, "recognizeReservations": { "type": "boolean", "default": false, "description": "Reservierungen beachten für zu bestellende Menge" }, "recognizeOrders": { "type": "boolean", "default": false, "description": "Bestellungen beachten für zu bestellende Menge" }, "recognizeStock": { "type": "boolean", "default": false, "description": "Lagerbestand beachten für zu bestellende Menge" }, "recognizeFabricationComponentBookings": { "type": "boolean", "default": false, "description": "Material-Abgänge aus Produktion (netto) zusätzlich zum Sales-Verbrauch zählen (nur SALES)" }, "numberOfDaysToOrderFor": { "type": "integer", "format": "int32", "description": "Anzahl Tage, für die bestellt werden soll" }, "observationPeriodInLastDays": { "type": "integer", "format": "int32", "description": "Beobachtungszeitraum in Tagen rückwirkend ab heute (Alternative zu observationPeriods)", "minimum": 0 }, "observationPeriods": { "type": "array", "description": "Konkrete Beobachtungszeiträume (Alternative zu observationPeriodInLastDays)", "items": { "$ref": "#/components/schemas/erp-stock-ObservationPeriod" } }, "recognizeNotYetApprovedPrePaymentReservations": { "type": "boolean", "default": false, "description": "Noch nicht zur Lieferung freigegebene Vorkasse-Reservierungen beachten" }, "cutOffForOrderReservationRecognitionInDays": { "type": "integer", "format": "int32", "description": "Stichtag-Einschränkung für die Reservierungsberücksichtigung in Tagen" }, "recognizeArticlesWithNeedsAssessmentOnlyOnReservationBasis": { "type": "boolean", "default": false, "description": "Artikel mit Bedarfsermittlung nur auf Reservierungsbasis berücksichtigen" }, "givenSupplierAccountId": { "type": "integer", "format": "int64", "description": "ID des Vorgabe-Lieferanten-Accounts" }, "priceRequestInsteadOfOrder": { "type": "boolean", "default": false, "description": "Anfrage statt Bestellung erzeugen" }, "articlePresetId": { "type": "integer", "format": "int64", "description": "ID eines CUnit-Query-Presets zur Einschränkung der Artikel" }, "productGroupIds": { "type": "array", "description": "IDs der Warengruppen, auf die die Artikelauswahl eingeschränkt werden soll", "items": { "type": "integer", "format": "int64", "description": "IDs der Warengruppen, auf die die Artikelauswahl eingeschränkt werden soll" } }, "responsibleUserId": { "type": "integer", "format": "int64", "description": "ID des zuständigen Mitarbeiters, auf den die Artikelauswahl eingeschränkt werden soll" }, "supplierPresetId": { "type": "integer", "format": "int64", "description": "ID eines CUnit-Query-Presets zur Einschränkung der Lieferanten" }, "supplierAccountIds": { "type": "array", "description": "IDs der Lieferanten-Accounts, auf die der Bestellvorschlag eingeschränkt wird", "items": { "type": "integer", "format": "int64", "description": "IDs der Lieferanten-Accounts, auf die der Bestellvorschlag eingeschränkt wird" } } }, "required": [ "needsAssessmentPreference", "purchaseStorageId", "supplierPreference" ] }, "erp-stock-OrderProposalSupplier": { "description": "Bestellvorschlag-Lieferanten-Beziehungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "supplierId": { "type": "string", "description": "ID des Lieferanten" }, "priceRequestInsteadOfOrder": { "type": "boolean", "description": "Soll eine Preisanfrage erstellt werden anstatt einer Bestellung" }, "triggerMailOutputAfterDocumentCreation": { "type": "boolean", "description": "Soll die erstellte Bestellung direkt per Mail versandt werden" }, "createdDocument": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "toBeOrdered": { "type": "boolean" } } }, "erp-stock-OrderProposalLine": { "properties": { "version": { "type": "string", "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 }, "toBeOrderedAmount": { "type": "number", "description": "tatsächlich zu bestellende Menge", "example": 18 }, "priceTotal": { "type": "number", "description": "kalkulierter Gesamtpreis", "readOnly": true }, "productPrices": { "type": "array", "description": "Lieferanten-Preise", "items": { "$ref": "#/components/schemas/erp-product-ProductPrice" }, "readOnly": true }, "productDiscounts": { "type": "array", "description": "Lieferanten-Preisregeln", "items": { "$ref": "#/components/schemas/erp-product-ProductDiscount" }, "readOnly": true }, "determinedUnitPrice": { "type": "number", "description": "ermittelter Einzelpreis", "readOnly": true }, "negotiatedUnitPrice": { "type": "number", "description": "verhandelter Einzelpreis" }, "totalPrice": { "type": "number", "description": "Gesamtpreis", "readOnly": true }, "deliveryTime": { "type": "integer", "format": "int32", "description": "Lieferzeit", "readOnly": true }, "orderDocumentLineRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "toBeOrdered": { "type": "boolean" } }, "required": [ "articleRef", "proposedOrderAmount", "supplierAccountRef", "toBeOrderedAmount" ] }, "erp-finance-OpenItemChangeRequest": { "properties": { "manualPaymentDueDate": { "type": "string", "format": "date", "description": "manuelles vorrangiges Fälligkeitsdatum" }, "dunningBlock": { "type": "boolean", "description": "Mahnsperre" }, "inReview": { "type": "boolean", "description": "In Klärung setzen" }, "basisPaymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentTemplateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "purpose": { "type": "string", "description": "Verwendungszweck" }, "valueDate": { "type": "string", "format": "date", "description": "Valutadatum" }, "clearValueDate": { "type": "boolean", "description": "Valutadatum löschen" }, "comment": { "type": "string", "description": "Kommentar" }, "paymentBlock": { "type": "boolean", "description": "Zahlungssperre" }, "externalNumber": { "type": "string", "description": "Externe OP-Nummer" }, "paymentDiscountOrigin": { "type": "string", "description": "Ursprung der Skontowerte. Bei Änderung auf eine Wert ungleich USER_DEFINED werden die Werte wieder neu geladen.", "enum": [ "FROM_PAYMENT_TERM", "FROM_ACCOUNT", "USER_DEFINED" ] }, "paymentDays1": { "type": "integer", "format": "int32", "description": "Fälligkeit in Tagen (Skonto 1), setzt den Ursprung der Skontowerte auf USER_DEFINED" }, "paymentDiscount1": { "type": "number", "description": "Skonto 1 in Prozent, setzt den Ursprung der Skontowerte auf USER_DEFINED" }, "paymentDays2": { "type": "integer", "format": "int32", "description": "Fälligkeit in Tagen (Skonto 2), setzt den Ursprung der Skontowerte auf USER_DEFINED" }, "paymentDiscount2": { "type": "number", "description": "Skonto 2 in Prozent, setzt den Ursprung der Skontowerte auf USER_DEFINED" }, "taxPerformanceLocation": { "type": "string", "description": "Steuersachverhalt Leistungserbringung (Ersatz für die Kontenermittlung ohne Beleg)", "enum": [ "DOMESTIC", "EUROPEAN_COMMUNITY", "INTERNATIONAL" ] }, "taxState": { "type": "string", "description": "Steuerstatus (Ersatz für die Kontenermittlung ohne Beleg)", "enum": [ "TAX_FREE", "TAX_ABLE" ] }, "performanceCountryCode": { "type": "string", "description": "Länderkennzeichen Leistungsland (ISO Alpha-3)" }, "sourceCountryCode": { "type": "string", "description": "Länderkennzeichen Ursprungsland (ISO Alpha-3)" }, "taxRateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "performanceDate": { "type": "string", "format": "date", "description": "Leistungsdatum (Ersatz für die Kontenermittlung ohne Beleg)" } } }, "common-tag-TagDto": { "description": "List of tags", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "type": { "type": "string", "description": "Tag-Typen", "enum": [ "COMMON", "ACCOUNT", "PRODUCT", "ASSET", "DOCUMENT", "OPEN_ITEM", "CRM_COMMON", "CRM_TASK", "CRM_DEAL", "CRM_PROJECT", "DMS_SHELF_DOCUMENT" ] }, "label": { "type": "string", "description": "Beschriftung des Tags" }, "color": { "type": "string", "description": "Farbe für die Anzeige des Tags" }, "editColor": { "type": "string", "description": "Farbe in Verwaltungs-GUI" }, "searchColor": { "type": "string", "description": "Farbe in Such-GUI" }, "tagGroup": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" } }, "required": [ "label", "type" ] }, "erp-finance-OpenItem": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "order": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "invoice": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "creditNote": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "depositInvoice": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "account": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "number": { "type": "string", "description": "OP-Nummer", "readOnly": true }, "externalNumber": { "type": "string", "description": "Externe OP-Nummer ", "readOnly": true }, "depositPaymentAmount": { "type": "number", "description": "agreed Deposit payment amount", "readOnly": true }, "depositPaymentDate": { "type": "string", "format": "date", "description": "agreed Deposit payment date", "readOnly": true }, "depositPayed": { "type": "boolean", "default": false, "description": "is the agreed deposit payed?", "readOnly": true }, "balancedDate": { "type": "string", "format": "date", "description": "balanced date of this open item (calculated)", "readOnly": true }, "balanceState": { "type": "string", "description": "whether this open item is balanced, partially paid or open", "enum": [ "OPEN", "PARTIALLY_BALANCED", "BALANCED", "OVERPAID" ], "readOnly": true }, "balance": { "type": "number", "description": "saldo", "readOnly": true }, "sumPayments": { "type": "number", "description": "Summe gebuchte Zahlungen", "readOnly": true }, "sumDunnings": { "type": "number", "description": "Summe Mahngebühren und Zinsen", "readOnly": true }, "sumTotalAmount": { "type": "number", "description": "Rechnungsbetrag", "readOnly": true }, "sumDiscountableAmount": { "type": "number", "description": "skontierbarer Rechnungsbetrag", "readOnly": true }, "sumFee": { "type": "number", "description": "allgemeine Gebühren", "readOnly": true }, "records": { "type": "array", "description": "free payments", "items": { "$ref": "#/components/schemas/erp-finance-OpenItemRecord" }, "readOnly": true }, "basisPaymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentDays1": { "type": "integer", "format": "int32", "description": "How many days are given for using the first discount rule", "readOnly": true }, "paymentDiscount1": { "type": "number", "description": "How much discount can be given for speedy payment, rule 1", "readOnly": true }, "paymentDiscount1DueDate": { "type": "string", "format": "date", "description": "Fälligkeitsdatum (Skonto1)", "readOnly": true }, "paymentDays2": { "type": "integer", "format": "int32", "description": "How many days are given for using the second discount rule", "readOnly": true }, "paymentDiscount2": { "type": "number", "description": "How much discount can be given for speedy payment, rule 2", "readOnly": true }, "paymentDiscount2DueDate": { "type": "string", "format": "date", "description": "Fälligkeitsdatum (Skonto2)", "readOnly": true }, "paymentDiscountOrigin": { "type": "string", "description": "Ursprung der Skontowerte (Tage und Prozentsätze)", "enum": [ "FROM_PAYMENT_TERM", "FROM_ACCOUNT", "USER_DEFINED" ] }, "qualifier": { "type": "string", "description": "Does this open item belong to accounts payable or accounts receivable", "enum": [ "PAYABLE", "RECEIVABLE" ], "readOnly": true }, "fullPaymentAmount": { "type": "number", "description": "The full amount of the payment", "readOnly": true }, "paymentAmount": { "type": "number", "description": "Der momentan gültige zu zahlende Betrag", "readOnly": true }, "paymentKind": { "type": "string", "description": "The kind of payment", "enum": [ "PREPAYMENT", "PAYMENT" ], "readOnly": true }, "refundType": { "type": "string", "description": "how should a refund be done?", "enum": [ "DISBURSE", "OFFSET_LATER" ] }, "dunningBlock": { "type": "boolean", "default": false, "description": "Mahnsperre" }, "paymentState": { "type": "string", "description": "Der Zustand der Zahlung", "enum": [ "NO_PAYMENT", "PAYMENT_CREATED", "PAYMENT_TRANSFERRED", "PAYMENT_COMMITTED" ] }, "dunningState": { "type": "string", "description": "Der Mahnzustand", "enum": [ "IN_DUNNING", "NO_DUNNING", "DUNNING_PAID", "DUNNING_PARTIALLY_PAID", "DUNNING_OVERPAID" ] }, "dunningLevel": { "type": "integer", "format": "int32", "description": "Die Mahnstufe", "readOnly": true }, "dunningCount": { "type": "integer", "format": "int32", "description": "Anzahl Mahnpositionen/Mahnungen für diesen OP", "readOnly": true }, "originalPaymentDueDate": { "type": "string", "format": "date", "description": "Ursprüngliches Fälligkeitsdatum", "readOnly": true }, "paymentDaysNet": { "type": "integer", "format": "int32", "description": "Fälligkeit in Tagen" }, "paymentDueDate": { "type": "string", "format": "date", "description": "Fälligkeitsdatum" }, "valueDate": { "type": "string", "format": "date", "description": "Valutadatum" }, "paymentDiscount1Amount": { "type": "number", "description": "Skontobetrag 1" }, "paymentDiscount2Amount": { "type": "number", "description": "Skontobetrag 2" }, "paymentTemplateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "purpose": { "type": "string", "description": "Verwendungszweck" }, "comment": { "type": "string", "description": "Kommentar" }, "paymentBlock": { "type": "boolean", "default": false, "description": "Zahlungssperre" }, "tags": { "type": "array", "description": "List of tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "paymentPlan": { "$ref": "#/components/schemas/erp-finance-OpenItemPaymentPlan" }, "valueDateReadOnly": { "type": "boolean", "default": false, "description": "Valutadatum schreibgeschützt" }, "canBeReopened": { "type": "boolean", "default": false, "description": "kann wiedereröffet werden" }, "currencyCode": { "type": "string", "description": "Währung des offenen Postens (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der Währung zu Basiswährung" }, "baseCurrencyCode": { "type": "string", "description": "Basiswährung des offenen Postens (ISO-A3)" }, "baseDepositPaymentAmount": { "type": "number", "description": "Vereinbarter Anzahlungsbetrag in Basiswährung" }, "baseSumPayments": { "type": "number", "description": "Summe der Zahlungen in Basiswährung" }, "baseSumDiscount": { "type": "number", "description": "Summe der Abzüge (Skonto usw.) in Basiswährung" }, "baseSumDunnings": { "type": "number", "description": "Summe der Mahngebühren und Zinsen in Basiswährung" }, "baseSumTotalAmount": { "type": "number", "description": "Gesamtsumme der Rechnungsbeträge in Basiswährung" }, "baseSumDiscountableAmount": { "type": "number", "description": "Summe der skontierbaren Rechnungsbeträge in Basiswährung" }, "baseBalance": { "type": "number", "description": "Offener Betrag (Saldo) in Basiswährung" }, "baseSumFee": { "type": "number", "description": "allgemeine Gebühren in Basiswährung" }, "blockedByDocument": { "type": "boolean", "default": false, "description": "Ist der OP durch ein Dokument geblockt?" }, "bookingAccountType": { "type": "string", "description": "Buchung auf Lieferant oder Kunde bei manuellen OPs", "enum": [ "CUSTOMER", "SUPPLIER" ], "readOnly": true }, "taxPerformanceLocation": { "type": "string", "description": "Steuersachverhalt Leistungserbringung (von außen setzbar, wenn kein Beleg vorhanden ist)", "enum": [ "DOMESTIC", "EUROPEAN_COMMUNITY", "INTERNATIONAL" ] }, "taxState": { "type": "string", "description": "Steuerstatus (von außen setzbar, wenn kein Beleg vorhanden ist)", "enum": [ "TAX_FREE", "TAX_ABLE" ] }, "performanceCountryCode": { "type": "string", "description": "Länderkennzeichen Leistungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)" }, "sourceCountryCode": { "type": "string", "description": "Länderkennzeichen Ursprungsland (ISO Alpha-3, von außen setzbar, wenn kein Beleg vorhanden ist)" }, "taxRateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "performanceDate": { "type": "string", "format": "date", "description": "Leistungsdatum (von außen setzbar, wenn kein Beleg vorhanden ist)" }, "balanced": { "type": "boolean" } }, "required": [ "number" ] }, "erp-finance-OpenItemPaymentPlan": { "description": "Zahlungsplan", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "paymentPlanType": { "type": "string", "description": "Zahlungsplantyp", "enum": [ "RULE", "MANUAL" ] }, "dueDateCalculation": { "type": "string", "description": "Fälligkeitsregel" }, "amount": { "type": "number", "description": "Betrag" }, "startDate": { "type": "string", "format": "date", "description": "Startdatum" }, "endDate": { "type": "string", "format": "date", "description": "Enddatum" }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv" }, "dueDate": { "type": "string", "format": "date", "description": "Fälligkeitsdatum" }, "manualRuleEntries": { "type": "array", "description": "manuelle Buchungsvorgaben", "items": { "$ref": "#/components/schemas/erp-finance-PaymentPlanManualRule" } }, "currencyCode": { "type": "string", "description": "Währung des Zahlungsplans (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der Währung zu Basiswährung" }, "baseCurrencyCode": { "type": "string", "description": "Basiswährung des Zahlungsplans (ISO-A3)" }, "baseAmount": { "type": "number", "description": "Betrag in Basiswährung" } } }, "erp-finance-OpenItemRecord": { "description": "free payments", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "recordDate": { "type": "string", "format": "date", "description": "record date", "readOnly": true }, "totalAmount": { "type": "number", "description": "record total amount", "readOnly": true }, "discountableAmount": { "type": "number", "description": "record discountable amount", "readOnly": true }, "amount": { "type": "number", "description": "record amount", "readOnly": true }, "discountAmount": { "type": "number", "description": "record discount amount", "readOnly": true }, "bookingRecordId": { "type": "integer", "format": "int64", "description": "ref to the financialBookingRecord", "readOnly": true }, "origin": { "type": "string", "description": "origin for this record", "enum": [ "DOCUMENT", "PAYMENT", "PAYMENT_DISSOLVED", "REIMBURSEMENT", "REIMBURSEMENT_DISSOLVED", "MANUAL_CLOSURE", "MANUAL_REOPENING", "DUNNING", "DUNNING_DISSOLVED", "DUNNING_INTEREST_REVERSAL", "IMPORT", "PAYMENT_PLAN", "PAYMENT_PLAN_ENTRY", "PAYMENT_IMPORT", "CLEARING", "CLEARING_DISSOLVED", "DEPOSIT", "CREDIT_NOTE", "BALANCE_ADJUSTMENT", "FEE", "DUNNING_PAYMENT", "DUNNING_PAYMENT_DISSOLVED", "POS_PAYMENT" ], "readOnly": true }, "document": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethod": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accountBankdetailsRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "transactionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "bankAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "businessTransaction": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "revertedByRecordId": { "type": "integer", "format": "int64", "description": "id des records, der diesen storniert hat", "readOnly": true }, "transactionId": { "type": "integer", "format": "int64", "description": "id der transaction, die diesen record hervorgerufen hat", "readOnly": true }, "qualifier": { "type": "string", "description": "qualifier of open item", "enum": [ "PAYABLE", "RECEIVABLE", "PAYMENT_RECEIVED", "PAYMENT_SENT", "PAYMENT_RECEIVED_REVERTED", "PAYMENT_SENT_REVERTED", "DUNNING_RECEIVABLE", "DUNNING_PAYABLE", "DUNNING_RECEIVABLE_REVERTED", "DUNNING_PAYABLE_REVERTED" ], "readOnly": true }, "bookingType": { "type": "string", "description": "Buchungsart der OP-Bewegung (abgeleitet aus Herkunft und Buchungsart)", "enum": [ "PAYABLE", "RECEIVABLE", "PAYMENT_PAYABLE", "PAYMENT_RECEIVABLE", "PAYMENT_PAYABLE_DISSOLVED", "PAYMENT_RECEIVABLE_DISSOLVED", "DUNNING_PAYABLE", "DUNNING_RECEIVABLE", "DUNNING_PAYABLE_DISSOLVED", "DUNNING_RECEIVABLE_DISSOLVED" ], "readOnly": true }, "number": { "type": "string", "description": "Eine Vorgangsnummer die zur Buchung führte", "readOnly": true }, "comment": { "type": "string", "description": "comment", "readOnly": true }, "locked": { "type": "boolean", "description": "locked", "readOnly": true }, "revertable": { "type": "boolean", "description": "revertable", "readOnly": true }, "recordReferenceNumber": { "type": "string", "description": "record reference number", "readOnly": true }, "dunningLvl": { "type": "integer", "format": "int32", "description": "Mahnstufe", "readOnly": true }, "currencyCode": { "type": "string", "description": "Währung des offenen Postens (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der Währung zu Basiswährung" }, "baseCurrencyCode": { "type": "string", "description": "Basiswährung des offenen Postens (ISO-A3)" }, "baseAmount": { "type": "number", "description": "Buchungsbetrag in Basiswährung" }, "baseDiscountAmount": { "type": "number", "description": "Abzugsbetrag in Basiswährung" }, "baseTotalAmount": { "type": "number", "description": "Gesamtbetrag in Basiswährung" }, "baseDiscountableAmount": { "type": "number", "description": "Skontierbarer Gesamtbetrag in Basiswährung" }, "baseDunningFee": { "type": "number", "description": "Mahngebühren in Basiswährung" }, "baseDunningInterest": { "type": "number", "description": "Mahnzinsen in Basiswährung" } } }, "erp-finance-PaymentPlanManualRule": { "description": "manuelle Buchungsvorgaben", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "dueDate": { "type": "string", "format": "date", "description": "Fälligkeit" }, "amount": { "type": "number", "description": "Betrag" }, "processed": { "type": "boolean", "description": "bereits verarbeitet", "readOnly": true }, "currencyCode": { "type": "string", "description": "Währung (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der Währung zu Basiswährung" }, "baseCurrencyCode": { "type": "string", "description": "Basiswährung (ISO-A3)" }, "baseAmount": { "type": "number", "description": "Betrag in Basiswährung" } } }, "erp-finance-PaymentPlanChangeRequest": { "properties": { "paymentPlanType": { "type": "string", "description": "Zahlungsplantyp", "enum": [ "RULE", "MANUAL" ] }, "dueDateCalculation": { "type": "string", "description": "Fälligkeitsregel" }, "clearDueDateCalculation": { "type": "boolean", "description": "Fälligkeitsregel löschen" }, "amount": { "type": "number", "description": "Betrag" }, "clearAmount": { "type": "boolean", "description": "Betrag löschen" }, "startDate": { "type": "string", "format": "date", "description": "Startdatum" }, "clearStartDate": { "type": "boolean", "description": "Startdatum löschen" }, "endDate": { "type": "string", "format": "date", "description": "Enddatum" }, "clearEndDate": { "type": "boolean", "description": "Enddatum löschen" }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "description": "Aktiv" }, "dueDate": { "type": "string", "format": "date", "description": "Fälligkeitsdatum" }, "clearDueDate": { "type": "boolean", "description": "Fälligkeitsdatum löschen" }, "manualRuleEntries": { "type": "array", "description": "manuelle Buchungsvorgaben", "items": { "$ref": "#/components/schemas/erp-finance-PaymentPlanManualRule" } } } }, "erp-finance-OpenItemMatchingRule": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "bankRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "ruleType": { "type": "string", "description": "The type of rule, i.e. used while looking through invoice-related open items", "enum": [ "INVOICE", "ORDER", "DEPOSIT_INVOICE", "NAME", "CUSTOMER_NUMBER", "SUPPLIER_NUMBER", "AMOUNT", "EXTERNAL_NUMBER" ] }, "points": { "type": "integer", "format": "int32", "description": "The number of points to award for fit" } } }, "erp-finance-Ledger": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "label": { "type": "string", "description": "label for this account number" } }, "required": [ "ledgerNumber" ] }, "erp-finance-LedgerAssignment": { "properties": { "version": { "type": "string", "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", "PAYABLE_DUNNING_FEE_LEDGER", "PAYABLE_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", "POS_INTERIM_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", "format": "date", "description": "Valid From" }, "validUntil": { "type": "string", "format": "date", "description": "Valid Until" }, "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": { "type": "string", "description": "Resulting Account Number / Ledger", "maxLength": 20 }, "transactionKey": { "type": "string", "description": "Resulting Transaction Key", "maxLength": 4 }, "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" ] }, "manualClosureOrigin": { "type": "string", "default": "IGNORE", "description": "Ursprung des OP-Abschlusses, für den diese Kontenzuordnung gilt", "enum": [ "MANUAL", "AUTOMATIC", "IGNORE" ] }, "bookingAccountType": { "type": "string", "description": "Buchungskontotyp (Debitor/Kreditor) des OP, für den diese Kontenzuordnung gilt; leer = egal", "enum": [ "CUSTOMER", "SUPPLIER" ] }, "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", "default": false, "description": "Buchungen unterdrücken" }, "description": { "type": "string", "description": "Buchungstext" } }, "required": [ "assignmentType", "taxPerformanceLocation" ] }, "erp-finance-Dunning": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "dunningLevelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "dunningDate": { "type": "string", "format": "date", "description": "Mahndatum" }, "nextDunningDate": { "type": "string", "format": "date", "description": "Nächstes Mahndatum" }, "dunningFee": { "type": "number", "description": "Mahngebühr" }, "dunningInterest": { "type": "number", "description": "Mahnzinsen", "readOnly": true }, "dunningTotal": { "type": "number", "description": "Mahnzinsen in Basiswährung", "readOnly": true }, "feeHandling": { "type": "string", "description": "Umgang mit der Mahngebühr", "enum": [ "DISTRIBUTE", "IGNORE", "OWN_OPEN_ITEM" ] }, "positions": { "type": "array", "description": "Mahnpositionen", "items": { "$ref": "#/components/schemas/erp-finance-DunningPosition" }, "readOnly": true }, "printedAt": { "type": "string", "format": "date", "description": "Datum des Drucks", "readOnly": true }, "dunningState": { "type": "string", "description": "State der Mahnung", "enum": [ "CREATED", "FIXATED", "PRINTED", "DISSOLVED" ], "readOnly": true }, "paymentConsideredUntil": { "type": "string", "format": "date", "description": "Zahlung berücksichtigt bis (Andruck auf der Mahnung)" }, "languageCode": { "type": "string", "description": "Sprache der Mahntexte (ISO 639-1)" }, "headerContent": { "$ref": "#/components/schemas/erp-finance-Dunning.WithDefaultsString" }, "footerContent": { "$ref": "#/components/schemas/erp-finance-Dunning.WithDefaultsString" }, "subjectLine": { "$ref": "#/components/schemas/erp-finance-Dunning.WithDefaultsString" }, "currencyCode": { "type": "string", "description": "Währung der Mahnung (ISO-A3)" }, "exchangeRate": { "type": "number", "description": "Kurs der Währung zu Basiswährung" }, "baseCurrencyCode": { "type": "string", "description": "Basiswährung der Mahnung (ISO-A3)", "readOnly": true }, "baseDunningFee": { "type": "number", "description": "Mahngebühr in Basiswährung", "readOnly": true }, "baseDunningInterest": { "type": "number", "description": "Mahnzinsen in Basiswährung", "readOnly": true }, "baseDunningTotal": { "type": "number", "description": "Mahnzinsen in Basiswährung", "readOnly": true } } }, "erp-finance-Dunning.WithDefaultsString": { "description": "Betreff der Mahnung (individueller Text und Standard der Mahnstufe)", "properties": { "value": { "type": "string", "description": "Individueller Wert (leer = Standard wird verwendet)" }, "defaultValue": { "type": "string", "description": "Standardwert aus der Mahnstufe", "readOnly": true } } }, "erp-finance-DunningPosition": { "description": "Mahnpositionen", "properties": { "version": { "type": "string", "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" }, "openItemRecordRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "documentRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "dunningLevelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "dunningInterest": { "type": "number", "description": "Mahnzinsen", "readOnly": true }, "currencyCode": { "type": "string", "description": "Währung der Mahnung (ISO-A3)", "readOnly": true }, "exchangeRate": { "type": "number", "description": "Kurs der Währung zu Basiswährung", "readOnly": true }, "baseCurrencyCode": { "type": "string", "description": "Basiswährung der Mahnung (ISO-A3)", "readOnly": true }, "baseDunningFee": { "type": "number", "description": "Mahngebühr in Basiswährung", "readOnly": true }, "baseDunningInterest": { "type": "number", "description": "Mahnzinsen in Basiswährung", "readOnly": true }, "dunningAmount": { "type": "number", "description": "Anzumahnender Betrag (Restbetrag = Rechnungsbetrag - bereits gezahlt)" }, "invoiceTotalAmount": { "type": "number", "description": "Rechnungsbetrag (Brutto), sofern der OP eine Rechnung hat", "readOnly": true }, "paidAmount": { "type": "number", "description": "Bereits gezahlter Betrag", "readOnly": true } } }, "erp-finance-DunningLevel": { "properties": { "version": { "type": "string", "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", "format": "int32", "description": "Mahnstufen" }, "description": { "type": "string", "description": "Beschreibung", "minLength": 1 }, "nextDue": { "type": "integer", "format": "int32", "description": "Zahlungsfälligkeit nach Mahnung in Tagen" }, "dunningTexts": { "type": "array", "description": "Texte in den angebotenen Sprachen für Einzel- und Sammelmahnung", "items": { "$ref": "#/components/schemas/erp-finance-LocalizedContentTemplate" } }, "dunningAfterDays": { "type": "integer", "format": "int32", "description": "Karenzzeit nach OP-Fälligkeit in Tagen" }, "fee": { "type": "number", "description": "Mahngebühr" }, "interest": { "type": "number", "description": "Zinsen" }, "currencyCode": { "type": "string", "description": "Währung", "readOnly": true } }, "required": [ "currencyCode", "description", "dunningAfterDays", "dunningLvl", "fee", "interest", "nextDue" ] }, "erp-finance-LocalizedContentTemplate": { "description": "Texte in den angebotenen Sprachen für Einzel- und Sammelmahnung", "properties": { "version": { "type": "string", "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ßtext" }, "subjectLine": { "type": "string", "description": "Betreff" }, "dunningLevel": { "type": "integer", "format": "int64", "description": "Mahnungs-ID" } }, "required": [ "footerContent", "headerContent", "languageCode", "subjectLine" ] }, "erp-finance-CostCenter": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Kostenstelle", "minLength": 1 }, "description": { "type": "string", "description": "Bezeichnung für die Kostenstelle" } }, "required": [ "label" ] }, "erp-finance-BusinessTransaction": { "properties": { "version": { "type": "string", "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", "format": "int64", "description": "Sortierung des Geschäftsvorfall" }, "label": { "type": "string", "description": "Kurze Beschreibung" }, "description": { "type": "string", "description": "Beschreibung des Geschäftsvorfall" } } }, "erp-document-Document": { "description": "document to update", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "number": { "type": "string", "description": "Belegnummer", "maxLength": 255, "minLength": 0 }, "accountNumber": { "type": "string", "description": "Kontonummer der zugehörigen Organisationseinheit", "maxLength": 255, "minLength": 0, "readOnly": true }, "customerNumber": { "type": "string", "description": "Kundennummer", "maxLength": 255, "minLength": 0, "readOnly": true }, "ourCustomerNumber": { "type": "string", "description": "Kundennummer beim Lieferanten", "maxLength": 255, "minLength": 0, "readOnly": true }, "supplierNumber": { "type": "string", "description": "Lieferantennummer", "maxLength": 255, "minLength": 0, "readOnly": true }, "salesAgentNumber": { "type": "string", "description": "Vertreternummer", "maxLength": 255, "minLength": 0, "readOnly": true }, "externalIdentifier": { "type": "string", "description": "Externe Kennung", "maxLength": 255, "minLength": 0 }, "externalNumber": { "type": "string", "description": "Externe Belegnummer", "maxLength": 255, "minLength": 0 }, "published": { "type": "boolean", "default": false, "description": "Ist der Beleg veröffentlicht (gedruckt, per Mail versendet)?", "readOnly": true }, "frozen": { "type": "boolean", "default": false, "description": "Ist der Beleg festgeschrieben?", "readOnly": true }, "qualifier": { "type": "string", "description": "Art des Belegs", "enum": [ "SALE", "PURCHASE", "COMMISSION", "SALES_CONTRACT", "PURCHASE_CONTRACT", "POINT_OF_SALE", "FABRICATION", "RMA" ], "readOnly": true }, "accountId": { "type": "string", "description": "ID der Organisationseinheit" }, "billingAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "documentDate": { "type": "string", "format": "date", "description": "Belegdatum" }, "performanceDate": { "type": "string", "format": "date", "description": "Leistungsdatum" }, "valueDate": { "type": "string", "format": "date", "description": "Valutadatum" }, "taxable": { "type": "boolean", "default": true, "description": "Steuerpflichtig oder steuerfrei" }, "taxIdentificationNumber": { "type": "string", "description": "Umsatzsteuer-Identifikationsnummer", "maxLength": 255, "minLength": 0 }, "taxIdVerificationState": { "type": "string", "description": "Überprüfungsstatus der Steueridentifikationsnummer", "enum": [ "NOT_YET_VERIFIED", "VALID", "VALID_WITH_INVALID_ADDRESS", "INVALID", "NOT_NEEDED" ], "readOnly": true }, "valitoolValidationState": { "type": "string", "description": "Validierungsstatus bei elektronischen Rechnungen", "enum": [ "NOT_VALIDATED", "VALID", "NOT_VALID" ], "readOnly": true }, "billingType": { "type": "string", "description": "Abrechnungstyp", "enum": [ "GROSS", "NET" ] }, "documentType": { "type": "string", "description": "Belegtyp (intern)", "readOnly": true }, "documentTypeId": { "type": "integer", "format": "int64", "description": "ID des Belegtyps", "readOnly": true }, "documentTypeCategory": { "type": "string", "description": "Dokumenttypen", "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_PROFORMA_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PROGRESS_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PROGRESS_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_DEPOSIT_INVOICE", "CUSTOMER_DEPOSIT_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "CUSTOMER_RETURN_ANNOUNCEMENT", "CUSTOMER_GOODS_RETURN", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "SUPPLIER_DEPOSIT_INVOICE", "SUPPLIER_PROGRESS_INVOICE", "SUPPLIER_PARTIAL_INVOICE", "SUPPLIER_FINAL_INVOICE", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "SUPPLIER_COMMISSION_CREDIT_NOTE", "SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_RETURN_CASH_RECEIPT", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_WITHDRAWAL", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ], "readOnly": true }, "documentState": { "$ref": "#/components/schemas/erp-document-DocumentTypeState" }, "currencyCode": { "type": "string", "description": "Währung (ISO-Code, Alpha-3)" }, "exchangeRate": { "type": "number", "description": "Wechselkurs" }, "exchangeRateOrigin": { "type": "string", "default": "AUTOMATIC", "description": "Ursprung für Währungskursermittlung", "enum": [ "AUTOMATIC", "AUTOMATIC_FOR_CURRENT_DATE", "USER_DEFINED" ] }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "totalBeforeModifier": { "type": "number", "description": "Gesamtpreis vor Rabatt [BRUTTO, NETTO]", "readOnly": true }, "totalPriceModifier": { "type": "number", "description": "Rabatt gesamt [BRUTTO, NETTO]", "readOnly": true }, "totalLinePriceModifier": { "type": "number", "description": "Positionsrabatt gesamt [BRUTTO, NETTO]", "readOnly": true }, "totalDocumentPriceModifier": { "type": "number", "description": "Belegrabatt gesamt [BRUTTO, NETTO]", "readOnly": true }, "totalNetPrice": { "type": "number", "description": "Gesamtpreis netto", "readOnly": true }, "totalVat": { "type": "number", "description": "Gesamte Mehrwertsteuer", "readOnly": true }, "totalGrossPrice": { "type": "number", "description": "Gesamtpreis brutto", "readOnly": true }, "roundingAmount": { "type": "number", "description": "Endbetragsrundung: Differenz zwischen gerundetem Brutto und (Netto + MwSt)", "readOnly": true }, "paymentTermRef": { "$ref": "#/components/schemas/erp-document-PaymentTermRef" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "depositPaymentAmount": { "type": "number", "description": "Vereinbarter Anzahlungsbetrag" }, "depositPaymentDate": { "type": "string", "format": "date", "description": "Vereinbartes Anzahlungsdatum", "readOnly": true }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryDate": { "type": "string", "format": "date", "description": "Voraussichtliches Lieferdatum" }, "deliveryDateEnd": { "type": "string", "format": "date", "description": "Voraussichtliches Lieferende (nur wenn Lieferdatum gesetzt)" }, "confirmedDeliveryDate": { "type": "string", "format": "date", "description": "Bestätigtes Lieferdatum" }, "confirmedDeliveryDateEnd": { "type": "string", "format": "date", "description": "Bestätigtes Lieferende (nur wenn bestätigtes Lieferdatum gesetzt)" }, "shippingDate": { "type": "string", "format": "date", "description": "Versanddatum" }, "deliveryQuantityPackages": { "type": "integer", "format": "int32", "description": "Voraussichtliche Paketanzahl (nur Info)" }, "deliveryText": { "type": "string", "description": "Zusätzlicher Liefertext", "maxLength": 255, "minLength": 0 }, "deliveryApproved": { "type": "boolean", "default": true, "description": "Ist der Beleg zur Lieferung freigegeben?" }, "dropShippingInvoiceApproved": { "type": "boolean", "description": "Ist der Streckengeschäfts-Beleg zur Rechnung freigegeben?", "readOnly": true }, "orderedOn": { "type": "string", "format": "date", "description": "Bestelldatum" }, "orderedByPersonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "orderedBy": { "type": "string", "description": "Name der bestellenden Person", "maxLength": 255, "minLength": 0 }, "taxLiabilityReversed": { "type": "boolean", "default": false, "description": "Reverse-Charge-Verfahren nach §13b UStG?" }, "collectiveInvoice": { "type": "boolean", "default": false, "description": "Sammelrechnung?" }, "texts": { "type": "array", "description": "Liste der Belegtexte", "items": { "$ref": "#/components/schemas/erp-document-DocumentText" } }, "lines": { "type": "array", "description": "Liste der Belegpositionen", "items": { "$ref": "#/components/schemas/erp-document-DocumentLine" } }, "shippingCosts": { "type": "array", "description": "Versandkostenpositionen", "items": { "$ref": "#/components/schemas/erp-document-DocumentShippingCost" } }, "posPayments": { "type": "array", "description": "Kassen-Zahlungspositionen", "items": { "$ref": "#/components/schemas/erp-document-DocumentPosPayment" } }, "shippingCostSum": { "type": "number", "description": "Summe der Versandkosten (netto/brutto)", "readOnly": true }, "priceModifiers": { "type": "array", "description": "Preisänderungen (z.B. Rabatte)", "items": { "$ref": "#/components/schemas/erp-document-DocumentPriceModifier" } }, "taxes": { "type": "array", "description": "Steuerzusammenfassung für diesen Beleg", "items": { "$ref": "#/components/schemas/erp-document-DocumentTax" }, "readOnly": true }, "defaultAddress": { "$ref": "#/components/schemas/erp-document-DocumentAddress" }, "billingAddress": { "$ref": "#/components/schemas/erp-document-DocumentAddress" }, "deliveryAddress": { "$ref": "#/components/schemas/erp-document-DocumentAddress" }, "returnDeliveryAddress": { "$ref": "#/components/schemas/erp-document-DocumentAddress" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "stackProcessingType": { "type": "string", "description": "Stapelverarbeitungsinformationen für Aufträge", "enum": [ "NO_PICKING", "ACCORDING_TO_CRITERIA", "ONLY_FULL_ORDER", "ONLY_FULL_ORDER_LINES", "AVAILABLE_QUANTITIES", "NO_PROCESSING", "FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES", "AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES", "FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES", "AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES", "AVAILABLE_QUANTITIES_FINISH_ORDER" ] }, "stackProcessingPriority": { "type": "integer", "format": "int32", "description": "Priorität in der Stapelverarbeitung" }, "maxDeliveries": { "type": "integer", "format": "int32", "description": "Maximal mögliche Lieferungen" }, "taxPerformanceLocation": { "type": "string", "description": "Ort der steuerlichen Leistungserbringung", "enum": [ "DOMESTIC", "EUROPEAN_COMMUNITY", "INTERNATIONAL" ] }, "performanceCountryCode": { "type": "string", "description": "Länderkennzeichen Leistungsland (ISO Alpha-3)" }, "sourceCountryCode": { "type": "string", "description": "Länderkennzeichen Ursprungsland (ISO Alpha-3)" }, "afterPickingTargetDocumentTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "grossWeight": { "type": "number", "description": "Gesamtbruttogewicht" }, "grossWeightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "userDefinedWeight": { "type": "boolean", "default": false, "description": "Gesamtgewicht wurde manuell gesetzt" }, "tags": { "type": "array", "description": "Tags für diesen Beleg", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "reportGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defaultStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "locationRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "cashDiscountableTotalGrossPrice": { "type": "number", "description": "Skontofähiger Bruttogesamtbetrag", "readOnly": true }, "contractDetail": { "$ref": "#/components/schemas/erp-document-DocumentContractDetail" }, "posDetail": { "$ref": "#/components/schemas/erp-document-DocumentPosDetail" }, "fabricationDetail": { "$ref": "#/components/schemas/erp-fabrication-DocumentFabricationDetail" }, "buyerReference": { "type": "string", "description": "Leitweg-ID", "maxLength": 255, "minLength": 0 }, "en16931Profile": { "type": "string", "description": "EN16931-Profil für elektronische Rechnungen", "enum": [ "ZUGFERD", "XRECHNUNG", "NO_EN_PROFILE" ] }, "importType": { "type": "string", "description": "Importmodus des Belegs", "enum": [ "NOT_IMPORTED", "TRANSFERABLE", "TRANSFERABLE_AND_EDITABLE", "HISTORICAL_DATA", "E_INVOICE", "EXTERNALLY_CREATED" ], "readOnly": true }, "paymentPlan": { "type": "boolean", "default": false, "description": "Zahlungsplan vorhanden?" }, "calculationMode": { "type": "string", "description": "Berechnungsmodus", "enum": [ "HORIZONTAL", "VERTICAL" ] }, "processedByWorkflow": { "type": "boolean", "description": "Wird vom Workflow verarbeitet?", "readOnly": true }, "referencedOrderNumber": { "type": "string", "description": "Bestellnummer aus Vorbeleg", "readOnly": true }, "additionalInfo": { "$ref": "#/components/schemas/erp-document-DocumentAdditionalInfo" }, "languageCode": { "type": "string", "description": "Sprache" }, "baseCurrencyCode": { "type": "string", "description": "Basiswährung des Belegs" }, "baseTotalNetPrice": { "type": "number", "description": "Gesamtpreis - Netto Basiswährung" }, "baseTotalLinePriceModifier": { "type": "number", "description": "Preisanpassungen - Belegpositionssumme Basiswährung" }, "baseTotalDocumentPriceModifier": { "type": "number", "description": "Preisanpassungen - Beleg Basiswährung" }, "baseTotalGrossPrice": { "type": "number", "description": "Gesamtpreis - Brutto Basiswährung" }, "baseDepositPaymentAmount": { "type": "number", "description": "Vorkassebetrag Basiswährung" }, "baseCashDiscountableTotalGrossPrice": { "type": "number", "description": "skontierbarer Rechnungsbetrag Basiswährung" }, "forwardEmailToShipper": { "type": "boolean", "default": false, "description": "E-Mail an Versender übergeben" }, "forwardPhoneToShipper": { "type": "boolean", "default": false, "description": "Telefon an Versender übergeben" }, "posReceiptPaymentSum": { "type": "number", "description": "Quittung: Summe Zahlbetrag" }, "posReceiptBalance": { "type": "number", "description": "Quittung: Saldo\npositiver Wert: Betrag der noch zu zahlen ist\nnegativer Wert: überzahlter Betrag / Rückgeld\n" }, "posReceiptChangeAmount": { "type": "number", "description": "Rückgeld" }, "posReceiptBalanced": { "type": "boolean", "default": false, "description": "Ist die Quittung ausbalanciert, also bezahlt und kein Rückgeld\ntrue wenn die Quittung ausbalanciert ist\n" }, "posReceiptPayed": { "type": "boolean", "default": false, "description": "Ist die Quittung bezahlt\ntrue wenn die Quittung bezahlt ist\n" }, "dropShipping": { "type": "boolean", "description": "Streckengeschäft", "readOnly": true }, "totalGrossVolumeInCubicMeters": { "type": "number", "description": "total gross Volume in cubic meters", "readOnly": true } }, "required": [ "accountId", "billingType", "calculationMode", "currencyCode", "defaultAddress", "deliveryApproved", "documentDate", "number" ] }, "erp-document-DocumentAdditionalInfo": { "description": "Zusätzliche Infos zu Entscheidungen im Belegkontext", "properties": { "calculationModeOrigin": { "type": "string", "description": "Herkunft des Berechnungsmodus", "enum": [ "FROM_BILLING_ADDRESS", "FROM_DEFAULT_ADDRESS", "FROM_ACCOUNT", "FROM_SALES_CHANNEL", "FROM_DOCUMENT_PARAMS", "USER_DEFINED" ], "readOnly": true }, "roundingMode": { "type": "string", "description": "Aktiver Rundungsmodus für diesen Beleg (eingefroren aus dem SalesChannel)", "enum": [ "NONE", "SWITZERLAND" ], "readOnly": true }, "en16931Origin": { "type": "string", "description": "Herkunft des E-Rechnungs-Profils", "enum": [ "FROM_BILLING_ADDRESS", "FROM_DEFAULT_ADDRESS", "FROM_ACCOUNT_PARAMS", "USER_DEFINED" ], "readOnly": true }, "buyerReferenceOrigin": { "type": "string", "description": "Herkunft der Käufer-Referenz", "enum": [ "FROM_BILLING_ADDRESS", "FROM_DEFAULT_ADDRESS", "USER_DEFINED" ], "readOnly": true }, "previousDecisions": { "type": "string", "description": "Enthält die Ergebnisse von vorherigen Entscheidungen des Benutzers zu diesem Document", "readOnly": true }, "taxSituationOrigin": { "type": "string", "description": "Steuersachverhalt Herkunft", "enum": [ "UNDEFINED", "USER_DEFINED", "FROM_CUSTOMER", "FROM_SUPPLIER", "FROM_SALES_AGENT", "FROM_DELIVERY_ADDRESS", "FROM_DEFAULT_ADDRESS", "FROM_OWN_ADDRESS", "FROM_TAX_ID" ] }, "languageCodeOrigin": { "type": "string", "description": "Herkunft der Sprache", "enum": [ "FROM_DELIVERY_ADDRESS", "FROM_BILLING_ADDRESS", "FROM_DEFAULT_ADDRESS", "FROM_RETURN_DELIVERY_ADDRESS", "FROM_MY_COMPANY" ] }, "contextParameters": { "type": "array", "description": "Parameter, welche im {@link DocumentContext} verwendet wurden", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } }, "incomingGoodsTarget": { "$ref": "#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTarget" }, "translations": { "type": "array", "description": "Übersetzungen", "items": { "$ref": "#/components/schemas/erp-document-DocumentAdditionalInfo.PrintedTranslatedField" } }, "incomingGoodsTargetsPerLine": { "type": "array", "description": "Ziele für den Wareneingang je Belegposition", "items": { "$ref": "#/components/schemas/erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine" } } } }, "erp-document-DocumentAdditionalInfo.IncomingGoodsTarget": { "description": "Ziele für den Wareneingang", "properties": { "storageBinId": { "type": "integer", "format": "int64", "description": "Lagerplatz für den Wareneingang" }, "pickTrolleyId": { "type": "integer", "format": "int64", "description": "Pickwagen für den Wareneingang" } } }, "erp-document-DocumentAdditionalInfo.IncomingGoodsTargetOfLine": { "description": "Ziele für den Wareneingang", "properties": { "storageBinId": { "type": "integer", "format": "int64", "description": "Lagerplatz für den Wareneingang" }, "pickTrolleyId": { "type": "integer", "format": "int64", "description": "Pickwagen für den Wareneingang" }, "lineId": { "type": "integer", "format": "int64", "description": "ID einer Belegposition" }, "sourceLineId": { "type": "integer", "format": "int64", "description": "ID einer Vorbelegposition" } } }, "erp-document-DocumentAdditionalInfo.PrintedTranslatedField": { "description": "Übersetzungen", "properties": { "entityName": { "type": "string", "description": "zur welcher Entity?" }, "fieldName": { "type": "string", "description": "name des Feldes" }, "content": { "type": "string", "description": "Übersetzung" } } }, "erp-document-DocumentAddress": { "description": "Retoure-Lieferadresse", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salutation": { "type": "string", "description": "salutation for this address" }, "title": { "type": "string", "description": "Titel" }, "name1": { "type": "string", "description": "address line 1" }, "name2": { "type": "string", "description": "address line 2" }, "name3": { "type": "string", "description": "address line 3" }, "globalLocationNumber": { "type": "string", "description": "GLN" }, "street": { "type": "string", "description": "Street" }, "streetAddressNumber": { "type": "string", "description": "Street address number" }, "additionalAddressLine1": { "type": "string", "description": "Additional address line1" }, "additionalAddressLine2": { "type": "string", "description": "Additional address line2" }, "city": { "type": "string", "description": "city" }, "regionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "postcode": { "type": "string", "description": "Postcode" }, "postOfficeBox": { "type": "string", "description": "Post office box" }, "countryCode": { "type": "string", "description": "country code IsoAlpha3" }, "phoneContact": { "type": "string", "description": "Phone contact" }, "mailContact": { "type": "string", "description": "Mail contact" }, "languageCode": { "type": "string", "description": "Language Code" }, "paymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-document-DocumentContractDetail": { "description": "Vertragsdetails", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "startDate": { "type": "string", "format": "date", "description": "Vertragsstart (nur Kopf)" }, "endDate": { "type": "string", "format": "date", "description": "Vertragsende (nur Kopf)" }, "runtimeFromDate": { "type": "string", "format": "date", "description": "Laufzeit von" }, "runtimeToDate": { "type": "string", "format": "date", "description": "Laufzeit bis" }, "lastCustomerCancellationDate": { "type": "string", "format": "date", "description": "Letztmöglicher kündigungstermin des Kunden" }, "lastProviderCancellationDate": { "type": "string", "format": "date", "description": "Letztmöglicher kündigungstermin des Anbieters" }, "dueDateCalculation": { "type": "string", "description": "Cron-Ausdruck zur Berechnung der Fälligkeit", "minLength": 1 }, "dueDate": { "type": "string", "format": "date", "description": "Fälligkeit" }, "nextDueDate": { "type": "string", "format": "date", "description": "Nächste Fälligkeit" }, "calculateDirectly": { "type": "boolean", "description": "Direkt abrechnen?" }, "active": { "type": "boolean", "default": true, "description": "Vertrag aktiv?" }, "publishInPortal": { "type": "boolean", "default": false, "description": "Portal anzeigen?" } }, "required": [ "dueDateCalculation" ] }, "erp-document-DocumentFinanceBooking": { "description": "FiBu-Buchung", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "documentLineId": { "type": "integer", "format": "int64", "description": "Id der Dokumentzeile" }, "ledgerNumber": { "type": "string", "description": "FiBu-Kontonummer" }, "transactionKey": { "type": "string", "description": "Buchungsschlüssel" }, "costCenter1": { "type": "string", "description": "Kostenstelle" }, "comment": { "type": "string", "description": "Kommentar" }, "description": { "type": "string", "description": "Buchungstext" } } }, "erp-document-DocumentLine": { "description": "Liste der Belegpositionen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "position": { "type": "integer", "format": "int32", "description": "Positions-Nummer", "readOnly": true }, "positionOfArticleLine": { "type": "integer", "format": "int32", "description": "Positionsnummer über alle Artikelpositionen hinweg", "readOnly": true }, "articleId": { "type": "string", "description": "Artikel" }, "lineType": { "type": "string", "description": "Positionstyp", "enum": [ "ARTICLE_LINE", "ALTERNATIVE_POSITION", "LINK_POSITION", "OPTIONAL_POSITION", "TEXT_LINE", "SHIPPING_COST_LINE", "SUBTOTAL", "POS", "ROUNDING_LINE", "OPEN_ITEM_SETTLEMENT", "ON_ACCOUNT_PAYMENT" ] }, "productType": { "type": "string", "description": "Artikelarten", "enum": [ "WITH_STOCK", "WITHOUT_STOCK", "SERVICE_ARTICLE", "SERVICE_CONTINGENT", "ASSEMBLY_GROUP", "JUMBO", "SHIPPING_COSTS", "VARIANT_MAIN_ARTICLE" ] }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ], "readOnly": true }, "number": { "type": "string", "description": "Artikelnummer", "maxLength": 255, "minLength": 0 }, "name": { "type": "string", "description": "Name des Artikels", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung des Artikels", "maxLength": 2147483647, "minLength": 0 }, "unitType": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "price": { "type": "number", "description": "Preis pro Menge [Brutto, Netto]" }, "priceUnit": { "type": "number", "description": "Preiseinheit" }, "priceOrigin": { "type": "string", "description": "Preisherkunft", "enum": [ "USER_DEFINED", "PRODUCT", "PREDECESSOR_DOCUMENT", "PICKLIST" ], "readOnly": true }, "priceSelectionCriteria": { "$ref": "#/components/schemas/erp-product-PriceSelectionCriteria" }, "quantity": { "type": "number", "description": "Menge" }, "quantityCommitted": { "type": "number", "description": "verarbeitete Menge", "readOnly": true }, "pickingQuantity": { "type": "number", "description": "Menge in Pick-Vorgang", "readOnly": true }, "preOrderPickedQuantity": { "type": "number", "description": "vorgeorderte Menge in Pickvorgang", "readOnly": true }, "complete": { "type": "boolean", "default": false, "description": "ist diese Position komplett verarbeitet?", "readOnly": true }, "taxSchemaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "taxes": { "type": "array", "description": "Steuern", "items": { "$ref": "#/components/schemas/erp-document-DocumentTax" } }, "totalLinePriceModifier": { "type": "number", "description": "Summe Positionspreisänderungen [Brutto, Netto]", "readOnly": true }, "totalDocumentPriceModifier": { "type": "number", "description": "Summe Dokumentpreisänderungen [Brutto, Netto]", "readOnly": true }, "priceModifiers": { "type": "array", "description": "angewendete Preisänderungen", "items": { "$ref": "#/components/schemas/erp-document-DocumentPriceModifier" } }, "salesValueNet": { "type": "number", "description": "Netto-Gesamtpreis (nach Preisänderungen)", "readOnly": true }, "vat": { "type": "number", "description": "Steuerbetrag", "readOnly": true }, "totalLinePrice": { "type": "number", "description": "Positionssumme [Brutto, Netto], also Preis*Menge ./. Positionsrabatte", "readOnly": true }, "texts": { "type": "array", "description": "Positionstexte", "items": { "$ref": "#/components/schemas/erp-document-DocumentText" } }, "shippingCostDetail": { "$ref": "#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail" }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "country": { "$ref": "#/components/schemas/common-masterdata-CountryReference" }, "countryRegion": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customsTariffNumber": { "type": "string", "description": "Zolltarifnummer", "maxLength": 15, "minLength": 0 }, "deliveryDate": { "type": "string", "format": "date", "description": "Lieferdatum" }, "deliveryDateEnd": { "type": "string", "format": "date", "description": "vorr. Ende des Lieferzeitraums (nur notwendig für Lieferzeiträume, wenn Lieferdatum gesetzt)" }, "confirmedDeliveryDate": { "type": "string", "format": "date", "description": "bestätigtes Lieferdatum" }, "confirmedDeliveryDateEnd": { "type": "string", "format": "date", "description": "bestätigtes Ende des Lieferzeitraums (nur notwendig für Lieferrzeiträume, wenn Lieferdatum gesetzt)" }, "shippingDate": { "type": "string", "format": "date", "description": "Versanddatum" }, "deliveryText": { "type": "string", "description": "Liefertext", "maxLength": 255, "minLength": 0 }, "packageOptions": { "type": "string", "description": "Versenderspezifische Informationen" }, "externalReferenceVds": { "type": "string", "description": "Externe Referenz zum VDS-Paket", "maxLength": 255, "minLength": 0 }, "externalArticleNumber": { "type": "string", "description": "Externe Artikelnummer", "maxLength": 255, "minLength": 0, "readOnly": true }, "externalArticleName": { "type": "string", "description": "Externer Artikelname", "maxLength": 255, "minLength": 0, "readOnly": true }, "externalArticleDescription": { "type": "string", "description": "Externe Artikelbeschreibung", "maxLength": 255, "minLength": 0, "readOnly": true }, "netWeight": { "type": "number", "description": "Nettogewicht" }, "totalNetWeight": { "type": "number", "description": "Gesamtnettogewicht" }, "netWeightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "grossWeight": { "type": "number", "description": "Bruttogewicht" }, "totalGrossWeight": { "type": "number", "description": "Gesamtbruttogewicht" }, "grossWeightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "capacity": { "type": "number", "description": "Inhalt der Maßeinheit" }, "capacityUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "baseCapacity": { "type": "number", "description": "Inhalt der Grundeinheit" }, "baseCapacityUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "sourceLineRef": { "$ref": "#/components/schemas/erp-document-DocumentLineRef" }, "baseLineId": { "type": "integer", "format": "int64", "description": "Referenz zur Basiszeile" }, "mainArticleLineRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "settledOpenItemRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "settledOpenItemBalance": { "type": "number", "description": "Offener Restbetrag des auszugleichenden Offenen Postens (nur in der Response)" }, "settledOpenItemPaymentDueDate": { "type": "string", "format": "date", "description": "Fälligkeitsdatum des auszugleichenden Offenen Postens (nur in der Response)" }, "settledOpenItemDiscountAmount": { "type": "number", "description": "Zum Belegdatum anwendbares Skonto des auszugleichenden Offenen Postens (nur in der Response)" }, "settledOpenItemComment": { "type": "string", "description": "Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen" }, "customerOrderLineRef": { "$ref": "#/components/schemas/erp-document-DocumentLineRef" }, "supplierOrderLineIds": { "type": "array", "description": "Referenz zur Lieferantenbestellungszeile", "items": { "type": "integer", "format": "int64", "description": "Referenz zur Lieferantenbestellungszeile" } }, "storage": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "components": { "type": "array", "description": "Komponenten", "items": { "$ref": "#/components/schemas/erp-document-DocumentLineComponent" } }, "fabricationComponents": { "type": "array", "description": "Komponenten", "items": { "$ref": "#/components/schemas/erp-fabrication-DocumentLineFabricationComponent" } }, "bookings": { "type": "array", "description": "Buchungen", "items": { "$ref": "#/components/schemas/erp-document-DocumentLineBooking" } }, "commissions": { "type": "array", "description": "Provisionen", "items": { "$ref": "#/components/schemas/erp-document-DocumentLineCommission" } }, "previousDecisions": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "articleTaxLiabilityReversed": { "type": "boolean", "default": false, "description": "Vorgabe §13b UStG Artikel", "readOnly": true }, "taxLiabilityReversed": { "type": "boolean", "default": false, "description": "wird §13b UStG angewendet?", "readOnly": true }, "presetPrice": { "type": "number", "description": "Vorgabewert für die Preiskalkulation", "readOnly": true }, "calculationData": { "type": "string", "description": "Kalkulationsstruktur" }, "revenueCalculation": { "$ref": "#/components/schemas/erp-document-RevenueCalculation" }, "commissionOrigin": { "type": "string", "description": "Provisionsursprung", "enum": [ "NOT_COMMISSIONABLE", "USER_DEFINED", "AUTOMATIC", "PREDECESSOR", "RECALCULATE" ] }, "cashDiscountable": { "type": "boolean", "default": true, "description": "skontierbare Position?" }, "discountable": { "type": "boolean", "default": true, "description": "rabattierbare Position?" }, "commissionable": { "type": "boolean", "default": false, "description": "provisionierbare Position?" }, "warrantyInMonths": { "type": "integer", "format": "int32", "description": "Garantie in Monaten" }, "contractDetail": { "$ref": "#/components/schemas/erp-document-DocumentContractDetail" }, "posDetail": { "$ref": "#/components/schemas/erp-document-DocumentLinePosDetail" }, "fabricationDetail": { "$ref": "#/components/schemas/erp-fabrication-DocumentLineFabricationDetail" }, "returnDetail": { "$ref": "#/components/schemas/erp-document-DocumentLineReturnDetail" }, "financeBooking": { "$ref": "#/components/schemas/erp-document-DocumentFinanceBooking" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "variantValues": { "type": "array", "description": "Produktvariantenwerte", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true }, "performanceDate": { "type": "string", "format": "date", "description": "Leistungsdatum" }, "basePrice": { "type": "number", "description": "Preis pro Einheit in Basiswährung" }, "baseTotalLinePriceModifier": { "type": "number", "description": "Preisanpassungen - Position Basiswährung" }, "baseTotalDocumentPriceModifier": { "type": "number", "description": "Preisanpassungen - anteilig durch Beleg Basiswährung" }, "baseTotalLinePrice": { "type": "number", "description": "Gesamtpreis Position in Basiswährung" }, "baseSalesValueNet": { "type": "number", "description": "Nettoverkaufswert der Position in Basiswährung" }, "progressInvoice": { "type": "boolean", "default": false, "description": "Abschlagsposition?" }, "dropShippingPolicy": { "type": "string", "description": "Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf", "enum": [ "ANY", "DROP_SHIPPING", "STORAGE", "STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING" ] }, "unitGrossVolumeInCubicMeters": { "type": "number", "description": "unit gross Volume in cubic meters" }, "totalGrossVolumeInCubicMeters": { "type": "number", "description": "unit gross Volume in cubic meters", "readOnly": true }, "convertedIntoBundleArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "insertTerm": { "type": "string", "description": "Zubehör Einfügeart", "enum": [ "MANUAL", "AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED", "AUTOMATIC_PROPORTIONAL_QUANTITY", "AUTOMATIC_FIXED_QUANTITY" ] }, "hasAccessories": { "type": "boolean", "default": false, "description": "Hat der Artikel Zubehör?" }, "recalcLinePriceViaComponents": { "type": "boolean", "default": false, "description": "Soll die DocumentLine über die Komponenten neu berechnet werden?" }, "doPrintLabel": { "type": "boolean", "description": "Soll zu der Position Etiketten gedruckt werden." } }, "required": [ "lineType" ] }, "erp-document-DocumentLineBooking": { "description": "Buchungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "storageBinRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "quantity": { "type": "number", "description": "Gebuchte Menge" }, "serialNumberRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumber1": { "type": "string", "description": "Seriennummer 1", "maxLength": 255, "minLength": 0 }, "serialNumber2": { "type": "string", "description": "Seriennummer 2", "maxLength": 255, "minLength": 0 }, "expiryDate": { "type": "string", "format": "date", "description": "Haltbarkeitsdatum" }, "note": { "type": "string", "description": "Notiz" }, "udi": { "type": "string", "description": "Unique Device Identifier (UDI)" } }, "required": [ "quantity", "storageBinRef" ] }, "erp-document-DocumentLineCommission": { "description": "Provisionen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "salesAgentAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "description": { "type": "string", "description": "Beschreibung" }, "comment": { "type": "string", "description": "Kommentar" }, "valueType": { "type": "string", "description": "Typ von Werten", "enum": [ "PERCENT", "FIX" ] }, "value": { "type": "number", "description": "Provision Prozent/Wert" }, "origin": { "type": "string", "description": "Herkunft", "enum": [ "NOT_COMMISSIONABLE", "USER_DEFINED", "AUTOMATIC", "PREDECESSOR", "RECALCULATE" ] }, "valueCurrencyCode": { "type": "string", "description": "the currency-code IsoAlpha3" } }, "required": [ "origin", "salesAgentAccountRef", "value", "valueType" ] }, "erp-document-DocumentLineComponent": { "description": "Komponenten", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "articleId": { "type": "string", "description": "Referenz auf den Artikel der Komponente" }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ], "readOnly": true }, "quantity": { "type": "number", "description": "Menge" }, "price": { "type": "number", "description": "Einzelpreis" }, "quantityCommitted": { "type": "number", "description": "Gelieferte Menge" }, "pickingQuantity": { "type": "number", "description": "Menge in Kommissionierung" }, "quantityPerAssemblyGroup": { "type": "number", "description": "Menge pro Baugruppe" }, "name": { "type": "string", "description": "Name des Artikels", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung des Artikels", "maxLength": 2048, "minLength": 0 }, "position": { "type": "integer", "format": "int32", "description": "Position der Komponente in der Baugruppe" }, "sourceDocumentLineComponentId": { "type": "integer", "format": "int64", "description": "Referenz auf die Komponente im Quell-Document" }, "bookings": { "type": "array", "description": "Buchungen zu dieser Komponente", "items": { "$ref": "#/components/schemas/erp-document-DocumentLineBooking" } }, "texts": { "type": "array", "description": "Texte zu dieser Komponente", "items": { "$ref": "#/components/schemas/erp-document-DocumentText" } }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "fabricationDetail": { "$ref": "#/components/schemas/erp-fabrication-DocumentLineComponentFabricationDetail" } }, "required": [ "quantity" ] }, "erp-document-DocumentLinePosDetail": { "description": "Kasseninformationen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "posLineType": { "type": "string", "description": "Typ der Position", "enum": [ "CASH_PAYMENT", "CASH_CHANGE", "CARD_PAYMENT", "CASH_START_BALANCE", "CASH_FINAL_BALANCE", "CASH_DEPOSIT", "CASH_EXPENSE", "CASH_WITHDRAWAL" ] }, "depositExpenseTypeId": { "type": "integer", "format": "int64", "description": "Typ der Einlage/Ausgabe" }, "paymentMethodId": { "type": "integer", "format": "int64", "description": "Zahlungsart" }, "externalPaymentId": { "type": "string", "description": "Externe Payment-ID für Verbindung zum Payment-Backend" }, "externalPaymentStatus": { "type": "string", "description": "Status der externen Zahlung", "enum": [ "PENDING", "PROCESSING", "SUCCESSFUL", "CANCELLED", "REJECTED" ] }, "externalPaymentErrorMessage": { "type": "string", "description": "Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)" }, "paymentOperation": { "type": "string", "description": "Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)", "enum": [ "PAYMENT", "CANCEL", "REFUND" ] }, "cancelledExternalPaymentId": { "type": "string", "description": "Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)" }, "withdrawalMode": { "type": "string", "description": "Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss", "enum": [ "FULL", "BALANCE", "MANUAL", "NONE" ], "readOnly": true }, "balanceBeforeWithdrawal": { "type": "number", "description": "Saldo der Zahlungsart vor Abschöpfung", "readOnly": true }, "withdrawalAmount": { "type": "number", "description": "Abschöpfungsbetrag (Modus MANUAL)", "readOnly": true }, "withdrawToBalance": { "type": "number", "description": "Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt", "readOnly": true }, "deletable": { "type": "boolean", "default": false, "description": "Kann diese Zahlungsposition aus dem Beleg entfernt werden? false, solange die Zahlung noch läuft oder bereits erfolgreich ausgeführt wurde", "readOnly": true } } }, "erp-document-DocumentLineRef": { "description": "Referenz auf eine Documentline", "properties": { "id": { "type": "integer", "format": "int64", "description": "Id der Dokumentzeile" }, "documentId": { "type": "integer", "format": "int64", "description": "Id des Dokuments" }, "category": { "type": "string", "description": "Dokumenttypen", "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_PROFORMA_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PROGRESS_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PROGRESS_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_DEPOSIT_INVOICE", "CUSTOMER_DEPOSIT_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "CUSTOMER_RETURN_ANNOUNCEMENT", "CUSTOMER_GOODS_RETURN", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "SUPPLIER_DEPOSIT_INVOICE", "SUPPLIER_PROGRESS_INVOICE", "SUPPLIER_PARTIAL_INVOICE", "SUPPLIER_FINAL_INVOICE", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "SUPPLIER_COMMISSION_CREDIT_NOTE", "SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_RETURN_CASH_RECEIPT", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_WITHDRAWAL", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ] }, "documentType": { "type": "string", "description": "Belegart" }, "documentState": { "type": "string", "description": "Belegstatus" }, "number": { "type": "string", "description": "Belegnummer" }, "articleNumber": { "type": "string", "description": "Artikelnummer" }, "position": { "type": "integer", "format": "int32", "description": "Positions-Nummer" }, "name": { "type": "string", "description": "Artikelbezeichnung", "maxLength": 2147483647, "minLength": 0 }, "quantity": { "type": "number", "description": "quantity" }, "price": { "type": "number", "description": "price per quantity [GROSS, NET]" }, "displayName": { "type": "string", "description": "Kurzbezeichnung des Kunden" } }, "required": [ "id" ] }, "erp-document-DocumentLineReturnDetail": { "description": "Retouren-Details für eine Belegposition", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "returnCategory": { "type": "string", "description": "Retouren-Kategorie", "enum": [ "MONETARY_COMPENSATION_ITEM_STAYS_WITH_CUSTOMER", "MONETARY_COMPENSATION_ITEM_GETS_SEND_BACK", "GOODS_EXCHANGE_ITEM_STAYS_WITH_CUSTOMER", "GOODS_EXCHANGE_ITEM_GETS_SEND_BACK", "UNDECIDED" ] }, "goodsExchangeArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "waitForReturnBeforeExchange": { "type": "boolean", "description": "Auf Retoure warten vor Warenersatz? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)" }, "repairRequested": { "type": "boolean", "description": "Reparatur gewünscht? (nur bei GOODS_EXCHANGE_ITEM_GETS_SEND_BACK)" }, "warrantyExchange": { "type": "boolean", "description": "Garantieaustausch? (nur bei *_ITEM_GETS_SEND_BACK)" }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "replacementDeliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "replacementDeliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "returnCauseRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customerShareOnSurcharge": { "type": "number", "description": "Kundenanteil bei Aufpreis in Prozent (0-100). Wie viel % des Aufpreises zahlt der Kunde?" }, "customerShareOnReduction": { "type": "number", "description": "Kundenanteil bei Minderpreis in Prozent (0-100). Wie viel % der Ersparnis bekommt der Kunde gutgeschrieben?" } } }, "erp-document-DocumentPosDetail": { "description": "Quittungsdetails", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "posRegisterRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "cashDrawerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "cashJournalRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "fiscalizationBackendRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "tssSignature": { "$ref": "#/components/schemas/erp-pos-TssSignature" }, "externalReference": { "type": "string", "description": "Externe Referenz", "readOnly": true }, "timeStart": { "type": "integer", "format": "int64", "description": "Transaktion Startzeit" }, "timeEnd": { "type": "integer", "format": "int64", "description": "Transaktion Endzeit" }, "clientSerialNumber": { "type": "string", "description": "Client Seriennummer" }, "tssSerialNumber": { "type": "string", "description": "TSS Seriennummer" }, "transactionNumber": { "type": "integer", "format": "int64", "description": "Transaktionsnummer" }, "revision": { "type": "integer", "format": "int32", "description": "Revision" }, "signatureCounter": { "type": "integer", "format": "int64", "description": "Signaturzähler" }, "signature": { "type": "string", "description": "Signatur" } } }, "erp-document-DocumentPosPayment": { "description": "Kassen-Zahlung im Beleg", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "amount": { "type": "number", "description": "Betrag" }, "posLineType": { "type": "string", "description": "Typ der Position", "enum": [ "CASH_PAYMENT", "CASH_CHANGE", "CARD_PAYMENT", "CASH_START_BALANCE", "CASH_FINAL_BALANCE", "CASH_DEPOSIT", "CASH_EXPENSE", "CASH_WITHDRAWAL" ] }, "depositExpenseTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "posPaymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "externalPaymentId": { "type": "string", "description": "Externe Payment-ID für Verbindung zum Payment-Backend", "readOnly": true }, "externalPaymentStatus": { "type": "string", "description": "Status der externen Zahlung", "enum": [ "PENDING", "PROCESSING", "SUCCESSFUL", "CANCELLED", "REJECTED" ], "readOnly": true }, "externalPaymentErrorMessage": { "type": "string", "description": "Fehlermeldung vom Payment-Backend (nur bei fehlgeschlagener Zahlung)", "readOnly": true }, "paymentOperation": { "type": "string", "description": "Art der Zahlungsoperation (PAYMENT, CANCEL, REFUND)", "enum": [ "PAYMENT", "CANCEL", "REFUND" ], "readOnly": true }, "cancelledExternalPaymentId": { "type": "string", "description": "Externe Payment-ID der zu stornierenden Zahlung (nur bei CANCEL)", "readOnly": true }, "withdrawalMode": { "type": "string", "description": "Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss", "enum": [ "FULL", "BALANCE", "MANUAL", "NONE" ] }, "balanceBeforeWithdrawal": { "type": "number", "description": "Saldo der Zahlungsart vor Abschöpfung (vom Backend gesetzt)", "readOnly": true }, "withdrawalAmount": { "type": "number", "description": "Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet" }, "withdrawToBalance": { "type": "number", "description": "Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt" }, "deletable": { "type": "boolean", "default": false, "description": "Kann diese Zahlungsposition aus dem Beleg entfernt werden? false, solange die Zahlung noch läuft oder bereits erfolgreich ausgeführt wurde", "readOnly": true } }, "required": [ "amount", "posLineType" ] }, "erp-document-DocumentPriceModifier": { "description": "Preisänderungen (z.B. Rabatte)", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "name": { "type": "string", "description": "Name of modifier" }, "valueType": { "type": "string", "description": "Typ von Werten", "enum": [ "PERCENT", "FIX" ] }, "value": { "type": "number", "description": "Value", "minimum": 0 }, "calculatedValue": { "type": "number", "description": "calculated discount/surcharge" }, "sourceType": { "type": "string", "description": "Source of price modifier", "enum": [ "CUSTOM", "PRODUCT", "DISCOUNT_GROUP", "PREDECESSOR_DOCUMENT" ] }, "sourceId": { "type": "integer", "format": "int64", "description": "ID of Source entity of price modifier" }, "modifierType": { "type": "string", "description": "modifierType", "enum": [ "DISCOUNT", "SURCHARGE" ] }, "baseValue": { "type": "number", "description": "Wert des Modifiers in Basiswährung", "minimum": 0 }, "baseCalculatedValue": { "type": "number", "description": "Berechneter Wert des Modifiers in Basiswährung" } }, "required": [ "modifierType", "value", "valueType" ] }, "erp-document-DocumentShippingCost": { "description": "Versandkosten im Beleg", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "costs": { "type": "number", "description": "Die Versandkosten" }, "manualCosts": { "type": "boolean", "default": false, "description": "Wurden die Versandkosten manuell eingetragen?" }, "freeShipping": { "type": "boolean", "default": false, "description": "Keine Versandkosten (freier Versand)" }, "name": { "type": "string", "description": "Artikelname" }, "description": { "type": "string", "description": "Artikelbeschreibung" }, "texts": { "type": "array", "description": "Texte", "items": { "$ref": "#/components/schemas/erp-document-DocumentText" } }, "taxes": { "type": "array", "description": "Steuern", "items": { "$ref": "#/components/schemas/erp-document-DocumentTax" } }, "purchasePrice": { "type": "number", "description": "Einkaufspreis" }, "discountable": { "type": "boolean", "description": "rabattierbar" }, "cashDiscountable": { "type": "boolean", "description": "skontierbar" } } }, "erp-document-DocumentTax": { "description": "Steuerzusammenfassung für diesen Beleg", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "taxRateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "taxableAmount": { "type": "number", "description": "taxable amount" }, "taxValue": { "type": "number", "description": "tax value" }, "grossAmount": { "type": "number", "description": "gross amount" }, "taxType": { "type": "string", "description": "Steuer-Typ", "enum": [ "VAT" ] }, "taxFree": { "type": "boolean", "default": false, "description": "Steuerfrei?" }, "baseTaxableAmount": { "type": "number", "description": "Besteuerbarer Betrag in Basiswährung" }, "baseTaxValue": { "type": "number", "description": "Steuerbetrag in Basiswährung" }, "baseGrossAmount": { "type": "number", "description": "Bruttobetrag in Basiswährung" } } }, "erp-document-DocumentText": { "description": "Texte", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "textPosition": { "type": "string", "default": "HEADER_TEXT", "description": "position relative to the product line OR Document. For usage within text-line, this position is irrelevant", "enum": [ "HEADER_TEXT", "FOOTER_TEXT" ] }, "content": { "type": "string", "description": "if this attribute is used, the text is used as free-text" }, "textTemplateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "transferableIntoSubsequentDocuments": { "type": "boolean", "default": true, "description": "Does this text remain after transfer into a subsequent document" }, "deleted": { "type": "boolean", "default": false, "description": "Wurde entfernt und soll deshalb nicht mehr angezeigt werden." }, "initialized": { "type": "boolean", "description": "ist der content befüllt?", "readOnly": true } }, "required": [ "deleted" ] }, "erp-document-DocumentTypeState": { "description": "Statusinstanz des Belegs", "properties": { "label": { "type": "string", "description": "label/name of this state", "minLength": 1 }, "key": { "type": "string", "description": "unique key for this state" }, "definition": { "type": "string", "description": "additional state information", "enum": [ "SELECTABLE_TYPES", "EDITABLE", "DELETED" ] } }, "required": [ "key", "label" ] }, "erp-document-DocumentUpdateRequest": { "properties": { "document": { "$ref": "#/components/schemas/erp-document-Document" }, "parameters": { "type": "array", "description": "additional parameters for transition", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } }, "required": [ "document" ] }, "erp-document-PaymentTermRef": { "description": "Refernez auf PaymentTerm mit Kennzeichen Anzahlung/Vorkasse", "properties": { "id": { "type": "string", "description": "Identifier" }, "label": { "type": "string", "description": "a label", "readOnly": true }, "description": { "type": "string", "description": "a short description", "readOnly": true }, "active": { "type": "boolean", "description": "Activ", "readOnly": true }, "paymentType": { "type": "string", "description": "payment type", "enum": [ "PREPAYMENT", "PAYMENT", "DEPOSIT" ] } }, "required": [ "id", "paymentType" ] }, "erp-document-RequestDocumentLineShippingCostDetail": { "description": "Versandkosten-Details; nur gesetzt für Versandkostenpositionen, die als nummerierte Belegposition geführt werden (z.B. Sammelrechnung)", "properties": { "manualCosts": { "type": "boolean", "default": false, "description": "Wurden die Versandkosten manuell eingetragen?" }, "freeShipping": { "type": "boolean", "default": false, "description": "Keine Versandkosten (freier Versand)" }, "purchasePrice": { "type": "number", "description": "Einkaufspreis in Basiswährung" } } }, "erp-document-RevenueCalculation": { "description": "Rohertragsermittlung", "properties": { "productPurchasePrice": { "type": "number", "description": "Einkaufspreis", "readOnly": true }, "salesValue": { "type": "number", "description": "Netto Umsatz", "readOnly": true }, "revenue": { "type": "number", "description": "Deckungsbeitrag (absolut)", "readOnly": true }, "revenueInPercent": { "type": "number", "description": "Deckungsbeitrag (Prozent)", "readOnly": true } } }, "erp-fabrication-DocumentFabricationDetail": { "description": "Produktionsdetails", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "startDate": { "type": "string", "format": "date", "description": "Startdatum" }, "minimumDegreeOfFulfillment": { "type": "integer", "format": "int32", "description": "Minimaler Erfüllungsgrad", "maximum": 100, "minimum": 0 }, "note": { "type": "string", "description": "Notiz", "maxLength": 2147483647, "minLength": 0 }, "componentsStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "workbenchStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "workbenchStorageBinRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "qualityAssuranceStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "qualityAssuranceStorageBinRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defectiveStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defectiveStorageBinRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetStorageBinRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-fabrication-DocumentLineComponentFabricationDetail": { "description": "Produktionsdetails zu einer Komponente", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "serialInheritanceComponent": { "type": "boolean", "default": false, "description": "Für S/N-Vererbung verwenden" }, "deviatingUnitPrice": { "type": "number", "description": "Abweichende Herstellungskosten" }, "sourceBundleArticleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-fabrication-DocumentLineFabricationBookedComponent": { "description": "Gebuchte Komponenten zu einer produzierten Seriennummer", "properties": { "articleId": { "type": "integer", "format": "int64", "description": "ID des Artikels" }, "number": { "type": "string", "description": "Nummer des Artikels" }, "name": { "type": "string", "description": "Name des Artikels" }, "description": { "type": "string", "description": "Beschreibung des Artikels" }, "quantity": { "type": "number", "description": "Verwendete Menge" }, "serialNumberRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-fabrication-DocumentLineFabricationComponent": { "description": "Document-Line-Component eines Produktionsartikels in Kunden-Angeboten und -Aufträgen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "position": { "type": "integer", "format": "int32", "description": "Position" }, "componentArticleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "sourceBundleArticleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "quantity": { "type": "number", "description": "Menge" }, "deviatingUnitRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "deviatingUnitPrice": { "type": "number", "description": "Abweichende Herstellungskosten" }, "forSerialInheritance": { "type": "boolean", "default": false, "description": "Basis für die Vererbung der Seriennummer" }, "name": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "componentArticleRef", "quantity" ] }, "erp-fabrication-DocumentLineFabricationDetail": { "description": "Produktionsdetails zu einer Position", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "serialNumbers": { "type": "array", "description": "Produzierte Seriennummern", "items": { "$ref": "#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber" } }, "quantityCommitted": { "type": "number", "description": "Menge produziert" }, "quantityInQA": { "type": "number", "description": "Menge in QS" }, "quantityDefective": { "type": "number", "description": "Menge defekt" }, "quantityFinished": { "type": "number", "description": "Menge abgeschlossen" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-fabrication-DocumentLineFabricationDetailSerialNumber": { "description": "Produzierte Seriennummern zu einer Position", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "quantity": { "type": "number", "description": "Produzierte/geplante Menge" }, "quantityCommitted": { "type": "number", "description": "Tatsächlich produzierte Menge" }, "quantityInQA": { "type": "number", "description": "Menge in QS" }, "quantityDefective": { "type": "number", "description": "Menge defekt" }, "quantityFinished": { "type": "number", "description": "Menge abgeschlossen" }, "bookedComponents": { "type": "array", "description": "Gebuchte Komponenten", "items": { "$ref": "#/components/schemas/erp-fabrication-DocumentLineFabricationBookedComponent" } } }, "required": [ "quantity", "quantityCommitted", "serialNumber" ] }, "erp-pos-TssSignature": { "description": "TSS Signatur", "properties": { "status": { "type": "string", "description": "Status der Signierung", "enum": [ "FINISHED", "ACTIVE", "CANCELLED", "ERROR" ], "readOnly": true }, "responseData": { "type": "string", "description": "Antwortdaten der TSS", "readOnly": true }, "externalReference": { "type": "string", "description": "Externe Referenz", "readOnly": true }, "revision": { "type": "integer", "format": "int32", "description": "Revision", "readOnly": true } } }, "erp-product-PriceSelectionCriteria": { "description": "Preisermittlungskriterien", "properties": { "qualifier": { "type": "string", "description": "ein qualifier", "enum": [ "SALES", "PURCHASE" ] }, "articleIds": { "type": "array", "description": "Liste von Artikel-IDs", "items": { "type": "integer", "format": "int64", "description": "Liste von Artikel-IDs" } }, "selectOnlyDefaultPrice": { "type": "boolean", "default": false, "description": "soll nur der Standardpreis selektiert werden?" }, "accountIds": { "type": "array", "description": "Liste von Account-IDs", "items": { "type": "integer", "format": "int64", "description": "Liste von Account-IDs" } }, "productGroupId": { "type": "integer", "format": "int64", "description": "Die Warengruppe" }, "priceGroupId": { "type": "integer", "format": "int64", "description": "Die Preisgruppe" }, "date": { "type": "string", "format": "date", "description": "Ein Datum" }, "quantity": { "type": "number", "description": "Eine Menge" }, "noteSpecialOfferPrice": { "type": "boolean", "description": "Aktionspreis beachten?" } } }, "erp-account-AccountLoanValue": { "description": "Aktuell berechnete Werte zum Kreditlimit eines Accounts", "properties": { "accountId": { "type": "integer", "format": "int64", "description": "Account" }, "maximalLoan": { "type": "number", "description": "Kreditlimit" }, "currentLoan": { "type": "number", "description": "Aktueller Kredit" }, "nonInvoicedDocumentLoan": { "type": "number", "description": "Betrag aus Aufträgen" }, "receivableLoan": { "type": "number", "description": "Betrag aus Forderungen" }, "payablesSum": { "type": "number", "description": "Betrag aus Verbindlichkeiten(negativ)" }, "currentDocumentLoan": { "type": "number", "description": "Betrag des momentanen Dokuments" }, "remainingLoan": { "type": "number", "description": "Übriger Betrag bis zum Erreichen des Kreditlimits" }, "exceededLoan": { "type": "number", "description": "Überschrittener Kreditbetrag" }, "unconsideredAmount": { "type": "number", "description": "Nicht berücksichtigter Betrag" } }, "required": [ "accountId" ] }, "erp-document-DocumentResponse": { "properties": { "document": { "$ref": "#/components/schemas/erp-document-Document" }, "hints": { "$ref": "#/components/schemas/erp-document-DocumentValidationHints" }, "viewOptions": { "$ref": "#/components/schemas/erp-document-DocumentViewOptions" } } }, "erp-document-DocumentValidationHints": { "description": "Hinweise", "properties": { "details": { "type": "array", "description": "Hinweise aus der Validierung im Error-Format", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } } } }, "erp-document-DocumentViewOptions": { "description": "Extra-Anzeigen", "properties": { "revenueCalculation": { "$ref": "#/components/schemas/erp-document-RevenueCalculation" }, "loanValue": { "$ref": "#/components/schemas/erp-account-AccountLoanValue" }, "considerForCreditLimit": { "type": "boolean", "description": "Wird dieser Beleg für das Kreditlimit berücksichtigt", "readOnly": true }, "financeJournalAccountingInformation": { "$ref": "#/components/schemas/erp-finance-FinanceJournalAccountingInformation" }, "possiblePredecessorTypes": { "type": "array", "description": "mögliche Vorbeleg-Typen", "items": { "type": "string", "description": "mögliche Vorbeleg-Typen" } }, "sumAmountOfProgressInvoices": { "type": "number", "description": "Gesamtbetrag der Abschlagsrechnungen" }, "sumAmountOfDepositInvoices": { "type": "number", "description": "Gesamtbetrag der Anzahlungsrechnungen" }, "sumAmountOfPartialInvoices": { "type": "number", "description": "Gesamtbetrag der Teilrechnungen" }, "sumAmountOfDeliveryInvoices": { "type": "number", "description": "Gesamtbetrag der Rechnungen und Lieferschein/Rechnungen" }, "depositInvoiceRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "sumOpenAmountForProgressInvoices": { "type": "number", "description": "offener Gesamtbetrag für Abschlagsrechnungen" }, "totalAmountDependingFromBillingType": { "type": "number", "description": "Gesamtbetrag abh. von der Fakturierungsart" }, "orderRefs": { "type": "array", "description": "Referenzen zu den Aufträgen/Bestellungen in der Belegkette", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "readOnly": true }, "picklistRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "autoPrintPaperReceipt": { "type": "boolean", "description": "Papierbelege automatisch drucken (Vorgabe des Verkaufskanals, nur bei Kassenbelegen)", "readOnly": true } } }, "erp-finance-FinanceJournalAccountingInformation": { "description": "Fibu-Informationen", "properties": { "accountingStatus": { "type": "string", "description": "Fibu-Status Dokumenten-Journaleintrag", "enum": [ "PROCESSING", "OPEN", "IGNORED", "COMMITTED", "COMMITTED_REVERTABLE" ], "readOnly": true }, "financeBookingRunRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accountingStatusUpdatedDate": { "type": "string", "format": "date-time", "description": "Fibu-Übergabedatum", "readOnly": true }, "runState": { "type": "string", "description": "Verarbeitungsstatus", "enum": [ "PROCESSING", "OPEN", "COMMITTABLE", "COMMITTED", "REVERTED", "FAILED" ], "readOnly": true } } }, "erp-account-Account": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "types": { "type": "array", "description": "list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ", "items": { "type": "string", "description": "list of types, this account is used for (e.g. CUSTOMER, SUPPLIER, ", "enum": [ "CUSTOMER", "SUPPLIER", "MANUFACTURER", "SERVICE_PROVIDER", "MERCHANT", "SALES_AGENT", "COMPANY", "PROSPECTIVE" ] } }, "number": { "type": "string", "description": "Address-Number" }, "displayName": { "type": "string", "description": "Kurzbezeichnung zur Darstellung", "readOnly": true }, "active": { "type": "boolean", "default": true, "description": "Is account active?", "readOnly": true }, "taxNumber": { "type": "string", "description": "tax number/ Steuernummer", "maxLength": 255, "minLength": 0 }, "remark": { "type": "string", "description": "Sonderbemerkung", "maxLength": 1024, "minLength": 0 }, "note": { "type": "string", "description": "Notiz" }, "companyLegalRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" }, "initialContactTypeRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" }, "address": { "$ref": "#/components/schemas/erp-account-AccountAddress" }, "person": { "$ref": "#/components/schemas/erp-account-AccountPerson" }, "addresses": { "type": "array", "description": "Alle Adressen außer der Standard-Adresse", "items": { "$ref": "#/components/schemas/erp-account-AccountAddress" } }, "persons": { "type": "array", "description": "Ansprechpartner", "items": { "$ref": "#/components/schemas/erp-account-AccountPerson" } }, "customer": { "$ref": "#/components/schemas/erp-account-Customer" }, "supplier": { "$ref": "#/components/schemas/erp-account-Supplier" }, "salesAgent": { "$ref": "#/components/schemas/erp-account-SalesAgent" }, "manufacturer": { "$ref": "#/components/schemas/erp-account-AccountManufacturer" }, "tags": { "type": "array", "description": "List of tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "localCourt": { "type": "string", "description": "Zuständiges Amtsgericht", "maxLength": 255, "minLength": 0 }, "companyRegister": { "type": "string", "description": "Handelsregister-Kennung", "maxLength": 255, "minLength": 0 }, "costCenter": { "type": "string", "description": "Kostenstelle" }, "languageCode": { "type": "string", "description": "Sprache des Accounts" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "reportGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "initialContactAt": { "type": "string", "format": "date", "description": "Erstkontakt am" }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "taxLiabilityReversed": { "type": "boolean", "default": false, "description": "Umkehrung der Steuerschuld nach §13b UStG?" }, "afterPickingTargetDocumentTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "taxIds": { "type": "array", "description": "Eine List von Steuernummern", "items": { "$ref": "#/components/schemas/erp-account-TaxIdForeignCountry" } }, "relations": { "type": "array", "description": "Account-Beziehungen", "items": { "$ref": "#/components/schemas/erp-account-AccountRelation" } }, "dunningBlock": { "type": "boolean", "default": false, "description": "Mahnsperre" }, "payablesSum": { "type": "number", "description": "Summe Verbindlichkeiten", "readOnly": true }, "payablesSumCurrencyCode": { "type": "string", "description": "Währung Summe Verbindlichkeiten IsoAlpha3", "readOnly": true }, "anonymized": { "type": "boolean", "description": "ist der Account anonymisiert?", "readOnly": true }, "receivablesSum": { "type": "number", "description": "Summe Forderungen", "readOnly": true }, "receivablesSumCurrencyCode": { "type": "string", "description": "Währung Summe Forderungen IsoAlpha3", "readOnly": true }, "loanValue": { "$ref": "#/components/schemas/erp-account-AccountLoanValue" }, "loanCurrencyCode": { "type": "string", "description": "Währung Kreditlimit IsoAlpha3", "readOnly": true }, "accountZoneId": { "type": "string", "description": "Zeitzone (bzw. Zeitzonen-Offset) des Accounts", "enum": [ "ACT", "AET", "AGT", "ART", "AST", "BET", "BST", "CAT", "CNT", "CST", "CTT", "EAT", "ECT", "IET", "IST", "JST", "MIT", "NET", "NST", "PLT", "PNT", "PRT", "PST", "SST", "VST", "EST", "MST", "HST" ] }, "calculationMode": { "type": "string", "description": "calculation mode of this document", "enum": [ "HORIZONTAL", "VERTICAL" ] }, "currencyCode": { "type": "string", "description": "currency code IsoAlpha3" }, "hasActiveDuplicates": { "type": "boolean", "default": false, "description": "Has this Account a possible duplicate" }, "businessRelationType": { "type": "string", "description": "Geschäftsbeziehungs-Typen für Geschäftspartner", "enum": [ "B2B", "B2C", "B2G" ] } }, "required": [ "address", "businessRelationType" ] }, "erp-account-AccountAddress": { "description": "Alle Adressen außer der Standard-Adresse", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "salutationRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "titleRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" }, "name1": { "type": "string", "description": "Name1", "maxLength": 255, "minLength": 0 }, "name2": { "type": "string", "description": "Name2", "maxLength": 255, "minLength": 0 }, "name3": { "type": "string", "description": "Name3", "maxLength": 255, "minLength": 0 }, "defaultAddress": { "type": "boolean", "default": false, "description": "is this the default address of the account", "readOnly": true }, "types": { "type": "array", "description": "the kind of usages for this address", "items": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" } }, "street": { "type": "string", "description": "Street", "maxLength": 255, "minLength": 0 }, "globalLocationNumber": { "type": "string", "description": "GLN/ILN as location identifier for this address", "maxLength": 255, "minLength": 0 }, "streetAddressNumber": { "type": "string", "description": "Street address number", "maxLength": 255, "minLength": 0 }, "additionalAddressLine1": { "type": "string", "description": "Additional address line1", "maxLength": 255, "minLength": 0 }, "additionalAddressLine2": { "type": "string", "description": "Additional address line2", "maxLength": 255, "minLength": 0 }, "city": { "type": "string", "description": "City", "maxLength": 255, "minLength": 0 }, "postcode": { "type": "string", "description": "Postcode", "maxLength": 255, "minLength": 0 }, "en16931Profile": { "type": "string", "description": "EN16931 Profil", "enum": [ "ZUGFERD", "XRECHNUNG", "NO_EN_PROFILE" ] }, "taxIdentificationNumber": { "type": "string", "description": "tax identification number/ UST-ID-Nr.", "maxLength": 255, "minLength": 0 }, "taxIdVerificationState": { "type": "string", "description": "Überprüfungsstatus der Steueridentifikationsnummer", "enum": [ "NOT_YET_VERIFIED", "VALID", "VALID_WITH_INVALID_ADDRESS", "INVALID", "NOT_NEEDED" ], "readOnly": true }, "homepageUrl": { "type": "string", "description": "Homepage URL" }, "regionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "countryCode": { "type": "string", "description": "Country code" }, "longitude": { "type": "number", "format": "double", "description": "Longitude" }, "latitude": { "type": "number", "format": "double", "description": "latitude" }, "remark": { "type": "string", "description": "Sonderbemerkung", "maxLength": 1024, "minLength": 0 }, "postOfficeBox": { "type": "string", "description": "Post office box", "maxLength": 255, "minLength": 0 }, "buyerReference": { "type": "string", "description": "Leitweg-ID", "maxLength": 255, "minLength": 0 }, "eoriNumber": { "type": "string", "description": "EORI-Nummer", "maxLength": 255, "minLength": 0 }, "contacts": { "type": "array", "description": "Contacts", "items": { "$ref": "#/components/schemas/erp-account-Contact" } }, "defaultContacts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/erp-account-Contact" }, "description": "Default contacts", "readOnly": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "calculationMode": { "type": "string", "description": "calculation mode of this address", "enum": [ "HORIZONTAL", "VERTICAL" ] }, "deviatingPaymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deviatingPaymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deviatingDeliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deviatingDeliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "languageCode": { "type": "string", "description": "Sprache der Adresse" }, "manufacturerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defaultForType": { "type": "boolean", "default": false, "description": "Standard für den Account-Typ" } }, "required": [ "name1" ] }, "erp-account-AccountManufacturer": { "description": "Manufacturer of this account", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "active true/false", "readOnly": true }, "labels": { "type": "array", "description": "Beschreibungen", "items": { "$ref": "#/components/schemas/erp-account-AccountManufacturerDescription" }, "minItems": 1 }, "forcedRecommendedRetailPrice": { "type": "boolean", "default": false, "description": "Ist der UVP verpflichtend?" } }, "required": [ "labels" ] }, "erp-account-AccountManufacturerDescription": { "description": "Beschreibungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "languageCode": { "type": "string", "description": "Sprache der Beschreibung", "minLength": 1 }, "manufacturerUrl": { "type": "string", "description": "Hersteller-URL" } }, "required": [ "label", "languageCode" ] }, "erp-account-AccountPerson": { "description": "Ansprechpartner", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Label", "maxLength": 255, "minLength": 0 }, "tags": { "type": "array", "description": "List of tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "comment": { "type": "string", "description": "Comment" }, "salutationRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "titleRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" }, "firstName": { "type": "string", "description": "First name", "maxLength": 255, "minLength": 0 }, "middleName": { "type": "string", "description": "Middle name", "maxLength": 255, "minLength": 0 }, "lastName": { "type": "string", "description": "Lastname", "maxLength": 255, "minLength": 0 }, "gender": { "type": "string", "description": "Gender", "enum": [ "MALE", "FEMALE", "ETC" ] }, "locale": { "type": "string", "description": "Locale", "maxLength": 255, "minLength": 0 }, "jobArea": { "type": "string", "description": "Job area", "maxLength": 255, "minLength": 0 }, "jobTypeRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" }, "dateOfBirth": { "type": "string", "format": "date", "description": "Date of birth" }, "sortOrder": { "type": "integer", "format": "int64", "description": "sortierreihenfolge" }, "remark": { "type": "string", "description": "Sonderbemerkung", "maxLength": 1024, "minLength": 0 }, "contacts": { "type": "array", "description": "List of contacts", "items": { "$ref": "#/components/schemas/erp-account-Contact" } }, "defaultContacts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/erp-account-Contact" }, "description": "Default contacts", "readOnly": true }, "initialContactTypeRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" }, "initialContactAt": { "type": "string", "format": "date", "description": "Erstkontakt am" }, "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "defaultPerson": { "type": "boolean", "default": false, "description": "Standard-Ansprechpartner", "readOnly": true } }, "required": [ "lastName" ] }, "erp-account-AccountRelation": { "description": "Account-Beziehungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "relatedAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "comment": { "type": "string", "description": "Comment" }, "relationTypeRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" } }, "required": [ "relatedAccountRef", "relationTypeRef" ] }, "erp-account-Contact": { "description": "List of contacts", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "value": { "type": "string", "description": "A Value", "maxLength": 255, "minLength": 0 }, "typeId": { "type": "string", "description": "Type identifier" }, "type": { "type": "string", "description": "Contact type", "enum": [ "PHONE", "SOCIAL", "EMAIL", "FAX", "SKYPE", "MS_TEAMS", "CUSTOM", "MOBILE" ] }, "label": { "type": "string", "description": "Contact label", "maxLength": 255, "minLength": 0 }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "default": { "type": "boolean", "default": false, "description": "Is default contact?" } }, "required": [ "value" ] }, "erp-account-Customer": { "description": "Customer of this account", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "number": { "type": "string", "description": "number of customer", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "active true/false", "readOnly": true }, "accountingNumber": { "type": "string", "description": "finance account-number of customer", "maxLength": 255, "minLength": 0 }, "taxable": { "type": "boolean", "default": true, "description": "tax able or tax free" }, "deliveryBlocked": { "type": "boolean", "default": false, "description": "Hat der Kunde eine Liefersperre?" }, "billingType": { "type": "string", "description": "presetting of billing type", "enum": [ "GROSS", "NET" ] }, "paymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customerGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "productPriceGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "stackProcessingType": { "type": "string", "description": "Stapelverarbeitungsinformationen für Aufträge", "enum": [ "ACCORDING_TO_CRITERIA", "ONLY_FULL_ORDER", "ONLY_FULL_ORDER_LINES", "AVAILABLE_QUANTITIES", "NO_PROCESSING", "FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES", "AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES", "FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES", "AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES", "AVAILABLE_QUANTITIES_FINISH_ORDER" ] }, "stackProcessingPriority": { "type": "integer", "format": "int32", "description": "Priorität für die Stapelverarbeitung" }, "maxDeliveries": { "type": "integer", "format": "int32", "description": "Maximal mögliche Lieferungen" }, "ourNumber": { "type": "string", "description": "customers number for us" }, "maximalLoan": { "type": "number", "description": "Kreditlimit", "minimum": 0 }, "performanceCountryCode": { "type": "string", "description": "country code performance country IsoAlpha3" }, "currencyCode": { "type": "string", "description": "currency code IsoAlpha3" }, "collectiveBillable": { "type": "boolean", "default": false, "description": "collective billable" }, "collectiveInvoiceManually": { "type": "boolean", "default": true, "description": "Sammelabrechnung nur manuell auslösen?" }, "dueDateCalculation": { "type": "string", "description": "Cron-Ausdruck zur Berechnung der Sammelabrechnung" }, "dueDate": { "type": "string", "format": "date", "description": "Fälligkeit der nächsten Sammelabrechnung" }, "nextDueDate": { "type": "string", "format": "date", "description": "Nächste Fälligkeit nach der aktuellen" } } }, "erp-account-SalesAgent": { "description": "Sales Agent of this account", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "active true/false", "readOnly": true }, "number": { "type": "string", "description": "number of sales agent", "maxLength": 255, "minLength": 0 }, "commissionType": { "type": "string", "description": "commission type of sales agent", "enum": [ "INVOICE", "ORDER", "PAYMENT" ] }, "paymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "taxRateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "taxable": { "type": "boolean", "description": "is sales agent taxable" }, "accountingNumber": { "type": "string", "description": "accounting number" }, "billingType": { "type": "string", "description": "billing type", "enum": [ "GROSS", "NET" ] }, "performanceCountryCode": { "type": "string", "description": "country code performance country IsoAlpha3" }, "note": { "type": "string", "description": "Bemerkung" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "currencyCode": { "type": "string", "description": "currency code IsoAlpha3" }, "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "required": [ "billingType", "commissionType", "deliveryMethodRef", "deliveryTermRef", "paymentMethodRef", "paymentTermRef", "taxRateRef", "taxable" ] }, "erp-account-Supplier": { "description": "Supplier of this account", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "accountingNumber": { "type": "string", "description": "finance account-number of supplier", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "active true/false", "readOnly": true }, "dunning": { "type": "boolean", "default": false, "description": "Mahnen?" }, "number": { "type": "string", "description": "number of supplier", "maxLength": 255, "minLength": 0 }, "ourNumber": { "type": "string", "description": "suppliers number for us", "maxLength": 255, "minLength": 0 }, "billingType": { "type": "string", "description": "Fakturisierungsart Netto oder Brutto", "enum": [ "GROSS", "NET" ] }, "paymentTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryTermRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "orderBlocked": { "type": "boolean", "default": false, "description": "Bestellsperre" }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defaultDeliveryTime": { "type": "integer", "format": "int32", "description": "Lieferzeit in (Werk-)Tagen" }, "performanceCountryCode": { "type": "string", "description": "country code performance country IsoAlpha3" }, "taxable": { "type": "boolean", "default": true, "description": "tax able or tax free" }, "currencyCode": { "type": "string", "description": "currency code IsoAlpha3" }, "permissibleForOrderProposal": { "type": "boolean", "default": true, "description": "zulässig für Aufnahme in Bestellvorschläge" }, "minimumOrderValue": { "type": "number", "description": "Mindestbestellwert" }, "freeShippingValue": { "type": "number", "description": "Frachtkostenfrei ab" }, "supplierGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "createCustomerDeliveryWhenDropShipping": { "type": "boolean", "default": false, "description": "Erzeugung Ausgangs-Lieferschein bei Streckengeschäft-Bestellung" }, "dropShippingAllowed": { "type": "boolean", "default": false, "description": "Kennzeichen, ob Streckengeschäft erlaubt" } } }, "erp-account-TaxIdForeignCountry": { "description": "Eine List von Steuernummern", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "taxId": { "type": "string", "description": "Tax ID of the company in the associated country" }, "countryCode": { "type": "string", "description": "ISO 2 Code of the country this tax ID is used for" } } }, "erp-document-DocumentStateTransitionRequest": { "properties": { "transitionId": { "type": "string", "description": "transition id" }, "parameters": { "type": "array", "description": "additional parameters for transition", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } }, "document": { "$ref": "#/components/schemas/erp-document-RequestDocument" } }, "required": [ "transitionId" ] }, "erp-document-DocumentType": { "description": "target document type for document copy", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "labels": { "type": "array", "description": "label/name of this type", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeLabel" } }, "category": { "type": "string", "description": "Dokumenttypen", "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_PROFORMA_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PROGRESS_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PROGRESS_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_DEPOSIT_INVOICE", "CUSTOMER_DEPOSIT_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "CUSTOMER_RETURN_ANNOUNCEMENT", "CUSTOMER_GOODS_RETURN", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "SUPPLIER_DEPOSIT_INVOICE", "SUPPLIER_PROGRESS_INVOICE", "SUPPLIER_PARTIAL_INVOICE", "SUPPLIER_FINAL_INVOICE", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "SUPPLIER_COMMISSION_CREDIT_NOTE", "SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_RETURN_CASH_RECEIPT", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_WITHDRAWAL", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ] }, "showForManualDocumentCreation": { "type": "boolean", "default": true, "description": "Darf dieser Typ zur Neuanlage von Belegen verwendet werden?" }, "nextNumber": { "type": "string", "description": "nächste Belegnummer", "maxLength": 255, "minLength": 0, "readOnly": true }, "followUpDocumentTypes": { "type": "array", "description": "follow up document types", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeFollowUp" }, "readOnly": true }, "defaultTypeOfCategory": { "type": "boolean", "default": false, "description": "ist diese Belegart die Standard-Belegart für ihre Kategorie?" }, "active": { "type": "boolean", "default": true, "description": "ist diese Belegart aktiv" }, "shelfDocumentTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "sequencerConfiguration": { "$ref": "#/components/schemas/common-sequencer-SequencerConfiguration" }, "requiresBusinessRelationship": { "type": "boolean", "default": true, "description": "Geschäftsbeziehung verpflichtend" }, "publishingPolicy": { "type": "string", "default": "AUTOMATIC", "description": "Verhalten zugeordnetem DMS-Dokument", "enum": [ "AUTOMATIC", "MANUAL" ] }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierung" } }, "required": [ "category" ] }, "erp-document-DocumentTypeFollowUp": { "description": "follow up document types", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "sourceDocumentTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetDocumentTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "active": { "type": "boolean", "default": true, "description": "ist diese Folge-Belegart aktiv", "readOnly": true } }, "required": [ "sourceDocumentTypeRef", "targetDocumentTypeRef" ] }, "erp-document-DocumentTypeLabel": { "description": "label/name of this type", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "languageCode": { "type": "string", "description": "Language code" }, "label": { "type": "string", "description": "label/name of this type (for display)", "minLength": 1 }, "labelPrintout": { "type": "string", "description": "label/name of this type (for printout)", "minLength": 1 } }, "required": [ "label", "labelPrintout", "languageCode" ] }, "erp-document-RequestDocument": { "description": "Details zum zu erstellenden oder zu bearbeitenden Beleg", "properties": { "accountId": { "type": "string", "description": "account-id to create a new Document" }, "salesChannelId": { "type": "string", "description": "sales-channel-id to create a new Document" }, "externalId": { "type": "string", "description": "reference to the corresponding document in an external system" }, "externalNumber": { "type": "string", "description": "externe Belegnummer" }, "billingType": { "type": "string", "description": "billing type", "enum": [ "GROSS", "NET" ] }, "calculationMode": { "type": "string", "description": "calculation mode", "enum": [ "HORIZONTAL", "VERTICAL" ] }, "documentDate": { "type": "string", "format": "date", "description": "Belegdatum" }, "performanceDate": { "type": "string", "format": "date", "description": "Leistungsdatum" }, "supplierAccountId": { "type": "integer", "format": "int64", "description": "Vorgabelieferant bei Übernahme von Auftrag zu Bestellung(en)" }, "lines": { "type": "array", "description": "Dokumentzeilen", "items": { "$ref": "#/components/schemas/erp-document-RequestDocumentLine" } }, "targetDocumentType": { "$ref": "#/components/schemas/erp-document-DocumentType" }, "incomingGoodsPickTrolleyId": { "type": "integer", "format": "int64", "description": "ID vom Pickwagen für den Wareneingang (wenn incomingGoodsStorageBinId = null)" }, "incomingGoodsStorageBinId": { "type": "integer", "format": "int64", "description": "ID vom Lagerplatz für den Wareneingang (wenn incomingGoodsPickTrolleyId = null)" }, "priceModifiers": { "type": "array", "description": "Die Rabatte des Beleges", "items": { "$ref": "#/components/schemas/erp-document-RequestDocumentPriceModifier" } }, "posRegisterId": { "type": "integer", "format": "int64", "description": "ID der Kasse (bei POS)" }, "cashDrawerId": { "type": "integer", "format": "int64", "description": "ID der Kassenschublade (bei POS)" }, "depositPaymentAmount": { "type": "number", "description": "Der Anzahlungsbetrag" }, "contractDetail": { "$ref": "#/components/schemas/erp-document-DocumentContractDetail" }, "posDetail": { "$ref": "#/components/schemas/erp-document-DocumentPosDetail" }, "posPayments": { "type": "array", "description": "Eine oder mehr Kassenzahlungen", "items": { "$ref": "#/components/schemas/erp-document-DocumentPosPayment" } }, "texts": { "type": "array", "description": "Kopf-/Fußtexte des Belegs", "items": { "$ref": "#/components/schemas/erp-document-DocumentText" } }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "einvoice": { "type": "boolean" } } }, "erp-document-RequestDocumentLine": { "description": "Details zum zu erstellenden oder zu bearbeitenden Beleg", "properties": { "name": { "type": "string", "description": "Artikelname" }, "positionOfArticleLine": { "type": "integer", "format": "int32", "description": "Positionsnummer der Artikel" }, "description": { "type": "string", "description": "Artikelbeschreibung" }, "lineId": { "type": "string", "description": "ID der Belegposition im aktuellen Beleg" }, "sourceLineId": { "type": "string", "description": "ID der Quell-Belegposition" }, "refLineId": { "type": "string", "description": "(optional) ID der referenzierten Belegposition" }, "articleId": { "type": "string", "description": "(optional) ID des Artikels dieser Position" }, "externalId": { "type": "string", "description": "Referenz auf die zugehörige Position in einem externen System" }, "productPrice": { "type": "number", "description": "(optional) Preis des Artikels dieser Position" }, "totalLinePrice": { "type": "number", "description": "(optional) Gesamtpreis dieser Position" }, "priceModifiers": { "type": "array", "description": "(optional) Liste von Preismodifikatoren für diese Position", "items": { "$ref": "#/components/schemas/erp-document-RequestDocumentPriceModifier" } }, "texts": { "type": "array", "description": "(optional) Liste von Texten für diese Position", "items": { "$ref": "#/components/schemas/erp-document-RequestDocumentText" } }, "quantity": { "type": "number", "description": "Menge, die in dieser Transaktion verarbeitet werden soll" }, "storageId": { "type": "string", "description": "(optional) Lager-ID" }, "markCompleted": { "type": "boolean", "default": false, "description": "Soll die Quellposition nach erfolgreicher Verarbeitung als abgeschlossen markiert werden?" }, "supplierAccountId": { "type": "integer", "format": "int64", "description": "Wird für die Umwandlung von Kundenauftrag in Lieferantenauftrag benötigt" }, "bookings": { "type": "array", "description": "Buchungen zu dieser Belegposition", "items": { "$ref": "#/components/schemas/erp-document-RequestDocumentLineBooking" } }, "commissions": { "type": "array", "description": "Provisionen zu dieser Belegposition", "items": { "$ref": "#/components/schemas/erp-document-RequestDocumentLineCommission" } }, "commissionOrigin": { "type": "string", "description": "Provisionsherkunft dieser Belegposition", "enum": [ "NOT_COMMISSIONABLE", "USER_DEFINED", "AUTOMATIC", "PREDECESSOR", "RECALCULATE" ] }, "lineType": { "type": "string", "description": "Typ dieser Position", "enum": [ "ARTICLE_LINE", "ALTERNATIVE_POSITION", "LINK_POSITION", "OPTIONAL_POSITION", "TEXT_LINE", "SHIPPING_COST_LINE", "SUBTOTAL", "POS", "ROUNDING_LINE", "OPEN_ITEM_SETTLEMENT", "ON_ACCOUNT_PAYMENT" ] }, "settledOpenItemId": { "type": "string", "description": "ID des auszugleichenden Offenen Postens (nur bei OPEN_ITEM_SETTLEMENT)" }, "settledOpenItemComment": { "type": "string", "description": "Bemerkung zur OP-Position - wird beim Abschluss in den Kommentar des Offenen Postens übernommen" }, "financeBooking": { "$ref": "#/components/schemas/erp-document-DocumentFinanceBooking" }, "contractDetail": { "$ref": "#/components/schemas/erp-document-DocumentContractDetail" }, "posDetail": { "$ref": "#/components/schemas/erp-document-DocumentLinePosDetail" }, "returnDetail": { "$ref": "#/components/schemas/erp-document-DocumentLineReturnDetail" }, "incomingGoodsPickTrolleyId": { "type": "integer", "format": "int64", "description": "ID des Pickwagens für den Wareneingang (wenn `incomingGoodsStorageBinId` = null)" }, "incomingGoodsStorageBinId": { "type": "integer", "format": "int64", "description": "ID des Lagerplatzes für den Wareneingang (wenn `incomingGoodsPickTrolleyId` = null)" }, "dropShippingPolicy": { "type": "string", "description": "Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf", "enum": [ "ANY", "DROP_SHIPPING", "STORAGE", "STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING" ] }, "shippingCostDetail": { "$ref": "#/components/schemas/erp-document-RequestDocumentLineShippingCostDetail" }, "fabricationDetail": { "$ref": "#/components/schemas/erp-document-RequestDocumentLineFabricationDetail" }, "doLabelPrint": { "type": "boolean", "default": false, "description": "Zu der Zeile Etikettendruck anstoßen" } } }, "erp-document-RequestDocumentLineBooking": { "description": "Buchungen zu dieser Belegposition", "properties": { "sourceComponentId": { "type": "integer", "format": "int64", "description": "ID der bebuchten Quell-DocumentLineComponent" }, "quantity": { "type": "number", "description": "Gebuchte Menge" }, "storageBinId": { "type": "integer", "format": "int64", "description": "ID vom bebuchten Lagerplatz" }, "serialNumberId": { "type": "integer", "format": "int64", "description": "Ggf. ID einer zu buchenden Seriennummer" } }, "required": [ "quantity", "sourceComponentId", "storageBinId" ] }, "erp-document-RequestDocumentLineCommission": { "description": "Provisionen zu dieser Belegposition", "properties": { "salesAgentAccountRef": { "$ref": "#/components/schemas/erp-account-Account" }, "description": { "type": "string", "description": "Beschreibung" }, "comment": { "type": "string", "description": "Kommentar" }, "valueType": { "type": "string", "description": "Typ von Werten", "enum": [ "PERCENT", "FIX" ] }, "value": { "type": "number", "description": "Provision Prozent/Wert" }, "origin": { "type": "string", "description": "Herkunft", "enum": [ "NOT_COMMISSIONABLE", "USER_DEFINED", "AUTOMATIC", "PREDECESSOR", "RECALCULATE" ] } }, "required": [ "origin", "salesAgentAccountRef", "value", "valueType" ] }, "erp-document-RequestDocumentLineFabricationDetail": { "description": "Details zur verarbeiteten Produktionsbelegposition", "properties": { "fabricationSerialNumbers": { "type": "array", "description": "Nur füllen, wenn die Seriennummern vor der Start der Produktion manuell bestimmt werden sollen", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationSerialNumber" } } } }, "erp-document-RequestDocumentPriceModifier": { "description": "Die Rabatte des Beleges", "properties": { "modifierValue": { "type": "number", "description": "modifierValue of this line", "minimum": 0 }, "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", "PREDECESSOR_DOCUMENT" ] } }, "required": [ "modifierType", "modifierValue", "valueType" ] }, "erp-document-RequestDocumentText": { "description": "(optional) Liste von Texten für diese Position", "properties": { "textPosition": { "type": "string", "description": "header or footer text", "enum": [ "HEADER_TEXT", "FOOTER_TEXT" ] }, "content": { "type": "string", "description": "text content" } } }, "erp-fabrication-FabricationSerialNumber": { "description": "Zu produzierende Seriennummer", "properties": { "quantity": { "type": "number", "description": "Abweichende Menge für Chargen" }, "serialNumberId": { "type": "integer", "format": "int64", "description": "ID der zu produzierenden Seriennummer (nur zur gezielten Produktion von bereits definierten Seriennummern)" }, "serialNumber1": { "type": "string", "description": "Seriennummer 1" }, "serialNumber2": { "type": "string", "description": "Seriennummer 2" }, "expiryDate": { "type": "string", "format": "date", "description": "MHD / Verfallsdatum" }, "note": { "type": "string", "description": "Bemerkung" } } }, "erp-document-CreateOrUpdateManualDocumentProtocolRequest": { "description": "Request zur Anlage eines manuellen Eintrags ins Belegprotokoll", "properties": { "customMessage": { "type": "string", "description": "Text für das Belegprotokoll", "minLength": 1 } }, "required": [ "customMessage" ] }, "erp-document-DocumentProtocol": { "description": "Belegprotokoll", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "documentTypeId": { "type": "integer", "format": "int64", "description": "Typ des Dokuments zu diesem Protokolleintrag", "readOnly": true }, "documentTypeLabels": { "type": "array", "description": "Label vom Typ des Dokuments zu diesem Protokolleintrag", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeLabel" }, "readOnly": true }, "documentNumber": { "type": "string", "description": "Nummer des Dokuments zu diesem Protokolleintrag", "readOnly": true }, "type": { "type": "string", "description": "Eintragsarten im DocumentProtocol", "enum": [ "MANUAL", "CREATED", "SAVED", "BEGIN_EDITING", "CANCEL_EDITING", "PUBLISHED", "FROZEN", "NEW_VERSION_STARTED", "TRANSFERRED_TO_DELIVERY", "TRANSFERRED_FROM_OTHER", "TRANSFERRED_TO_OTHER", "TRANSFER_CANCELLED", "DELETED", "IN_PICKING", "RESET_FROM_PICKING", "COPIED", "ELECTRONIC_INVOICE_VALIDATED", "FINANCE_BOOKING", "CANCELLED", "DISSOLVED", "DOCUMENT_STATE_MANUALLY_CHANGED", "DOCUMENT_MAINTAINED", "COMPLETED_WITH_UNDER_DELIVERY", "ORDER_REOPENED", "REVERT_AFTER_WORKFLOW_FAILURE", "ORDER_DELIVERY_APPROVED", "ORDER_DELIVERY_UNAPPROVED", "DOCUMENT_PRINTED", "MANUAL_DUE_DATE_CHANGE", "MANUAL_NEXT_DUE_DATE_CHANGE", "DROP_SHIPPING_DELIVERY_APPROVED_FOR_INVOICE_DUE_TO_SUPPLIER_DELIVERY", "DROP_SHIPPING_DELIVERY_UNAPPROVED_FOR_INVOICE_DUE_TO_DELETION_SUPPLIER_DELIVERY", "FABRICATION_STARTED", "FABRICATION_CANCELLED", "FABRICATION_PAUSED", "FABRICATION_RESUMED", "FABRICATION_COMPLETED", "FABRICATION_RESTARTED", "FABRICATION_STARTED_QA", "FABRICATION_CANCELLED_QA", "FABRICATION_FINISHED_QA", "FABRICATION_FINISHED" ] }, "customMessage": { "type": "string", "description": "Text dieses Protokolleintrags" }, "localizeableMessage": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "userName": { "type": "string", "description": "Benutzer von dem der Eintrag angelegt wurde", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time", "description": "Zeitstempel dieses Protokolleintrags" } }, "required": [ "type" ] }, "core-unknownmodule-LeasableLock": { "properties": { "key": { "type": "string", "minLength": 1 }, "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", "example": "1", "readOnly": true } }, "required": [ "key", "token" ] }, "erp-document-DocumentParcel": { "description": "Pakete zu Belegen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "documentRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "position": { "type": "integer", "format": "int32", "description": "Position des Pakets" }, "weight": { "type": "number", "description": "Gewicht des Pakets" }, "weightUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "length": { "type": "number", "description": "Länge" }, "width": { "type": "number", "description": "Breite" }, "height": { "type": "number", "description": "Höhe" }, "sizeUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "trackingNumber": { "type": "string", "description": "Trackingnummer", "readOnly": true }, "lines": { "type": "array", "description": "Inhalt des Pakets", "items": { "$ref": "#/components/schemas/erp-document-DocumentParcelLine" } } }, "required": [ "documentRef" ] }, "erp-document-DocumentParcelLine": { "description": "Inhalt der Pakete zu Belegen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "documentLineId": { "type": "integer", "format": "int64", "description": "Referenz zur Belegposition" }, "documentLineBookingId": { "type": "integer", "format": "int64", "description": "Referenz zur Belegpositionsbuchung" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "quantity": { "type": "number", "description": "Menge" } } }, "erp-document-DocumentPartialUpdateRequest": { "properties": { "documentLine": { "$ref": "#/components/schemas/erp-document-DocumentLine" }, "additionalParameters": { "type": "array", "description": "Zusätzliche Parameter und Benutzerentscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-document-ContractDueDates": { "description": "Zu ändernde Fälligkeiten in einem Vertrag", "properties": { "dueDate": { "type": "string", "format": "date", "description": "Aktuelle Fälligkeit" }, "nextDueDate": { "type": "string", "format": "date", "description": "Nächste Fälligkeit" } }, "required": [ "dueDate" ] }, "erp-document-DocumentTypeChain": { "description": "Verwaltung zur Pflege der Belegketten", "properties": { "version": { "type": "string", "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", "format": "int64", "description": "Vorgänger-DocumentType" }, "successorId": { "type": "integer", "format": "int64", "description": "Nachfolger-DocumentType" } }, "required": [ "predecessorId", "successorId" ] }, "erp-delivery-DeliveryTerm": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "description", "minLength": 1 }, "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", "default": false, "description": "calculate shipping charges per parcel" }, "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", "default": true, "description": "Aktiv?" }, "translations": { "type": "array", "description": "translations", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeTerm" } } }, "required": [ "calculateFreightChargesFromType", "calculateFreightChargesWithType", "description", "label", "shippingCostArticleRef" ] }, "erp-delivery-ShippingCost": { "description": "Versandkosten mit Bedingungen", "properties": { "version": { "type": "string", "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ändercode" }, "fromPostcode": { "type": "string", "description": "Postleitzahl von" }, "toPostcode": { "type": "string", "description": "Postleitzahl bis" }, "fromParcelCount": { "type": "integer", "format": "int32", "description": "Ab Anzahl Pakete" }, "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", "default": false, "description": "Einkaufspreis?" }, "currencyCode": { "type": "string", "description": "Währung (ISO-A3)" } }, "required": [ "currencyCode", "netPrice" ] }, "erp-crm-CrmSubType": { "description": "Spezialisierter Typ einer CRM-Objekt-Implementierung", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierreihenfolge" }, "active": { "type": "boolean", "description": "aktiv", "readOnly": true } }, "required": [ "label", "sortOrder" ] }, "erp-crm-CrmState": { "description": "Status eines CRM-Objekts", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "crmSubTypes": { "type": "array", "description": "Typ zu dem dieser Status gehört", "items": { "$ref": "#/components/schemas/erp-crm-CrmSubType" }, "minItems": 1 }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierreihenfolge" }, "startState": { "type": "boolean", "default": false, "description": "Handelt es sich um einen Anfang-Status" }, "finishState": { "type": "boolean", "default": false, "description": "Handelt es sich um einen End-Status" }, "readyToBill": { "type": "boolean", "default": false, "description": "Handelt es sich um einen \"Bereit zur Abrechnung\"-Status" }, "needsCommentOnPositiveFinish": { "type": "boolean", "default": false, "description": "Kommentar bei positivem Abschluß erforderlich" }, "needsCommentOnNegativeFinish": { "type": "boolean", "default": false, "description": "Kommentar bei negativem Abschluß erforderlich" }, "active": { "type": "boolean", "description": "active", "readOnly": true }, "portalEnumRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" } }, "required": [ "crmSubTypes", "label", "sortOrder" ] }, "erp-crm-CrmPriority": { "description": "Priorität eines CRM-Objekts", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "crmPriorityType": { "type": "string", "description": "Priorität", "enum": [ "CRITICAL", "NORMAL", "LOW" ] }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierreihenfolge" }, "portalEnumRef": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" } }, "required": [ "crmPriorityType", "sortOrder" ] }, "erp-crm-CrmProjectPhase": { "description": "CRM Projekt-Phasen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung" }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierreihenfolge" }, "active": { "type": "boolean", "description": "aktiv", "readOnly": true } }, "required": [ "label" ] }, "erp-crm-CrmDealVisibility": { "description": "Sichtbarkeit von CRM-Deals", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "dealUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readPermittedUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-crm-CrmDealTopic": { "description": "Thema von CRM-Deals", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierreihenfolge" }, "active": { "type": "boolean", "description": "aktiv", "readOnly": true } }, "required": [ "label" ] }, "erp-crm-CrmDealHealth": { "description": "Gesundheitsstatus von CRM-Deals", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierreihenfolge" }, "active": { "type": "boolean", "description": "aktiv", "readOnly": true } }, "required": [ "label" ] }, "erp-crm-CrmDealClosingReason": { "description": "Abschlussgrund von CRM-Deals", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "closingType": { "type": "string", "description": "Art des Abschluß eines Deals", "enum": [ "POSITIVE", "NEGATIVE" ] }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierreihenfolge" }, "active": { "type": "boolean", "description": "aktiv", "readOnly": true } }, "required": [ "label" ] }, "erp-crm-CrmActivity": { "description": "CRM Aktivitäten", "properties": { "version": { "type": "string", "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ät?", "readOnly": true }, "comment": { "type": "string", "description": "Inhalt dieser Aktivität" }, "notes": { "type": "string", "description": "Notizen" }, "startDateTime": { "type": "string", "format": "date-time", "description": "tatsächliche Startzeit" }, "durationInSeconds": { "type": "integer", "format": "int32", "description": "Dauer der Aktivität in Sekunden" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "billable": { "type": "boolean", "default": false, "description": "Abrechenbar?", "readOnly": true }, "billingType": { "type": "string", "description": "Abrechungsart von Aktivitäten", "enum": [ "LIKE_TASK", "UNCLEAR", "CUSTOMER", "INTERNAL", "PLANNED" ] }, "billingDocumentLineRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "internalBilled": { "type": "boolean", "default": false, "description": "Aktivität intern abgerechnet?", "readOnly": true }, "billingDiscount": { "type": "number", "description": "Rabatt zur Abrechnung" }, "durationToBillInSeconds": { "type": "integer", "format": "int32", "description": "tatsächliche Dauer" }, "published": { "type": "boolean", "default": false, "description": "Ist die Aktivität veröffentlicht" }, "accountPersonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "plannedDurationInSeconds": { "type": "integer", "format": "int32", "description": "geplante Dauer" }, "plannedStartDateTime": { "type": "string", "format": "date-time", "description": "geplante Startzeit" }, "email": { "type": "boolean", "default": false, "description": "Handelt es sich bei der Aktivität um eine E-Mail", "readOnly": true } }, "required": [ "type" ] }, "erp-crm-CrmActivityType": { "description": "CRM Aktivitätsarten", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung" }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierreihenfolge" }, "defaultBillingType": { "type": "string", "description": "Abrechungsart von Aktivitäten", "enum": [ "LIKE_TASK", "UNCLEAR", "CUSTOMER", "INTERNAL", "PLANNED" ] }, "billable": { "type": "boolean", "default": false, "description": "Abrechenbar?" }, "possibleUsingTypes": { "type": "array", "description": "Mögliche Typen, wo diese Aktivitätsart verwendet werden kann", "items": { "type": "string", "description": "Mögliche Typen, zu denen Aktivitäten erfasst werden können", "enum": [ "ACCOUNT", "CRM_DEAL", "CRM_PROJECT", "CRM_TASK" ] } }, "defaultForComments": { "type": "boolean", "default": false, "description": "Standard für Kommentare?" }, "emailArchiving": { "type": "boolean", "default": false, "description": "Für \"E-Mail-Archivieren\"?" }, "emailProcessing": { "type": "boolean", "default": false, "description": "Für \"E-Mail-Bearbeitung\"?" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "descriptionTemplate": { "type": "string", "description": "Text für Aktivitätstyp der im Editor eingetragen wird" }, "canBePublished": { "type": "boolean", "default": true, "description": "Darf die Aktivität veröffentlicht werden?" } }, "required": [ "label" ] }, "erp-crm-CrmObjectRef": { "description": "Referenz auf ein CRM-Objekt", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID" }, "type": { "type": "string", "description": "Möglich CRM-Typen", "enum": [ "TASK", "DEAL", "PROJECT" ] }, "number": { "type": "string", "description": "Nummer" }, "label": { "type": "string", "description": "Bezeichung" }, "description": { "type": "string", "description": "Beschreibung" }, "state": { "$ref": "#/components/schemas/erp-crm-CrmState" }, "subType": { "$ref": "#/components/schemas/erp-crm-CrmSubType" } }, "required": [ "id", "type" ] }, "erp-crm-CrmActivityTypePerUser": { "description": "CRM Aktivitätstypen pro Benutzer", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "activityTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defaultOfUser": { "type": "boolean", "default": false, "description": "Standard für Benutzer" }, "defaultBillingType": { "type": "string", "description": "Abrechungsart von Aktivitäten", "enum": [ "LIKE_TASK", "UNCLEAR", "CUSTOMER", "INTERNAL", "PLANNED" ] } }, "required": [ "activityTypeRef", "defaultBillingType", "userRef" ] }, "erp-crm-SetActivitiesBilledRequest": { "description": "Request markieren von Aktivitäten als \"abgerechnet\"", "properties": { "activityIds": { "type": "array", "description": "IDs der Aktivitäten, welche als abgerechnet markiert werden sollen", "items": { "type": "integer", "format": "int64", "description": "IDs der Aktivitäten, welche als abgerechnet markiert werden sollen" } }, "billingDocumentId": { "type": "integer", "format": "int64", "description": "ID des Abrechnungsbelegs, der mit den Aktivitäten verknüpft werden soll" } }, "required": [ "activityIds", "billingDocumentId" ] }, "erp-crm-CrmActivityBillingRule": { "description": "Abrechnungsregeln zu CRM Aktivitäten", "properties": { "version": { "type": "string", "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" } }, "required": [ "activityType", "billingArticleRef" ] }, "erp-account-ContactType": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "type": { "type": "string", "description": "type", "enum": [ "PHONE", "SOCIAL", "EMAIL", "FAX", "SKYPE", "MS_TEAMS", "CUSTOM", "MOBILE" ] }, "active": { "type": "boolean", "default": true, "description": "active" } }, "required": [ "label", "type" ] }, "erp-commission-CommissionAssignment": { "properties": { "version": { "type": "string", "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", "format": "date", "description": "Valid From" }, "validUntil": { "type": "string", "format": "date", "description": "Valid Until" }, "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": { "properties": { "version": { "type": "string", "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ür Artikel des zugehörigen Produkts", "items": { "$ref": "#/components/schemas/erp-product-BundleUnitTypeRatio" } }, "productId": { "type": "integer", "format": "int64", "description": "Produkt, zu dem dieses Schema gehört", "readOnly": true }, "label": { "type": "string", "description": "Name", "minLength": 1 } }, "required": [ "baseTypeRef", "label" ] }, "erp-product-BundleUnitTypeRatio": { "description": "Umrechnungen für Artikel des zugehörigen Produkts", "properties": { "version": { "type": "string", "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", "format": "double", "description": "Faktor" } }, "required": [ "baseUnitTypeRef", "factor", "relationUnitTypeRef" ] }, "erp-bank-Bank": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "description" }, "bankingBackend": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "bankName": { "type": "string", "description": "bank name" }, "bic": { "type": "string", "description": "BIC" }, "blz": { "type": "string", "description": "BLZ" }, "externalId": { "type": "string", "description": "External BankID" }, "creditorId": { "type": "string", "description": "Gläubiger-Identifikationsnummer" }, "userActionRequired": { "type": "boolean", "description": "Wether a call to bank init is needed.", "readOnly": true }, "accounts": { "type": "array", "description": "accounts", "items": { "$ref": "#/components/schemas/erp-bank-BankAccount" } }, "providerId": { "type": "integer", "format": "int64", "description": "ID of the banking provider" }, "userForSyncRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "active": { "type": "boolean", "default": true, "description": "Ist die Bank aktiv", "readOnly": true }, "logoUrl": { "type": "string", "description": "URL des Bank-Logos" } }, "required": [ "label" ] }, "erp-bank-BankAccount": { "description": "accounts", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "bankId": { "type": "integer", "format": "int64", "description": "id of the bank" }, "label": { "type": "string", "description": "description" }, "iban": { "type": "string", "description": "IBAN" }, "accountNumber": { "type": "string", "description": "account number" }, "subAccountNumber": { "type": "string", "description": "sub account number" }, "holderName": { "type": "string", "description": "account holder" }, "currency": { "type": "string", "description": "currency" }, "accountCredit": { "type": "number", "description": "Kontokorrent-Betrag" }, "sortOrder": { "type": "integer", "format": "int32", "description": "Konto-Position" }, "defaultBankAccount": { "type": "boolean", "default": false, "description": "Standard-Konto" }, "active": { "type": "boolean", "description": "Aktiv?" }, "externalReferenceId": { "type": "string", "description": "Referenz ID aus externem System", "readOnly": true }, "balance": { "type": "number", "description": "Kontosaldo" } } }, "erp-bank-BankTransaction": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "accountId": { "type": "integer", "format": "int64", "description": "id of the account" }, "parentId": { "type": "integer", "format": "int64", "description": "id of the parent transaction" }, "valueDate": { "type": "string", "format": "date-time", "description": "value date" }, "bookingDate": { "type": "string", "format": "date-time", "description": "booking date" }, "amount": { "type": "number", "description": "amount" }, "updatedAccountBalance": { "type": "number", "description": "updated account balance" }, "currency": { "type": "string", "description": "amount currency" }, "purpose": { "type": "string", "description": "purpose text" }, "name": { "type": "string", "description": "counterpart name" }, "iban": { "type": "string", "description": "counterpart iban" }, "bic": { "type": "string", "description": "counterpart bic" }, "accountNumber": { "type": "string", "description": "counterpart account number" }, "blz": { "type": "string", "description": "counterpart bank number" }, "bankName": { "type": "string", "description": "counterpart bank name" }, "mandateReference": { "type": "string", "description": "mandate reference" }, "customerReference": { "type": "string", "description": "customer reference" }, "creditorId": { "type": "string", "description": "creditor id" }, "debitorId": { "type": "string", "description": "debitor id" }, "transactionType": { "type": "string", "description": "transaction type (text)" }, "transactionCodeZKA": { "type": "string", "description": "transaction type (ZKA-code)" }, "transactionCodeSWIFT": { "type": "string", "description": "transaction type (SWIFT-code)" }, "purposeCode": { "type": "string", "description": "purpose code" }, "primanota": { "type": "string", "description": "primanota" }, "endToEndId": { "type": "string", "description": "End-To-End-Id" }, "compensationAmount": { "type": "number", "description": "compensation amount (i.e. return debit fees)" }, "originalAmount": { "type": "number", "description": "original amount" }, "originalCurrency": { "type": "string", "description": "currency of original amount" }, "userComment": { "type": "string", "description": "manual comments added by the user" }, "isPotentialDuplicate": { "type": "boolean", "description": "potentielles Duplikat", "readOnly": true }, "matchingState": { "type": "string", "description": "whether the transaction has been completely or partially matched with open items or not matched at all", "enum": [ "MATCHED", "PARTIALLY_MATCHED", "NOT_MATCHED", "NOT_RELEVANT" ], "readOnly": true }, "direction": { "type": "string", "description": "whether this transaction was incoming or outgoing", "enum": [ "INCOMING", "OUTGOING" ] }, "openItemRecordRefs": { "type": "array", "description": "openItem record reference", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true } } }, "erp-bank-BankPaymentRecord": { "properties": { "version": { "type": "string", "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", "format": "int64", "description": "id of the payment" }, "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", "format": "date", "description": "mandate date (for direct debit)" }, "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": "Änderungsgrund" }, "openItem": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "messages": { "type": "array", "description": "Validierungsmeldungen für diesen Datensatz (read-only)", "items": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "readOnly": true } }, "required": [ "amount", "name", "purpose" ] }, "erp-bank-BankPayment": { "properties": { "version": { "type": "string", "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", "enum": [ "READY_FOR_SUBMISSION", "PREPARED", "SENT", "CANCELLED", "UNKNOWN", "ERRONEOUS" ], "readOnly": true }, "batchBookingPreferred": { "type": "boolean", "description": "batch booked preferred" }, "directDebitSequenceType": { "type": "string", "description": "direct debit sequence type", "enum": [ "OOFF", "FRST", "RCUR", "FNAL" ] }, "executionDateTime": { "type": "string", "format": "date-time", "description": "execution date and time" }, "requestDate": { "type": "string", "format": "date-time", "description": "request date", "readOnly": true }, "endToEndId": { "type": "string", "description": "End-To-End-Id: Kann von Apps verwendet werden" }, "records": { "type": "array", "description": "payment records", "items": { "$ref": "#/components/schemas/erp-bank-BankPaymentRecord" } } }, "required": [ "accountRef", "type" ] }, "erp-bank-BankingBackend": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "default": true, "description": "Aktiv", "readOnly": true }, "appId": { "type": "string", "format": "uuid", "description": "externe App-ID" }, "appTransactionUrl": { "type": "string", "description": "App-URL zum Transaktionsabruf" }, "appPaymentUrl": { "type": "string", "description": "App-URL zum Senden einer Zahlung/Lastschrift" }, "appStatusUrl": { "type": "string", "description": "App-URL zum Abruf des Status einer Zahlung/Lastschrift" }, "backendType": { "type": "string", "description": "Backend-Typ", "enum": [ "OFFLINE", "FINAPI", "FINAPI_SANDBOX", "MOCKBANK", "APP" ] } }, "required": [ "label" ] }, "core-api-OperationMessage": { "properties": { "context": { "type": "string", "description": "message context" }, "messageValue": { "type": "string", "description": " message" } } }, "erp-asset-Asset": { "description": "Asset", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "active", "readOnly": true }, "number": { "type": "string", "description": "Asset-Nummer" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "typeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "label": { "type": "string", "description": "Asset-Bezeichnung" }, "note": { "type": "string", "description": "Notiz" }, "warrantyStartDate": { "type": "string", "format": "date", "description": "Beginn Garantie" }, "warrantyEndDate": { "type": "string", "format": "date", "description": "Ende Garantie" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "freeSerialNumber": { "type": "string", "description": "frei eingebbare Seriennummer / MHD" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accountAddressRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "billingAddressRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "contractRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "parentAssetRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "childAssetRefs": { "type": "array", "description": "Zugehörige Assets", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true }, "tags": { "type": "array", "description": "Tags zum Asset", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "typeRef" ] }, "erp-asset-AssetType": { "description": "Asset", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true } } }, "erp-product-Article": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "active", "readOnly": true }, "baseArticle": { "type": "boolean", "default": true, "description": "Ist das der Basis-Artikel des Produkts?", "readOnly": true }, "productType": { "type": "string", "description": "Artikelarten", "enum": [ "WITH_STOCK", "WITHOUT_STOCK", "SERVICE_ARTICLE", "SERVICE_CONTINGENT", "ASSEMBLY_GROUP", "JUMBO", "SHIPPING_COSTS", "VARIANT_MAIN_ARTICLE" ], "readOnly": true }, "priceBase": { "type": "string", "description": "Preisbasis", "enum": [ "NET_PRICE", "GROSS_PRICE" ] }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ], "readOnly": true }, "expiryDateType": { "type": "string", "description": "Art des Haltbarkeitsdatums bei Serienartikeln", "enum": [ "NONE", "BEST_BEFORE_DATE", "EXPIRATION_DATE" ], "readOnly": true }, "minimumRemainingDaysBeforeExpiryDateOnGoodsReceipt": { "type": "integer", "format": "int32", "description": "Mindestrestlaufzeit Eingang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel bei der Einbuchung in ein Verkaufslager noch aufweisen muss", "readOnly": true }, "minimumRemainingDaysBeforeExpiryDateForGoodsIssued": { "type": "integer", "format": "int32", "description": "Mindestrestlaufzeit Ausgang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel beim Verkauf noch aufweisen muss", "readOnly": true }, "warrantyInMonths": { "type": "integer", "format": "int32", "description": "Garantie in Monaten", "readOnly": true }, "lotOnlyRequiredWhenBookedToSalesStorage": { "type": "boolean", "default": false, "description": "Charge muss bei Einbuchung in ein Verkaufslager vergeben werden (für Serientyp LOT und BEST_BEFORE)", "readOnly": true }, "serialNumberLabelingType": { "type": "string", "description": "Seriennummer Auszeichnungsart", "enum": [ "MANUAL", "AUTOMATIC_ON_SUPPLIER_ORDER", "AUTOMATIC_ON_SUPPLIER_DELIVERY" ], "readOnly": true }, "number": { "type": "string", "description": "unique product number", "maxLength": 255, "minLength": 0 }, "sellable": { "type": "boolean", "default": true, "description": "is this product sellable" }, "purchasable": { "type": "boolean", "default": true, "description": "is this product purchasable" }, "solvable": { "type": "boolean", "default": false, "description": "is this product solvable to another package-variant" }, "mergeable": { "type": "boolean", "default": false, "description": "is this product mergeable to another package-variant" }, "salesUnit": { "type": "number", "description": "Verkaufseinheit" }, "grossMetric": { "$ref": "#/components/schemas/erp-product-Article.Metric" }, "netMetric": { "$ref": "#/components/schemas/erp-product-Article.Metric" }, "grossVolumeInCubicMeters": { "type": "number", "description": "gross Volume in cubic meters" }, "productUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "capacity": { "type": "number", "description": "capacity" }, "capacityUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "baseCapacity": { "type": "number", "description": "base capacity" }, "baseCapacityUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "productRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "productGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "netSalesPrice": { "type": "number", "description": "net sales prices" }, "grossSalesPrice": { "type": "number", "description": "gross sales prices" }, "taxSchemaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliveryMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "basePriceUnit": { "type": "number", "description": "Basispreiseinheit" }, "discountGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "deliverable": { "type": "boolean", "default": true, "description": "Ist der Artikel noch lieferbar?" }, "customsTariffNumber": { "type": "string", "description": "Zolltarifnummer", "maxLength": 15, "minLength": 0, "readOnly": true }, "countryOfOriginRef": { "$ref": "#/components/schemas/common-masterdata-CountryReference" }, "tags": { "type": "array", "description": "Tags zum Produkt", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "listingId": { "type": "string", "description": "die id des Listings" }, "taxLiabilityReversed": { "type": "boolean", "default": false, "description": "Umkehrung der Steuerschuld nach §13b UStG?" }, "sellableWithoutStock": { "type": "boolean", "default": false, "description": "is this product sellable without any quantity at the stock" }, "listed": { "type": "boolean", "default": true, "description": "soll der Artikel gelistet werden" }, "listingState": { "type": "string", "description": "Synchronisationsstatus eines Listings", "enum": [ "DISABLED", "NEED_SYNCHRONIZE", "QUEUED_FOR_SYNCHRONIZE", "SYNCHRONIZED", "ERRONEOUS", "NEED_DELETION", "QUEUED_FOR_DELETION" ], "readOnly": true }, "listingStateChangeTime": { "type": "string", "format": "date-time", "description": "die letzte Aktualisierung des listingStates", "readOnly": true }, "identifiers": { "type": "array", "description": "all (external) product numbers (SKU, EAN, ...)", "items": { "$ref": "#/components/schemas/erp-product-ArticleIdentifier" } }, "name": { "type": "string", "description": "name of this product" }, "alternativeName": { "type": "string", "description": "alternative name of this product" }, "description": { "type": "string", "description": "description of this product" }, "listingDescriptionCustom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "availabilityDetermination": { "$ref": "#/components/schemas/erp-product-ArticleAvailabilityDetermination" }, "listingCustom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "targetTradingMargin": { "type": "number", "description": "Soll-Handelsspanne" }, "languageCode": { "type": "string", "description": "Einschränkung auf Land" }, "dangerousGoodInformation": { "$ref": "#/components/schemas/erp-product-DangerousGoodInformation" }, "dangerousGoods": { "type": "boolean", "default": false, "description": "Artikel ist Gefahrgut" }, "availableAlone": { "type": "boolean", "default": true, "description": "alleine lieferbarer Artikel?" }, "pickingType": { "type": "string", "default": "ACCORDING_TO_TEMPLATE", "description": "Definiert die Art, wie ein Artikel kommissioniert werden darf", "enum": [ "ACCORDING_TO_TEMPLATE", "PICKING_ALLOWED", "PICKING_NOT_ALLOWED", "ONLY_SINGLE_ORDER_PICKING_ALLOWED", "ONLY_COLLECTIVE_ORDER_PICKING_ALLOWED" ] }, "workUnitInMinutes": { "type": "integer", "format": "int32", "description": "Arbeitseinheit in Minuten" }, "initialLastPurchasePrice": { "type": "number", "description": "Letzter EKP (Startwert)" }, "initialAvgPurchasePrice": { "type": "number", "description": "Durchschnittl. EKP (Startwert)" }, "determineAvgPurchasePrice": { "type": "boolean", "default": true, "description": "dEK berechnen?" }, "commissionable": { "type": "boolean", "default": true, "description": "provisionsberechtiger Artikel?" }, "cashDiscountable": { "type": "boolean", "default": true, "description": "skontierbarer Artikel?" }, "discountable": { "type": "boolean", "default": true, "description": "rabattierbarer Artikel?" }, "contingentArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "printWarningIfNoContingentAvailable": { "type": "boolean", "default": true, "description": "Nur für Kontingentartikel: soll bei der Abrechnung angedruckt werden, dass kein Kontingent vorhanden ist?" }, "freelyPickable": { "type": "boolean", "default": false, "description": "Frei kommissionierbar" }, "shippingLabelPrinting": { "type": "boolean", "default": false, "description": "Versandlabeldruck" }, "permissibleForOrderProposal": { "type": "boolean", "default": true, "description": "zulässig für Aufnahme in Bestellvorschläge" }, "dropShippingPolicy": { "type": "string", "default": "STORAGE", "description": "Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf", "enum": [ "ANY", "DROP_SHIPPING", "STORAGE", "STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING" ] }, "fabrication": { "type": "boolean", "default": false, "description": "Produktion" }, "onlyManualFabrication": { "type": "boolean", "default": false, "description": "Nur manuelle Produktion" }, "fabricationOfComponents": { "type": "string", "description": "Produktion von Komponenten", "enum": [ "NEVER", "COMPLETELY_IF_NECESSARY", "REQUIRED_QUANTITY_IF_NECESSARY", "ALWAYS" ] }, "defaultFabricationCost": { "type": "number", "description": "Vorgabe Herstellungskosten" }, "printLabelSettings": { "$ref": "#/components/schemas/erp-product-ArticlePrintLabelSettings" }, "manufacturerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "manufacturerArticleNumber": { "type": "string", "description": "Artikelnummer" }, "needsAssessmentOnlyOnReservationBasis": { "type": "boolean", "default": false, "description": "Bedarfsermittlung nur über Reservierungen" }, "onGoodsArrivalConvertIntoBundleArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "remark": { "type": "string", "description": "Sonderbemerkung" }, "note": { "type": "string", "description": "Notiz" }, "forcedRecommendedRetailPrice": { "type": "boolean", "description": "Ist der UVP verpflichtend?" }, "articleAssetInformation": { "$ref": "#/components/schemas/erp-product-ArticleAssetInformation" }, "returnable": { "type": "boolean", "default": true, "description": "retournierbar" } }, "required": [ "deliverable", "dropShippingPolicy", "productGroupRef" ] }, "erp-product-Article.Metric": { "description": "weight and size w.o. packaging", "properties": { "weight": { "type": "number", "description": "weight" }, "weightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "sizeUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "sizeX": { "type": "number", "description": "size" }, "sizeY": { "type": "number", "description": "size" }, "sizeZ": { "type": "number", "description": "size" } } }, "erp-product-ArticleAssetInformation": { "description": "Information zur Verbindung zwischen Asset und Article", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "createAssetOnStorageEntry": { "type": "boolean", "default": false, "description": "Assets automatisch beim Lagerzugang erstellen" }, "createAssetOnSale": { "type": "boolean", "default": false, "description": "Asset automatisch beim Verkauf erstellen" }, "createAssetOnDocumentCategory": { "type": "string", "description": "Asset erstellen bei Belegtyp", "enum": [ "CUSTOMER_DELIVERY", "CUSTOMER_INVOICE" ] }, "createWithAssetType": { "$ref": "#/components/schemas/erp-asset-AssetType" } } }, "erp-product-ArticleIdentifier": { "description": "all (external) product numbers (SKU, EAN, ...)", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "value": { "type": "string", "description": "identifier", "maxLength": 255, "minLength": 0 }, "name": { "type": "string", "description": "identifier type", "maxLength": 255, "minLength": 0 }, "defaultArticleIdentifier": { "type": "boolean", "default": false, "description": "Standard Artikel Kennung?" } }, "required": [ "defaultArticleIdentifier", "name", "value" ] }, "erp-product-ArticlePrintLabelSettings": { "description": "Etikettdruck-Einstellungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "report": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "incomingCalculationMode": { "type": "string", "description": "Wareneingang: Bestimmung der Druckmenge", "enum": [ "NO_LABEL", "FIXED_AMOUNT", "QUANTITY_TIMES_AMOUNT", "QUANTITY_PER_PACKAGING_UNIT", "QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY" ] }, "incomingPrintQuantity": { "type": "integer", "format": "int32", "description": "Wareneingang: Druckmenge" }, "outgoingCalculationMode": { "type": "string", "description": "Warenausgang: Bestimmung der Druckmenge", "enum": [ "NO_LABEL", "FIXED_AMOUNT", "QUANTITY_TIMES_AMOUNT", "QUANTITY_PER_PACKAGING_UNIT", "QUANTITY_TIMES_AMOUNT_AND_PACKAGING_QUANTITY" ] }, "outgoingPrintQuantity": { "type": "integer", "format": "int32", "description": "Warenausgang: Druckmenge" } } }, "erp-product-DangerousGoodInformation": { "description": "Gefahrgut Informationen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "description": { "type": "string", "description": "description" }, "shippingName": { "type": "string", "description": "shipping name" }, "technicalName": { "type": "string", "description": "technical name" }, "adrNumber": { "type": "string", "description": "adr identification number" }, "unNumber": { "type": "string", "description": "united nations number (un number)" }, "identificationClass": { "type": "string", "description": "identification class" }, "classificationCode": { "type": "string", "description": "classification code" }, "packingGroup": { "type": "string", "description": "packing group (I, II, III or blank)" }, "packingCode": { "type": "string", "description": "packing code" }, "transportCategory": { "type": "string", "description": "transportation category" }, "regulationCode": { "type": "string", "description": "regulation code", "enum": [ "FR", "LQ", "EQ", "LR" ] }, "regulationSet": { "type": "string", "description": "regulation Set, e.g. ADR", "enum": [ "ADR", "IATA" ] }, "hazardousWeight": { "type": "number", "description": "weight of the hazardous part" }, "subsidiaryRisk": { "type": "boolean", "default": false, "description": "secundary risk of the dangerous good" }, "tunnelRestrictionCode": { "type": "string", "description": "tunnel restriction classes", "enum": [ "A", "B", "C", "D", "E" ] } } }, "erp-product-ArticleTax": { "description": "steuerzuordnung eines artikels", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "validFrom": { "type": "string", "format": "date", "description": "the date, this entry is valid from" }, "articleId": { "type": "integer", "format": "int64", "description": "the date, this entry is valid from", "readOnly": true } }, "required": [ "countryCode", "typeRef", "validFrom" ] }, "erp-stock-ArticleStorage": { "description": "Lagerinfos", "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ätze", "items": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" } }, "quantityInStock": { "type": "number", "description": "Bestand im Lager", "readOnly": true }, "stockAvailable": { "type": "number", "description": "Verfügbare Menge im Lager gemäß konfigurierter Verfügbarkeitsermittlung", "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 }, "quantityInFabrication": { "type": "number", "description": "Aktuelle Menge in Produktion", "readOnly": true }, "reorderPoint": { "type": "number", "description": "Meldebestand" }, "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", "default": false, "description": "Hat dieses Lager Lagerplätze?", "readOnly": true }, "virtualStockAmount": { "type": "number", "description": "Aktueller \"virtueller\" Bestand (wenn größere Gebinde in dieses aufgelöst werden würden)", "readOnly": true }, "virtualStockAvailable": { "type": "number", "description": "Aktuelle \"virtuelle\" verfügbare Menge (wenn größere Gebinde in dieses aufgelöst werden würden)", "readOnly": true } }, "required": [ "articleId", "storageRef" ] }, "erp-product-ArticleFabricationComponent": { "description": "Komponente eines Produktionsartikels", "properties": { "version": { "type": "string", "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" }, "sourceBundleArticleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "quantity": { "type": "number", "description": "Menge" }, "deviatingUnitRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "deviatingUnitPrice": { "type": "number", "description": "Abweichende Herstellungskosten" }, "name": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 2147483647, "minLength": 0 }, "forSerialInheritance": { "type": "boolean", "default": false, "description": "Basis für die Vererbung der Seriennummer" }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierreihenfolge" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true } }, "required": [ "componentArticleRef", "fabricationArticleRef", "quantity" ] }, "erp-product-ArticleComponent": { "description": "Komponenten eines Baugruppen- oder Jumbo-Artikels", "properties": { "version": { "type": "string", "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", "format": "int64", "description": "Baugruppen- oder Jumbo-Artikel" }, "componentArticleId": { "type": "integer", "format": "int64", "description": "Artikel dieser Komponente" }, "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", "format": "int32", "description": "Position der Komponente innerhalb des Containers" }, "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ügbare Menge der Komponente" } }, "required": [ "componentArticleId", "containerArticleId" ] }, "erp-product-ArticleStorageArea": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "articleId": { "type": "integer", "format": "int64", "description": "Der Artikel, dessen Lagerbereiche hier ausgegeben werden" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "storageAreaId": { "type": "integer", "format": "int64", "description": "In welchem Lager wird der Artikel gelagert" }, "storageAreaLabel": { "type": "string", "description": "Label des Lagerbereichs", "readOnly": true } }, "required": [ "articleId", "storageAreaId" ] }, "erp-product-ArticleListing": { "properties": { "version": { "type": "string", "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", "default": false, "description": "is this product sellable without any quantity at the stock" }, "listed": { "type": "boolean", "default": true, "description": "soll der Artikel gelistet werden" }, "listingState": { "type": "string", "description": "Synchronisationsstatus eines Listings", "enum": [ "DISABLED", "NEED_SYNCHRONIZE", "QUEUED_FOR_SYNCHRONIZE", "SYNCHRONIZED", "ERRONEOUS", "NEED_DELETION", "QUEUED_FOR_DELETION" ], "readOnly": true }, "listingStateChangeTime": { "type": "string", "format": "date-time", "description": "die letzte aktualisierung des listingStates", "readOnly": true }, "identifiers": { "$ref": "#/components/schemas/erp-product-ArticleListing.WithDefaultsListArticleIdentifier" }, "name": { "$ref": "#/components/schemas/erp-product-ArticleListing.WithDefaultsString" }, "alternativeName": { "$ref": "#/components/schemas/erp-product-ArticleListing.WithDefaultsString" }, "description": { "$ref": "#/components/schemas/erp-product-ArticleListing.WithDefaultsString" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "descriptionCustom": { "$ref": "#/components/schemas/erp-product-ArticleListing.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)" }, "categoryRefs": { "type": "array", "description": "Kategorien, denen dieses Listing zugeordnet ist", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "required": [ "salesChannelRef" ] }, "erp-product-ArticleListing.CustomFieldWithDefaults": { "description": "description custom data", "properties": { "value": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "defaultValue": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-product-ArticleListing.WithDefaultsListArticleIdentifier": { "description": "all (external) article numbers (SKU, EAN, ...)", "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", "items": { "$ref": "#/components/schemas/erp-product-ArticleIdentifier" }, "readOnly": true } } }, "erp-product-ArticleListing.WithDefaultsString": { "description": "description of this article", "properties": { "value": { "type": "string", "description": "Wert dieses Sales-Channel" }, "defaultValue": { "type": "string", "description": "Wert des Default-Sales-Channel", "readOnly": true } } }, "erp-product-ArticleSupplier": { "description": "Article-Supplier-Relation", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "articleId": { "type": "string", "description": "Referenced Article" }, "articleName": { "type": "string", "description": "Referenced Article name" }, "accountId": { "type": "string", "description": "Referenced Supplier-Account" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "accountDisplayName": { "type": "string", "description": "Anzeigename des Accounts", "readOnly": true }, "active": { "type": "boolean", "default": true, "description": "Aktiv?" }, "supplierArticleNumber": { "type": "string", "description": "Abweichende Produktnummer" }, "supplierArticleName": { "type": "string", "description": "Abweichende Produktbezeichnung" }, "supplierArticleDescription": { "type": "string", "description": "Abweichende Produktbeschreibung" }, "supplierArticleIdentifier": { "type": "string", "description": "Abweichender Produktidentifer (z.B. Barcode)" }, "useSupplierArticleNumber": { "type": "boolean", "default": false, "description": "Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)" }, "useSupplierArticleName": { "type": "boolean", "default": false, "description": "Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)" }, "useSupplierArticleDescription": { "type": "boolean", "default": false, "description": "Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)" }, "useSupplierArticleIdentifier": { "type": "boolean", "default": false, "description": "Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)" }, "purchaseUnit": { "type": "number", "description": "Einkaufseinheit" }, "packagingUnit": { "type": "number", "description": "Verpackungseinheit" }, "productUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "deliveryTime": { "type": "integer", "format": "int32", "description": "Lieferzeit in (Werk-)Tagen" }, "minimumOrderQuantity": { "type": "number", "description": "Mindestbestellmenge" }, "supplierReportingStock": { "type": "number", "description": "Lieferanten-Meldebestand" }, "mainSupplier": { "type": "boolean", "default": false, "description": "Hauptlieferant" }, "discountGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "defaultNetPrice": { "type": "number", "description": "Standardpreis Netto" }, "defaultGrossPrice": { "type": "number", "description": "Standardpreis Brutto" }, "productPrices": { "type": "array", "description": "Lieferanten-Preise", "items": { "$ref": "#/components/schemas/erp-product-ProductPrice" }, "readOnly": true }, "orderOnComponentBase": { "type": "boolean", "default": true, "description": "Sollen Baugruppen auf Komponenten-Basis bestellt werden?)" }, "dropShippingAllowed": { "type": "boolean", "description": "Kennzeichen, ob Streckengeschäft erlaubt" }, "supplierPrintLabelSettings": { "$ref": "#/components/schemas/erp-product-ArticlePrintLabelSettings" } }, "required": [ "accountId", "active", "articleId" ] }, "erp-product-ArticleCustomer": { "description": "Article-Customer-Relation", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "articleId": { "type": "integer", "format": "int64", "description": "Referenced Article" }, "articleName": { "type": "string", "description": "Referenced Article name" }, "accountId": { "type": "integer", "format": "int64", "description": "Referenced Customer-Account" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "accountDisplayName": { "type": "string", "description": "Anzeigename des Accounts", "readOnly": true }, "active": { "type": "boolean", "description": "Aktiv?" }, "deviatingArticleNumber": { "type": "string", "description": "Abweichende Produktnummer" }, "deviatingArticleName": { "type": "string", "description": "Abweichende Produktbezeichnung" }, "deviatingArticleDescription": { "type": "string", "description": "Abweichende Produktbeschreibung" }, "deviatingArticleIdentifier": { "type": "string", "description": "Abweichender Produktidentifer (z.B. Barcode)" }, "useDeviatingArticleNumber": { "type": "boolean", "description": "Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)" }, "useDeviatingArticleName": { "type": "boolean", "description": "Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)" }, "useDeviatingArticleDescription": { "type": "boolean", "description": "Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)" }, "useDeviatingArticleIdentifier": { "type": "boolean", "description": "Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)" }, "lockedForCustomer": { "type": "boolean", "description": "Ist das Produkt für den Kunden gesperrt?" }, "defaultNetPrice": { "type": "number", "description": "Standardpreis Netto" }, "defaultGrossPrice": { "type": "number", "description": "Standardpreis Brutto" }, "productPrices": { "type": "array", "description": "Kunden-Preise", "items": { "$ref": "#/components/schemas/erp-product-ProductPrice" }, "readOnly": true }, "customerPrintLabelSettings": { "$ref": "#/components/schemas/erp-product-ArticlePrintLabelSettings" }, "priceDetermination": { "type": "string", "default": "DEFAULT", "description": "Art der Preisermittlung", "enum": [ "DEFAULT", "SPECIAL", "ONLY_DEFAULT_PRICE" ] } }, "required": [ "accountId", "articleId" ] }, "erp-product-ArticleActor": { "description": "Article-Actor-Relation", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "articleId": { "type": "integer", "format": "int64", "description": "Referenced Article" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "accountAddressId": { "type": "integer", "format": "int64", "description": "Referenced Account Address" }, "accountId": { "type": "integer", "format": "int64", "description": "Referenced Account", "readOnly": true }, "accountDisplayName": { "type": "string", "description": "Anzeigename des Accounts", "readOnly": true }, "accountAddressName": { "type": "string", "description": "Name der Zusatzadresse", "readOnly": true }, "type": { "type": "string", "description": "Typ des Akteurs", "enum": [ "ECONOMIC_OPERATOR", "IMPORTER", "FULFILLMENT_SERVICE_PROVIDER" ] } }, "required": [ "accountAddressId", "articleId", "type" ] }, "erp-product-Accessory": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "mainArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accessoryArticleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "insertQuantity": { "type": "number", "description": "Einfügmenge" }, "insertTerm": { "type": "string", "description": "Zubehör Einfügeart", "enum": [ "MANUAL", "AUTOMATIC_QUANTITY_IF_ACCESSORY_INSERTED", "AUTOMATIC_PROPORTIONAL_QUANTITY", "AUTOMATIC_FIXED_QUANTITY" ] }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortiereihenfolge" } }, "required": [ "accessoryArticleRef", "insertQuantity", "insertTerm", "mainArticleRef" ] }, "common-output-OutputModuleRef": { "description": "print module key", "properties": { "key": { "type": "string", "description": "output module key" }, "label": { "type": "string", "description": "output module label" } } }, "erp-account-AccountOutputRule": { "properties": { "version": { "type": "string", "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" ] }, "outputQuantity": { "type": "integer", "format": "int32", "description": "Anzahl der Ausgaben", "minimum": 1 }, "ruleContacts": { "type": "array", "description": "Kontaktreferenzen für die OutputRule-Extension", "items": { "$ref": "#/components/schemas/erp-account-AccountOutputRuleContact" } } }, "required": [ "moduleRef" ] }, "erp-account-AccountOutputRuleContact": { "description": "Kontaktreferenzen für die OutputRule-Extension", "properties": { "version": { "type": "string", "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" ] } }, "required": [ "contactRef" ] }, "erp-account-AccountListing": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "customerListed": { "type": "boolean", "default": true, "description": "Kunde gelistet?" }, "manufacturerListed": { "type": "boolean", "default": true, "description": "Hersteller gelisted?" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "accountRef", "salesChannelRef" ] }, "erp-account-SupplierGroup": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung der Lieferantengruppe", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "Aktiv" } }, "required": [ "label" ] }, "erp-account-CustomerGroup": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung der Kundengruppe", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "Aktiv" } }, "required": [ "label" ] }, "core-api-TypedObjectRef": { "description": "Wozu gehört diese Wiki-Seite? Nur für POST. Ändern über den Move-Endpunkt.", "properties": { "id": { "type": "string", "description": "ID" }, "refType": { "type": "string", "description": "Datentyp des referenzierten Objekts" }, "label": { "type": "string", "description": "ggf. vorhandene Beschreibung", "readOnly": true } }, "required": [ "id", "refType" ] }, "dms-wiki-WikiPageDto": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "parent": { "$ref": "#/components/schemas/core-api-TypedObjectRef" }, "subject": { "type": "string", "description": "Titel", "minLength": 1 }, "content": { "type": "string", "description": "Markdown-Inhalt des Wikis", "minLength": 1 }, "subPageRefs": { "type": "array", "description": "Referenzen auf die Unter-Wikis", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true }, "tags": { "type": "array", "description": "Tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "revisions": { "type": "array", "description": "Revisionen", "items": { "$ref": "#/components/schemas/dms-wiki-WikiPageRevisionDto" }, "readOnly": true }, "position": { "type": "integer", "format": "int32", "description": "Sortierung innerhalb des übergeordneten Objekts", "readOnly": true } }, "required": [ "content", "subject" ] }, "dms-wiki-WikiPageRevisionDto": { "description": "Revisionen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "revisionNumber": { "type": "integer", "format": "int32", "description": "Revisionsnummer" } } }, "dms-shelf-ShelfDocument": { "properties": { "version": { "type": "string", "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", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfShare" }, "readOnly": true }, "description": { "type": "string", "description": "description of this document" }, "entryDate": { "type": "string", "format": "date", "description": "Date of this Entry/Document" }, "plannedRemovalDate": { "type": "string", "format": "date", "description": "Automatische Löschung ab", "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", "format": "uuid", "description": "Externe Id", "readOnly": true }, "alias": { "type": "string", "description": "Alias" }, "type": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentType" }, "state": { "type": "string", "description": "Status eines Dokuments", "enum": [ "DRAFT", "FILE_ATTACHED", "MISSING" ], "readOnly": true }, "deletionState": { "type": "string", "default": "NOT_YET", "description": "Löschungsstatus", "enum": [ "NOT_YET", "PREPARE_DELETE", "FILE_DELETED", "MANUALLY_RETAIN" ], "readOnly": true }, "translatableTexts": { "type": "array", "description": "Mehrsprachige Bezeichnungen", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfTranslatableText" } } }, "required": [ "entryDate" ] }, "dms-shelf-ShelfDocumentType": { "description": "Dokumentenart", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "systemPresetting": { "type": "boolean", "default": false, "description": "system presetting", "readOnly": true }, "duration": { "type": "integer", "format": "int32", "description": "duration of storage (years)" }, "revisionStorageRule": { "type": "integer", "format": "int32", "description": "storage rule for revisions" }, "accessLevelRead": { "type": "integer", "format": "int32", "description": "access level or reading" }, "accessLevelWrite": { "type": "integer", "format": "int32", "description": "access level for writing" }, "accessLevelDelete": { "type": "integer", "format": "int32", "description": "access level for deleting" }, "active": { "type": "boolean", "default": true, "description": "Ist die Dokumentenart aktiv" } }, "required": [ "label" ] }, "dms-shelf-ShelfFile": { "description": "file data", "properties": { "version": { "type": "string", "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", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfFileMetaData" }, "readOnly": true }, "fileSize": { "type": "integer", "format": "int64", "description": "fileSize", "readOnly": true }, "revisionNumber": { "type": "integer", "format": "int32", "description": "revision number of this file", "readOnly": true }, "subFiles": { "type": "array", "description": "subFiles for this file", "items": { "$ref": "#/components/schemas/dms-shelf-SubFileInfo" }, "readOnly": true } } }, "dms-shelf-ShelfFileMetaData": { "description": "meta data", "properties": { "version": { "type": "string", "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" } }, "required": [ "metaKey" ] }, "dms-shelf-ShelfShare": { "description": "share informations", "properties": { "version": { "type": "string", "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 öffentlichen zugriff auf diese resource gibt", "readOnly": true }, "publicUrlCreatedAt": { "type": "string", "format": "date", "description": "wann die öffentliche resource erstellt wurde", "readOnly": true }, "publicUrlDurationInMinutes": { "type": "integer", "format": "int64", "description": "wie viele Minuten bleibt dieser resource-pfad zugreifbar (null = unlimited)", "minimum": 0 }, "availability": { "type": "string", "description": "Bestimmt, wie oft eine öffentliche URL verfügbar ist", "enum": [ "UNLIMITED", "ONE_TIME_USE" ] }, "timesUsed": { "type": "integer", "format": "int32", "description": "Anzahl der Nutzungen", "readOnly": true }, "appId": { "type": "string", "format": "uuid", "description": "App-ID" }, "sharedByExternalRef": { "type": "string", "description": "Externer Verweis auf dieses Share" }, "revision": { "type": "integer", "format": "int32", "description": "Revision", "readOnly": true }, "eTag": { "type": "string", "description": "Hash der Revision", "readOnly": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "publishState": { "type": "string", "description": "Veröffentlichungsstatus einer Dokument-Freigabe", "enum": [ "SYNCED", "PENDING", "DRAFT" ] }, "translatableTexts": { "type": "array", "description": "Mehrsprachige Bezeichnungen", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfTranslatableText" } }, "etag": { "type": "string" } }, "required": [ "availability" ] }, "dms-shelf-ShelfTranslatableText": { "description": "Mehrsprachige Bezeichnungen", "properties": { "version": { "type": "string", "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": { "type": "string", "description": "Alternativer Text", "maxLength": 2147483647, "minLength": 0 }, "metaTitle": { "type": "string", "description": "Meta-Titel", "maxLength": 255, "minLength": 0 }, "languageCode": { "type": "string", "description": "Sprache", "minLength": 1 } }, "required": [ "languageCode" ] }, "dms-shelf-SubFileInfo": { "description": "subFiles for this file", "properties": { "version": { "type": "string", "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", "format": "date-time", "description": "file last modified" }, "contentType": { "type": "string", "description": "Inhaltstyp" }, "shelfFile": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "dms-shelf-ShelfImageTransformation": { "properties": { "version": { "type": "string", "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", "format": "int32", "description": "Breite in pixeln" }, "sizeY": { "type": "integer", "format": "int32", "description": "Höhe in pixeln" }, "rotation": { "type": "integer", "format": "int32", "description": "Rotation in Grad" }, "watermarkLabel": { "type": "string", "description": "Ein Wasserzeichen" }, "imageFileStorageHandle": { "type": "string", "description": "interne referenz auf die physikalische datei", "readOnly": true }, "imageFileCreatedAt": { "type": "string", "format": "date", "description": "wann wurde die physikalische datei erstellt", "readOnly": true }, "imageFileDuration": { "type": "integer", "format": "int32", "description": "wie viele Tage bleibt diese physikalische datei erhalten (0 = unlimited)" } } }, "dms-shelf-TransferFilePartUpdateRequest": { "description": "Aktualisiert einen FilePart Upload", "properties": { "uploadEtag": { "type": "string", "description": "resulting ETag from UploadPart upload", "minLength": 1 } }, "required": [ "uploadEtag" ] }, "dms-shelf-ShelfDocumentAttribution": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "refType": { "type": "string", "description": "type of the referenced object" }, "refId": { "type": "integer", "format": "int64", "description": "id of the referenced object" }, "uiSort": { "type": "integer", "format": "int32", "description": "UI-verwaltetes Feld" }, "uiComment": { "type": "string", "description": "UI-verwaltetes Feld" }, "uiFavorite": { "type": "boolean", "default": false, "description": "UI-verwaltetes Feld" }, "mainAttribution": { "type": "boolean", "description": "Hauptverknüpfung dieser DMS-Ressource", "readOnly": true }, "transformationKeys": { "type": "array", "description": "Verfügbare Transformationen zum Bild", "items": { "type": "string", "description": "Verfügbare Transformationen zum Bild" }, "readOnly": true }, "shelfResourceId": { "type": "integer", "format": "int64", "description": "ID der verknüpften DMS-Ressource" }, "publish": { "type": "boolean", "description": "Soll das Dokument veröffentlicht werden?" }, "purpose": { "type": "string", "description": "Art der Beziehung / Verwendungszweck" } }, "required": [ "purpose" ] }, "vds-unknownmodule-CarrierParameterType": {}, "vds-carrier-CarrierType": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "description" }, "appId": { "type": "string", "format": "uuid", "description": "external App-Id" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?" }, "backendType": { "type": "string", "description": "carriertype for backend", "enum": [ "APP", "NONE" ] }, "createShipmentSyncUrl": { "type": "string", "description": "App: URL für Versandauftrag" }, "createLabelSyncUrl": { "type": "string", "description": "App: URL für Versandlabel" }, "canPrintLabel": { "type": "boolean", "default": false, "description": "Label-Druck möglich" }, "trackingUrlTemplate": { "type": "string", "description": "Tracking-URL-Vorlage" } }, "required": [ "label" ] }, "erp-api-Scenario": { "properties": { "version": { "type": "string", "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ür das Scenario", "readOnly": true }, "label": { "type": "string", "description": "die beschreibung für dieses Scenario", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "die beschreibung für dieses Scenario", "maxLength": 2147483647, "minLength": 0 }, "startDate": { "type": "string", "format": "date", "description": "Start-Datum für die Berechnung (optional)" }, "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": { "description": "Dimensions Definition", "properties": { "version": { "type": "string", "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": "Verteilschlüssel - Key/Gruppe", "minLength": 1, "pattern": "[a-zA-Z](\\w)*" }, "multiSelect": { "type": "boolean", "default": false, "description": "können mehrere Schlüssel bei der Verteilung verwendet werden" }, "definedValues": { "type": "array", "description": "Verteilschlüssel Ausprägungen", "items": { "$ref": "#/components/schemas/erp-api-ScenarioDimensionValue" } } }, "required": [ "key" ] }, "erp-api-ScenarioDimensionValue": { "description": "Verteilschlüssel Ausprägungen", "properties": { "version": { "type": "string", "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ägung" }, "fallback": { "type": "boolean", "description": "handelt es sich um den Fallback-Value" }, "sortOrder": { "type": "integer", "format": "int64", "description": "Sortierreihenfolge", "readOnly": true }, "active": { "type": "boolean", "default": true, "description": "ist der Wert weiterhin aktiv/selektierbar" } } }, "erp-api-ScenarioFactDef": { "description": "Fakten/Daten Definition", "properties": { "version": { "type": "string", "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": { "type": "string", "description": "Attribut Name", "maxLength": 255, "minLength": 0 } }, "required": [ "attributeType", "factAttribute" ] }, "erp-api-ScenarioDesiredValue": { "properties": { "version": { "type": "string", "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ägung", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "actualYear": { "type": "integer", "format": "int32", "description": "das Jahr" }, "actualMonth": { "type": "integer", "format": "int32", "description": "der Monat" }, "desiredValue": { "type": "number", "description": "Soll-Wert" } }, "required": [ "actualMonth", "actualYear", "desiredValue", "dimValueRefs", "factRef" ] }, "erp-api-ScenarioActualValue": { "properties": { "version": { "type": "string", "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", "format": "int64", "description": "Referenz auf die LookupReferenz" }, "dimValueRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "weight": { "type": "number", "description": "gewichtung" } }, "required": [ "dimValueRef", "referenceId", "scenarioDimRef" ] }, "erp-pos-TssAdminPuk": { "description": "Request zum Ändern des TSS-Pins", "properties": { "adminPuk": { "type": "string", "description": "Admin-PUK für die TSS", "minLength": 1 }, "newAdminPin": { "type": "string", "description": "Neuer Admin-PIN für die TSS" } }, "required": [ "adminPuk" ] }, "erp-sales_channel-SalesChannel": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "default": true, "description": "ist dieser channel aktiv" }, "channelType": { "type": "string", "description": "typ/klassifizierung des sales channel", "enum": [ "STORE", "POS", "ECOMMERCE", "MARKETPLACE" ] }, "channelBackend": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "fiscalizationBackend": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priceFromSalesChannel": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "discountFromSalesChannel": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "calculationMode": { "type": "string", "description": "calculation mode of this sales channel", "enum": [ "HORIZONTAL", "VERTICAL" ] }, "roundingMode": { "type": "string", "default": "NONE", "description": "Endbetragsrundung", "enum": [ "NONE", "SWITZERLAND" ] }, "salesChannelStorages": { "type": "array", "description": "Lagerzuordnungen", "items": { "$ref": "#/components/schemas/erp-sales_channel-SalesChannelStorage" } }, "defaultSalesChannel": { "type": "boolean", "description": "Standard-Verkaufskanal" }, "blockManualInvoiceTakeover": { "type": "boolean", "default": false, "description": "Manuelle Übernahme in Rechnung unterbinden" }, "blockManualCreditNoteTakeover": { "type": "boolean", "default": false, "description": "Manuelle Übernahme in Gutschrift unterbinden" }, "reportGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "autoPrintPaperReceipt": { "type": "boolean", "default": true, "description": "Papierbelege automatisch drucken" }, "businessRelationType": { "type": "string", "description": "Geschäftsbeziehungs-Typen für Geschäftspartner", "enum": [ "B2B", "B2C", "B2G" ] }, "categoryTree": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "externalReferences": { "type": "string", "description": "Externe Referenzen", "readOnly": true }, "tssExportState": { "type": "string", "description": "TSS-Export-Zustand", "enum": [ "PENDING", "FINISHED" ], "readOnly": true }, "lastTssExportDate": { "type": "string", "format": "date", "description": "Letzter TSS-Export-Tag", "readOnly": true }, "pendingTssExportDateEnd": { "type": "string", "format": "date", "description": "Aktuell laufender TSS-Export bis", "readOnly": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-sales_channel-SalesChannelBackend": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Label", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "appId": { "type": "string", "description": "App-ID", "maxLength": 255, "minLength": 0 }, "type": { "type": "string", "description": "Typ", "enum": [ "SELF", "APP" ] }, "validChannelTypes": { "type": "array", "description": "Erlaubte typen", "items": { "type": "string", "description": "Erlaubte typen", "enum": [ "STORE", "POS", "ECOMMERCE", "MARKETPLACE" ] } } }, "required": [ "label", "type" ] }, "erp-pos-PosPaymentRule": { "description": "POS-Payment-Rule", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "posRegisterRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentOperation": { "type": "string", "description": "Zahlungsoperation (Eingangskriterium, z.B. PAYMENT, CANCEL, REFUND)", "enum": [ "PAYMENT", "CANCEL", "REFUND" ] }, "targetConsumerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetConsumerResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "targetConsumerRef" ] }, "erp-pos-PosPaymentOrder": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "documentLineRef": { "$ref": "#/components/schemas/erp-document-DocumentLineRef" }, "amount": { "type": "number", "description": "Betrag der Zahlung" }, "currency": { "type": "string", "description": "Währung (ISO Alpha-3)" }, "paymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentBackendRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "externalPaymentId": { "type": "string", "description": "Externe Payment-ID vom Backend", "maxLength": 255, "minLength": 0 }, "externalPaymentStatus": { "type": "string", "description": "Status der externen Zahlung", "enum": [ "PENDING", "PROCESSING", "SUCCESSFUL", "CANCELLED", "REJECTED" ] }, "externalPaymentErrorMessage": { "type": "string", "description": "Fehlermeldung vom Payment-Backend", "maxLength": 1000, "minLength": 0 }, "paymentOperation": { "type": "string", "description": "Art der Zahlungsoperation", "enum": [ "PAYMENT", "CANCEL", "REFUND" ] }, "cancelledExternalPaymentId": { "type": "string", "description": "Externe Payment-ID der zu stornierenden Zahlung", "maxLength": 255, "minLength": 0 }, "posRegisterRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "paymentConsumerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "ruleResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "amount" ] }, "erp-pos-PosPaymentMethod": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung", "minLength": 1 }, "active": { "type": "boolean", "default": true, "description": "Aktiv?" }, "type": { "type": "string", "description": "Typ der Kassenzahlungsart", "enum": [ "CASH", "CARD" ] }, "paymentBackend": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "countingRequired": { "type": "boolean", "description": "Zählpflicht?" }, "balanceManaged": { "type": "boolean", "description": "Bestandsgeführt" }, "withdrawalMode": { "type": "string", "description": "Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss", "enum": [ "FULL", "BALANCE", "MANUAL", "NONE" ] }, "withdrawalBalance": { "type": "number", "description": "Restbetrag, der bei Entnahme im Modus BALANCE in der Kasse verbleibt" }, "negativeBalanceBehaviour": { "type": "string", "default": "ALWAYS_DENY", "description": "Verhalten einer Kassenzahlungsart, wenn ihr Bestand negativ werden würde", "enum": [ "ALWAYS_DENY", "ALWAYS_ALLOW", "ALLOW_AFTER_CONFIRMATION" ] } }, "required": [ "description", "label" ] }, "erp-pos-PosPaymentConsumer": { "description": "POS-Payment-Consumer", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 1000, "minLength": 0 }, "pushMode": { "type": "string", "description": "Push-Modus für POS-Payment-Consumer", "enum": [ "NONE", "LOCAL_EVENT", "WEBSOCKET", "WEBHOOK" ] }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "ruleValue": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "lastSeenAt": { "type": "string", "format": "date-time", "description": "Zeitpunkt des letzten Heartbeats", "readOnly": true } }, "required": [ "label", "pushMode" ] }, "erp-pos-PosPaymentBackend": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Label", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "appId": { "type": "string", "description": "App-ID", "maxLength": 255, "minLength": 0 }, "type": { "type": "string", "description": "Typ", "enum": [ "SELF", "APP" ] }, "placePayment": { "type": "boolean", "default": false, "description": "Zahlung platzieren" }, "canCancel": { "type": "boolean", "default": false, "description": "Stornierbar" }, "canRefund": { "type": "boolean", "default": false, "description": "Erstattungsfähig" } }, "required": [ "label", "type" ] }, "erp-finance-FinanceBookingBackend": { "description": "Finanzbuchhaltung Backend", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "appId": { "type": "string", "description": "App-ID", "maxLength": 255, "minLength": 0 }, "usePerformanceDate": { "type": "boolean", "description": "Leistungsdatum beachten" }, "useValueDateForBankTransaction": { "type": "boolean", "description": "Valutadatum bei Banktransaktionen beachten" }, "descriptionOutgoingDocuments": { "type": "string", "description": "Buchungstext Ausgangsbelege", "maxLength": 255, "minLength": 0 }, "descriptionIncomingDocuments": { "type": "string", "description": "Buchungstext Eingangsbelege", "maxLength": 255, "minLength": 0 }, "descriptionPosReceipts": { "type": "string", "description": "Buchungstext Kassenquittungen", "maxLength": 255, "minLength": 0 }, "descriptionPosBalances": { "type": "string", "description": "Buchungstext Kassendifferenzen", "maxLength": 255, "minLength": 0 }, "descriptionPosDepositExpense": { "type": "string", "description": "Buchungstext Kasseneinlagen/ausgaben", "maxLength": 255, "minLength": 0 }, "descriptionPosPayment": { "type": "string", "description": "Buchungstext Kassenzahlung Bar/Karte", "maxLength": 255, "minLength": 0 }, "descriptionCommissionSettlements": { "type": "string", "description": "Buchungstext Eingangsbelege (Provisionen)", "maxLength": 255, "minLength": 0 }, "descriptionPayments": { "type": "string", "description": "Buchungstext Zahlungen", "maxLength": 255, "minLength": 0 }, "descriptionDunnings": { "type": "string", "description": "Buchungstext Mahnungen", "maxLength": 255, "minLength": 0 } }, "required": [ "label" ] }, "erp-delivery-DeliveryMethod": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "description", "minLength": 1 }, "printDescription": { "type": "string", "description": "printDescription" }, "deliveryTime": { "type": "integer", "format": "int32", "description": "Versanddauer in Tagen" }, "vdsCarrierId": { "type": "integer", "format": "int64", "description": "Versand-Anbieter" }, "defaultWeightUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "defaultSizeUnit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "splitIntoNewDocument": { "type": "boolean", "default": false, "description": "Soll eine Position mit dieser Liefermethode in einen Lieferbeleg mit dieser Methode übernommen werden" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "minWeightPerParcel": { "type": "number", "description": "Min. Gewicht pro Paket" }, "identifier": { "type": "string", "description": "Barcode" }, "maxWeightPerParcel": { "type": "number", "description": "Max. Gewicht pro Paket" }, "parcelWeightSource": { "type": "string", "default": "AUTOMATIC_VIA_DOCUMENT_LINE", "description": "Woher soll das Gewicht der Pakete bezogen werden", "enum": [ "AUTOMATIC_VIA_DOCUMENT_LINE", "MANUAL_RECORDING" ] }, "forwardEmailToShipper": { "type": "boolean", "default": false, "description": "E-Mail an Versender übergeben" }, "forwardPhoneToShipper": { "type": "boolean", "default": false, "description": "Telefon an Versender übergeben" }, "validCountryCodes": { "type": "array", "description": "Gültige Ländercodes", "items": { "type": "string", "description": "Gültige Ländercodes" } }, "translations": { "type": "array", "description": "translations", "items": { "$ref": "#/components/schemas/erp-document-DocumentTypeTerm" } } }, "required": [ "description", "label", "parcelWeightSource" ] }, "erp-crm-CrmReminder": { "description": "CRM Erinnerungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "crmId": { "type": "integer", "format": "int64", "description": "ID des CRM Objekts" }, "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "remindAt": { "type": "string", "format": "date-time", "description": "Erinnerungszeitpunkt" }, "note": { "type": "string", "description": "Notiz zur Erinnerung" }, "critical": { "type": "boolean", "description": "Kritische Erinnerung?" } }, "required": [ "crmId", "remindAt", "userRef" ] }, "erp-crm-CrmChecklistItem": { "description": "Element einer Checkliste im CRM", "properties": { "version": { "type": "string", "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", "default": false, "description": "Ist das Element \"angehakt\"?" } } }, "erp-crm-CrmReference": { "description": "Referenzen zu CRM-Objekten", "properties": { "referenceType": { "type": "string", "description": "Mögliche Typen von Referenzen zu CRM-Objekten", "enum": [ "ARTICLE", "DOCUMENT_LINE", "OPEN_ITEM", "ASSET" ] }, "reference": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "required": [ "reference", "referenceType" ] }, "erp-crm-CrmTask": { "description": "CRM Aufgaben", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "typeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "stateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priorityRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "number": { "type": "string", "description": "Aufgaben-Nummer", "readOnly": true }, "description": { "type": "string", "description": "Notiz/Beschreibung" }, "notes": { "type": "string", "description": "Notizen" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "parentRefs": { "type": "array", "description": "Übergeordnete CRM-Objekte", "items": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } }, "childRefs": { "type": "array", "description": "Untergeordnete CRM-Objekt", "items": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } }, "tags": { "type": "array", "description": "Tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "salesDocumentRefs": { "type": "array", "description": "Verkaufsbelege", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } }, "contractRefs": { "type": "array", "description": "Vertrag", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } }, "observerRefs": { "type": "array", "description": "Beobachter", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "processedByWorkflow": { "type": "boolean", "description": "In Workflow-Verarbeitung?", "readOnly": true }, "assignedUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "assignedGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "assignedParticipantRef": { "$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" }, "mainResponsibleParticipantRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "label": { "type": "string", "description": "Aufgabentitel", "minLength": 1 }, "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", "format": "date-time", "description": "Zu erledigen " }, "toBeDoneStartingFrom": { "type": "string", "format": "date-time", "description": "Zu erledigen ab" }, "reminders": { "type": "array", "description": "Liste von Erinnerungen", "items": { "$ref": "#/components/schemas/erp-crm-CrmReminder" } }, "effortEstimation": { "type": "integer", "format": "int32", "description": "Aufwandsschätzung in Sekunden" }, "effortCommissioned": { "type": "integer", "format": "int32", "description": "Beauftragte Zeit in Sekunden" }, "internalRecordedTimes": { "type": "integer", "format": "int32", "description": "Erfasste Zeiten in Sekunden (intern)", "readOnly": true }, "externalRecordedTimes": { "type": "integer", "format": "int32", "description": "Erfasste Zeiten in Sekunden (extern)", "readOnly": true }, "internalBilledTimes": { "type": "integer", "format": "int32", "description": "Abgerechnete Zeiten in Sekunden (intern)", "readOnly": true }, "externalBilledTimes": { "type": "integer", "format": "int32", "description": "Abgerechnete Zeiten in Sekunden (extern)", "readOnly": true }, "progress": { "type": "integer", "format": "int32", "description": "Fortschritt in Prozent", "maximum": 100, "minimum": 0 }, "publish": { "type": "boolean", "description": "Soll die Aufgabe veröffentlicht werden?" }, "billingRule": { "type": "string", "default": "ONLY_COMPLETE", "description": "Abrechnungsregel", "enum": [ "ONLY_COMPLETE", "ONLY_BILL_WITH_PARENT_TASK", "ALLOW_ACTIVITIES_INDIVIDUALLY" ] }, "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" }, "kanbanSortOrder": { "type": "integer", "format": "int32", "description": "Kanban-Sortierreihenfolge" }, "additionalParticipantsOfCustomer": { "type": "array", "description": "Weitere Teilnehmer vom Auftraggeber", "items": { "$ref": "#/components/schemas/erp-crm-CrmTaskParticipant" } }, "additionalParticipantsOfContractor": { "type": "array", "description": "Weitere Teilnehmer vom Auftragnehmer", "items": { "$ref": "#/components/schemas/erp-crm-CrmTaskParticipant" } } }, "required": [ "billingRule", "billingType", "label", "priorityRef", "typeRef" ] }, "erp-crm-CrmTaskParticipant": { "description": "Teilnehmer/Ansprechpartner in einer Aufgabe", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "accountPersonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "vote": { "type": "boolean", "description": "Abstimmung" }, "voteComment": { "type": "string", "description": "Kommentar zur Abstimmung" }, "observer": { "type": "boolean", "default": false, "description": "Beobachter" } }, "required": [ "accountPersonRef" ] }, "erp-crm-CrmTaskCreateOrUpdateRequest": { "description": "Request zur Erstellung oder Aktualisierung einer Aufgabe", "properties": { "toCreateOrUpdate": { "$ref": "#/components/schemas/erp-crm-CrmTask" }, "parameters": { "type": "array", "description": "Zusätzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-crm-CrmUpdateParentRequest": { "description": "Request zur Aktualisierung der CRM-Parents", "properties": { "parents": { "type": "array", "description": "Die übergeordneten Objekte", "items": { "$ref": "#/components/schemas/erp-crm-CrmUpdateParentRequest.Parent" } } }, "required": [ "parents" ] }, "erp-crm-CrmUpdateParentRequest.Parent": { "description": "Ein übergeordnetes Objekt", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID" }, "type": { "type": "string", "description": "Möglich CRM-Typen", "enum": [ "TASK", "DEAL", "PROJECT" ] } }, "required": [ "id", "type" ] }, "erp-crm-CrmUpdateChildrenRequest": { "description": "Request zur Aktualisierung der CRM-Children", "properties": { "children": { "type": "array", "description": "Die abhängigen Objekte", "items": { "$ref": "#/components/schemas/erp-crm-CrmUpdateChildrenRequest.Child" } } }, "required": [ "children" ] }, "erp-crm-CrmUpdateChildrenRequest.Child": { "description": "Ein abhängiges Objekt", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID" }, "type": { "type": "string", "description": "Möglich CRM-Typen", "enum": [ "TASK", "DEAL", "PROJECT" ] } }, "required": [ "id", "type" ] }, "erp-crm-CrmParticipant": { "description": "Teilnehmer/Ansprechpartner in einem CRM-Objekt", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "accountPersonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 } }, "required": [ "accountPersonRef" ] }, "erp-crm-CrmProject": { "description": "CRM Projekte", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "typeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "stateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priorityRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "number": { "type": "string", "description": "Aufgaben-Nummer", "readOnly": true }, "description": { "type": "string", "description": "Notiz/Beschreibung" }, "notes": { "type": "string", "description": "Notizen" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "parentRefs": { "type": "array", "description": "Übergeordnete CRM-Objekte", "items": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } }, "childRefs": { "type": "array", "description": "Untergeordnete CRM-Objekt", "items": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } }, "tags": { "type": "array", "description": "Tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "salesDocumentRefs": { "type": "array", "description": "Verkaufsbelege", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } }, "contractRefs": { "type": "array", "description": "Vertrag", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } }, "observerRefs": { "type": "array", "description": "Beobachter", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "processedByWorkflow": { "type": "boolean", "description": "In Workflow-Verarbeitung?", "readOnly": true }, "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", "format": "int32", "description": "Gesamt Aufwandsschätzung in Sekunden" }, "effortCommissioned": { "type": "integer", "format": "int32", "description": "Gesamt beauftragte Zeit in Sekunden" }, "plannedProjectPeriodFrom": { "type": "string", "format": "date", "description": "Geplanter Projektzeitraum (von)" }, "plannedProjectPeriodTo": { "type": "string", "format": "date", "description": "Geplanter Projektzeitraum (bis)" }, "actualProjectPeriodFrom": { "type": "string", "format": "date", "description": "Tatsächlicher Projektzeitraum (von)" }, "actualProjectPeriodTo": { "type": "string", "format": "date", "description": "Tatsächlicher Projektzeitraum (bis)" }, "contractConclusionDate": { "type": "string", "format": "date", "description": "Datum Vertragsabschluss" }, "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", "format": "int32", "description": "Erfasste Zeiten in Sekunden", "readOnly": true }, "billedTimes": { "type": "integer", "format": "int32", "description": "Abgerechnete Zeiten in Sekunden", "readOnly": true }, "additionalParticipantsOfCustomer": { "type": "array", "description": "Weitere Teilnehmer vom Auftraggeber", "items": { "$ref": "#/components/schemas/erp-crm-CrmParticipant" } }, "additionalParticipantsOfContractor": { "type": "array", "description": "Weitere Teilnehmer vom Auftragnehmer", "items": { "$ref": "#/components/schemas/erp-crm-CrmParticipant" } } }, "required": [ "priorityRef", "typeRef" ] }, "erp-crm-CrmProjectCreateOrUpdateRequest": { "description": "Request zur Erstellung oder Aktualisierung eines Projekts", "properties": { "toCreateOrUpdate": { "$ref": "#/components/schemas/erp-crm-CrmProject" }, "parameters": { "type": "array", "description": "Zusätzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-crm-CrmDeal": { "description": "CRM Deals", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "typeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "stateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "priorityRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "number": { "type": "string", "description": "Aufgaben-Nummer", "readOnly": true }, "description": { "type": "string", "description": "Notiz/Beschreibung" }, "notes": { "type": "string", "description": "Notizen" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "parentRefs": { "type": "array", "description": "Übergeordnete CRM-Objekte", "items": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } }, "childRefs": { "type": "array", "description": "Untergeordnete CRM-Objekt", "items": { "$ref": "#/components/schemas/erp-crm-CrmObjectRef" } }, "tags": { "type": "array", "description": "Tags", "items": { "$ref": "#/components/schemas/common-tag-TagDto" } }, "salesDocumentRefs": { "type": "array", "description": "Verkaufsbelege", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } }, "contractRefs": { "type": "array", "description": "Vertrag", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" } }, "observerRefs": { "type": "array", "description": "Beobachter", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "processedByWorkflow": { "type": "boolean", "description": "In Workflow-Verarbeitung?", "readOnly": true }, "assignedUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "assignedGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "assignedByUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "mainResponsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesAgentAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "mainResponsibleGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "label": { "type": "string", "description": "Aufgabentitel" }, "customField": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "responsibleCustomerPersonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "topicRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "plannedClosingDate": { "type": "string", "format": "date", "description": "Geplantes Abschluss-Datum" }, "plannedPerformanceDate": { "type": "string", "format": "date", "description": "Geplantes Leistungs-Datum" }, "plannedInvestmentSum": { "type": "number", "description": "Geplante Investitionssumme" }, "chance": { "type": "integer", "format": "int32", "description": "Chance (in Prozent)", "maximum": 100, "minimum": 0 }, "healthRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "nextPlannedContactDate": { "type": "string", "format": "date-time", "description": "Nächster geplanter Kontakt" }, "closingType": { "type": "string", "description": "Art des Abschluß eines Deals", "enum": [ "POSITIVE", "NEGATIVE" ] }, "closingReasonRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "detailedClosingReason": { "type": "string", "description": "Freier/Detaillierter Abschlußgrund" }, "additionalParticipantsOfCustomer": { "type": "array", "description": "Weitere Teilnehmer vom Auftraggeber", "items": { "$ref": "#/components/schemas/erp-crm-CrmParticipant" } }, "additionalParticipantsOfContractor": { "type": "array", "description": "Weitere Teilnehmer vom Auftragnehmer", "items": { "$ref": "#/components/schemas/erp-crm-CrmParticipant" } } }, "required": [ "priorityRef", "topicRef", "typeRef" ] }, "erp-crm-CrmDealCreateOrUpdateRequest": { "description": "Request zur Erstellung oder Aktualisierung eines Deals", "properties": { "toCreateOrUpdate": { "$ref": "#/components/schemas/erp-crm-CrmDeal" }, "parameters": { "type": "array", "description": "Zusätzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-account-SEPAMandate": { "properties": { "version": { "type": "string", "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": { "type": "string", "description": "note to identify the mandate", "maxLength": 255, "minLength": 0 }, "lastUsed": { "type": "string", "format": "date", "description": "last date client-signature was used" }, "clientSignatureFrom": { "type": "string", "format": "date", "description": "date of client-signature (mandatsreferenz)" }, "clientSignatureId": { "type": "string", "description": "id of client-signature (mandatsreferenz)", "maxLength": 255, "minLength": 0 }, "firstDebitDone": { "type": "boolean", "description": "Ist die Erstlastschrift bereits erfolgt?" } } }, "erp-account-AccountBankdetail": { "properties": { "version": { "type": "string", "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": { "type": "string", "description": "IBAN", "maxLength": 255, "minLength": 0 }, "bic": { "type": "string", "description": "BIC", "maxLength": 255, "minLength": 0 }, "accountFrom": { "type": "string", "description": "account from, if differs from account-address", "maxLength": 255, "minLength": 0 }, "bankName": { "type": "string", "description": "name of the bank", "maxLength": 255, "minLength": 0 }, "bankCity": { "type": "string", "description": "city of the bank", "maxLength": 255, "minLength": 0 }, "bankPostCode": { "type": "string", "description": "post-code of the bank", "maxLength": 255, "minLength": 0 }, "originType": { "type": "string", "default": "FRONTEND", "description": "origin type", "enum": [ "FRONTEND", "IMPORT" ] }, "originInfo": { "type": "string", "description": "origin info", "maxLength": 255, "minLength": 0 }, "defaultBank": { "type": "boolean", "default": true, "description": "Is default bank?" }, "mainBankAccountType": { "type": "string", "description": "Hauptbankverbindung für", "enum": [ "DOMESTIC", "EUROPEAN_COMMUNITY", "INTERNATIONAL" ] }, "active": { "type": "boolean", "default": true, "description": "Is active?", "readOnly": true } }, "required": [ "defaultBank", "iban", "originType" ] }, "erp-account-AccountSalutation": { "properties": { "version": { "type": "string", "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", "default": true, "description": "active", "readOnly": true } }, "required": [ "label" ] }, "common-api-LogEntry": { "properties": { "logTime": { "type": "string", "format": "date-time", "description": "Log-Time" }, "loggerName": { "type": "string", "description": "Logger Name", "minLength": 1 }, "userRef": { "type": "string", "description": "User Reference" }, "level": { "type": "string", "description": "log level", "enum": [ "DEBUG", "INFO", "WARNING", "ERROR", "CONSOLE", "STACKTRACE" ] }, "requestId": { "type": "string", "description": "request identifier" }, "message": { "type": "string", "description": "message" }, "messageThrowable": { "type": "string", "description": "messageThrowable" }, "messageParameter": { "type": "object", "additionalProperties": { "type": "object", "description": "list of parameters to fill a formattable message" }, "description": "list of parameters to fill a formattable message" } }, "required": [ "loggerName" ] }, "common-api-LogEntryGet": { "properties": { "logTime": { "type": "string", "format": "date-time", "description": "Log-Time" }, "loggerName": { "type": "string", "description": "Logger Name", "minLength": 1 }, "userRef": { "type": "string", "description": "User Reference" }, "level": { "type": "string", "description": "log level", "enum": [ "DEBUG", "INFO", "WARNING", "ERROR", "CONSOLE", "STACKTRACE" ] }, "requestId": { "type": "string", "description": "request identifier" }, "message": { "type": "string", "description": "message" }, "messageThrowable": { "type": "string", "description": "messageThrowable" }, "messageParameter": { "type": "object", "additionalProperties": { "type": "object", "description": "list of parameters to fill a formattable message" }, "description": "list of parameters to fill a formattable message" }, "id": { "type": "integer", "format": "int64", "description": "id", "readOnly": true }, "messageTopic": { "type": "string", "description": "topic of message entry", "readOnly": true } }, "required": [ "loggerName" ] }, "common-api-AppScriptingProxy": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "appIdentifier": { "type": "string", "format": "uuid", "description": "Identifier der App" }, "triggerId": { "type": "string", "description": "Trigger zur Ausführung des Skripts", "maxLength": 255, "minLength": 0 }, "script": { "type": "string", "description": "Das auszuführende Skript (wenn scriptModuleRef nicht gesetzt ist)", "maxLength": 2147483647, "minLength": 0 }, "scriptModuleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "required": [ "appIdentifier", "triggerId" ] }, "common-api-AppMessageEntry": { "properties": { "event": { "type": "string", "description": "Event/Nachricht", "minLength": 1 }, "eventTopic": { "type": "string", "description": "Event/Nachricht -Topic/Headline-" }, "destinationOwner": { "type": "string", "description": "owner (optional)" }, "destinationQueue": { "type": "string", "description": "queue", "minLength": 1 }, "userRef": { "type": "string", "description": "User-ID" } }, "required": [ "destinationQueue", "event" ] }, "common-api-AppMessageEntryGet": { "properties": { "event": { "type": "string", "description": "Event/Nachricht", "minLength": 1 }, "eventTopic": { "type": "string", "description": "Event/Nachricht -Topic/Headline-" }, "destinationOwner": { "type": "string", "description": "owner (optional)" }, "destinationQueue": { "type": "string", "description": "queue", "minLength": 1 }, "userRef": { "type": "string", "description": "User-ID" }, "id": { "type": "integer", "format": "int64", "description": "id", "readOnly": true }, "recipients": { "type": "array", "description": "recipients", "items": { "$ref": "#/components/schemas/common-api-AppMessageEntryRecipient" }, "readOnly": true, "uniqueItems": true } }, "required": [ "destinationQueue", "event" ] }, "common-api-AppMessageEntryRecipient": { "description": "recipients", "properties": { "response": { "type": "string", "description": "Antwort, falls vorhanden", "readOnly": true }, "state": { "type": "string", "description": "Status der Nachricht", "enum": [ "QUEUED", "SENT", "FAILED", "ERRONEOUS", "INACTIVE" ], "readOnly": true }, "sentTimestamp": { "type": "string", "format": "date-time", "description": "Zeitpunkt, wann die Nachricht versendet wurde", "readOnly": true }, "sentAttempts": { "type": "integer", "format": "int32", "description": "Anzahl der Sendeversuche", "readOnly": true }, "webhook": { "$ref": "#/components/schemas/common-api-AppMessageWebhookGet" } } }, "common-api-AppMessageWebhookGet": { "description": "Webhook", "properties": { "url": { "type": "string", "description": "url des webhooks. üblicherweise http(s)://host:port/etc", "minLength": 1 }, "destinationOwner": { "type": "string", "description": "owner (optional)" }, "destinationQueue": { "type": "string", "description": "queue", "minLength": 1 }, "appIdentifier": { "type": "string", "format": "uuid", "description": "appIdentifier (registrar)" }, "id": { "type": "integer", "format": "int64", "description": "id", "readOnly": true } }, "required": [ "destinationQueue", "url" ] }, "common-system-SecretData": { "description": "Daten dieses Secrets", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "key": { "type": "string", "description": "Schlüssel einer Secret-Data" }, "value": { "type": "string", "description": "Wert einer Secret-Data" } } }, "common-system-SecretStorage": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "name": { "type": "string", "description": "Eindeutiger Name des Secrets" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/common-system-SecretData" } } } }, "common-api-OutputConsumer": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "integer", "format": "int64", "description": "id", "readOnly": true }, "label": { "type": "string", "description": "label of the print server", "maxLength": 255, "minLength": 0 }, "outputTypes": { "type": "array", "description": "Output-Types die dieser Consumer unterstützt", "items": { "$ref": "#/components/schemas/core-api-ApiCreatableReference" } }, "description": { "type": "string", "description": "description of the print server", "maxLength": 2048, "minLength": 0 }, "pushMode": { "type": "string", "description": "push mode for this consumer", "enum": [ "NONE", "LOCAL_EVENT", "WEBSOCKET", "WEBHOOK" ] }, "systemPresetting": { "type": "boolean", "default": false, "description": "system einstellung", "readOnly": true }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "lastSeenAt": { "type": "string", "format": "date-time", "description": "last seen at", "readOnly": true }, "ruleValue": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "appIdentifier": { "type": "string", "format": "uuid", "description": "App-Identifier" } }, "required": [ "label", "outputTypes", "pushMode" ] }, "common-api-OutputConsumerRule": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "moduleRef": { "$ref": "#/components/schemas/common-output-OutputModuleRef" }, "outputModuleRule": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "sourceOutputTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetOutputTypeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "sourceReportGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetReportGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetOutputConsumerRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "targetOutputConsumerResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "outputQuantity": { "type": "integer", "format": "int32", "description": "Anzahl der Ausgabe", "minimum": 1 }, "priority": { "type": "integer", "format": "int32", "description": "Optionale Priorität für die Regelauswahl bei OUTPUT_TYPE_SYSTEM." }, "systemPresetting": { "type": "boolean", "description": "handelt es sich um den systemreport. Bei diesem darf die selektion nicht verändert werden", "readOnly": true }, "additionalOptions": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-api-TextEnum": { "properties": { "label": { "type": "string", "description": "Wert der Aufzählung", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "active", "readOnly": true }, "visible": { "type": "boolean", "default": true, "description": "Sichtbar" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-api-TextEnumGet": { "properties": { "label": { "type": "string", "description": "Wert der Aufzählung", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "active", "readOnly": true }, "visible": { "type": "boolean", "default": true, "description": "Sichtbar" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "id": { "type": "integer", "format": "int64", "description": "PrimaryKey", "readOnly": true }, "groupKey": { "type": "string", "description": "Gruppe der Text-Aufzählung", "maxLength": 255, "minLength": 0, "readOnly": true }, "systemPresetting": { "type": "boolean", "description": "System-Vorgabe", "readOnly": true } } }, "common-api-TextEnumGroup": { "properties": { "label": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "key": { "type": "string", "description": "eindeutiger Key der Gruppe", "maxLength": 255, "minLength": 0 }, "autoAppend": { "type": "boolean", "default": false, "description": "automatisches erweitern der Liste aktiv" }, "appendVisible": { "type": "boolean", "default": true, "description": "Neue Werte sichtbar anlegen" } } }, "common-api-TextEnumGroupGet": { "properties": { "label": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "key": { "type": "string", "description": "eindeutiger Key der Gruppe", "maxLength": 255, "minLength": 0 }, "autoAppend": { "type": "boolean", "default": false, "description": "automatisches erweitern der Liste aktiv" }, "appendVisible": { "type": "boolean", "default": true, "description": "Neue Werte sichtbar anlegen" }, "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ören", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true } } }, "common-eav-EavAttribute": { "description": "attribute list", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "attribute description" }, "position": { "type": "integer", "format": "int32", "description": "position/reihenfolge des attributes (0 based)", "readOnly": true }, "type": { "type": "string", "description": "attribute type", "enum": [ "BOOLEAN", "INTEGER", "TEXT", "DATE", "DATE_TIME", "JSON", "URL", "OBJECT", "ARRAY", "CURRENCY", "DECIMAL", "MEMO", "SELECT_SINGLE", "SELECT_MULTI", "VARIANT_ATTRIBUTE" ] }, "textGroupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "variantAttributeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "viewMode": { "type": "string", "description": "darstellungsmodus im view", "enum": [ "EDITABLE", "READ_ONLY", "NOT_VISIBLE" ] }, "active": { "type": "boolean", "default": true, "description": "ist das feld aktiv (ACHTUNG: deaktivieren verschiebt daten in den verbundenen Tabellen)" }, "fulltextField": { "type": "boolean", "default": false, "description": "context is full-text-searchable" }, "searchIndex": { "type": "boolean", "default": false, "description": "soll ein suchindex (e.g. für cunit) angelegt werden" }, "appIdentifier": { "type": "string", "format": "uuid", "description": "appIdentifier" }, "nestedAttributes": { "type": "array", "description": "Verschachtelte Attribute (nur für Typ OBJECT/ARRAY)", "items": { "$ref": "#/components/schemas/common-eav-EavAttribute" } } }, "required": [ "label", "type" ] }, "common-eav-EavGroup": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "group description", "minLength": 1 }, "attributes": { "type": "array", "description": "attribute list", "items": { "$ref": "#/components/schemas/common-eav-EavAttribute" }, "minItems": 1 }, "uiSettings": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "entities": { "type": "array", "description": "zugeordnet zu folgenden entities", "items": { "type": "string", "description": "zugeordnet zu folgenden entities" }, "minItems": 1 }, "appIdentifier": { "type": "string", "format": "uuid", "description": "appIdentifier" } }, "required": [ "attributes", "description", "entities", "label" ] }, "common-workflow-Workflow": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung des Workflows" }, "trigger": { "type": "string", "description": "Wann wird dieser Workflow ausgelöst?" }, "subWorkflow": { "type": "boolean", "default": false, "description": "Handelt es sich um einen Unter-Workflow?" }, "state": { "type": "string", "default": "DRAFT", "description": "Status des Workflows", "enum": [ "DRAFT", "INACTIVE", "ACTIVE" ], "readOnly": true }, "synchronous": { "type": "boolean", "description": "Synchroner Workflow?", "readOnly": true }, "successorRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "predecessorRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "required": [ "name", "subWorkflow" ] }, "common-workflow-ChoiceOption": { "description": "Vorgegebene Antwortmöglichkeiten, oder leer, falls offene Frage", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung der Auswahl" }, "value": { "type": "string", "description": "Wert für die Auswahloption (Text)", "minLength": 1 }, "followUpUserDecision": { "$ref": "#/components/schemas/common-workflow-UserDecision" }, "defaultValue": { "type": "boolean" } }, "required": [ "value" ] }, "common-workflow-UserDecision": { "description": "Listen für Auswahloptionen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "workItemId": { "type": "integer", "format": "int64", "description": "ID des Work-Items, zu dem die Benutzerentscheidung gehört", "readOnly": true }, "resultName": { "type": "string", "description": "Name unter dem das Ergebnis abgerufen werden kann", "minLength": 1 }, "prompt": { "type": "string", "description": "Textbeschreibung der Auswahl-Liste / Eingabeaufforderung", "minLength": 1 }, "valueType": { "type": "string", "description": "Typ der Listen-Elemente", "minLength": 1 }, "choiceOptions": { "type": "array", "description": "Vorgegebene Antwortmöglichkeiten, oder leer, falls offene Frage", "items": { "$ref": "#/components/schemas/common-workflow-ChoiceOption" } }, "searchDialog": { "type": "string", "description": "Suchdialog zur Suche des Werts (statt den Auswahlmöglichkeiten)" }, "trySynchronous": { "type": "boolean", "default": false, "description": "Soll versucht werden, die Benutzerentscheidung synchron abzufragen?" }, "multipleChoiceAllowed": { "type": "boolean" } }, "required": [ "prompt", "resultName", "valueType" ] }, "common-workflow-WorkflowElement": { "properties": { "version": { "type": "string", "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" }, "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ührt werden soll" }, "scriptModuleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "parameters": { "type": "array", "description": "Parameter welche vor der Ausführung von einem Element geladen werden sollen", "items": { "$ref": "#/components/schemas/common-workflow-WorkflowElementParameter" } }, "sequelElementRefs": { "type": "array", "description": "Folge-Elemente", "items": { "$ref": "#/components/schemas/common-workflow-WorkflowSequelElementRef" }, "readOnly": true }, "uiData": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "intermediateEventIdentifiers": { "type": "array", "description": "Für INTERMEDIATE_EVENT: wodurch wird dieses Event getriggert?", "items": { "type": "string", "description": "Für INTERMEDIATE_EVENT: wodurch wird dieses Event getriggert?" } }, "triggerSingleInstance": { "type": "boolean", "default": true, "description": "Für INTERMEDIATE_EVENT: kann nur in der definierten Instanz getriggert werden" }, "guardingIntervalInSeconds": { "type": "integer", "format": "int32", "description": "Für INTERMEDIATE_EVENT: definiert ein Abfrage-Intervall, zu dem das Intermediate-Event überprüft wird, ob eine Ausführung des Skripts möglich ist. Nur in Verbindung mit delayInSeconds" }, "possibleSplitResults": { "type": "array", "description": "Mögliche Ergebnisse/Ausgänge beim Split", "items": { "type": "string", "description": "Mögliche Ergebnisse/Ausgänge beim Split" } }, "timeoutAfterSeconds": { "type": "integer", "format": "int64", "description": "Verzögerung von Timern" }, "responsibleUserRefs": { "type": "array", "description": "Nutzer, die diesen UserTask bearbeiten können", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "responsibleUserGroupRefs": { "type": "array", "description": "Nutzergruppen, die diesen UserTask bearbeiten können", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "userDecisions": { "type": "array", "description": "Listen für Auswahloptionen", "items": { "$ref": "#/components/schemas/common-workflow-UserDecision" } }, "responsibleUserIsExecutingUser": { "type": "boolean", "default": false, "description": "Der ausführende Benutzer ist auch der verantwortliche Benutzer" }, "subWorkflowRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "common-workflow-WorkflowElementParameter": { "description": "Parameter zu einem Workflow-Element", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "name": { "type": "string", "description": "Name des Parameters", "maxLength": 255, "minLength": 0 }, "requiredValueType": { "type": "string", "description": "Typ des Parameters, falls er z.B. durch ein Skript-Modul vorgegeben wurde", "maxLength": 255, "minLength": 0, "readOnly": true }, "fixedValue": { "type": "string", "description": "Fester Wert (nur in Kombination mit fixedValueType)", "maxLength": 255, "minLength": 0 }, "fixedValueType": { "type": "string", "description": "Datentyp vom festen Wert (nur in Kombination mit fixedValue)", "maxLength": 255, "minLength": 0 }, "queryPresetRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "attributePath": { "type": "string", "description": "Pfad zu einem Attribut innerhalb der Query aus queryPresetRef" } }, "required": [ "name" ] }, "common-workflow-WorkflowSequelElementRef": { "description": "Folge-Elemente", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID" }, "name": { "type": "string", "description": "Name", "readOnly": true }, "description": { "type": "string", "description": "Beschreibung", "readOnly": true }, "executeOnSplitResult": { "type": "string", "description": "Wann wird dieses Element ausgeführt?" } } }, "common-workflow-WorkflowChangeNameAndDescriptionRequest": { "properties": { "name": { "type": "string", "description": "der neue Name für den Workflow", "minLength": 1 }, "description": { "type": "string", "description": "die neue Beschreibung des Worklflows" } }, "required": [ "name" ] }, "common-variant-VariantSchema": { "description": "Variantenschema", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "attributeRefs": { "type": "array", "description": "Zugeordnete Attribute", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "minItems": 1 }, "eligibleValueRefs": { "type": "array", "description": "Wählbare Werte", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true } }, "required": [ "attributeRefs", "label" ] }, "common-variant-VariantAttribute": { "description": "Variantenattribut", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "identifier": { "type": "string", "description": "Eindeutiger Identifier", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "labels": { "type": "array", "description": "Bezeichnung (mehrsprachig)", "items": { "$ref": "#/components/schemas/common-variant-VariantDescription" }, "minItems": 1 } }, "required": [ "identifier", "labels" ] }, "common-variant-VariantDescription": { "description": "Variantenbeschreibung (mehrsprachig)", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "languageCode": { "type": "string", "description": "Sprache", "minLength": 1 } }, "required": [ "label", "languageCode" ] }, "common-variant-VariantValue": { "description": "Variantenwert", "properties": { "version": { "type": "string", "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" }, "sortOrder": { "type": "integer", "format": "int64", "description": "Sortierung" }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "abbreviation": { "type": "string", "description": "Abkürzung", "minLength": 1 }, "unitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "labels": { "type": "array", "description": "Mehrsprachige Bezeichnungen", "items": { "$ref": "#/components/schemas/common-variant-VariantDescription" }, "minItems": 1 } }, "required": [ "abbreviation", "labels" ] }, "common-output-OutputSignature": { "properties": { "version": { "type": "string", "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" } }, "required": [ "contentType" ] }, "common-user-UserSubscriptionFavorite": { "properties": { "version": { "type": "string", "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" } } }, "required": [ "eventTypes", "refKey" ] }, "common-user-UserOutputFavorite": { "properties": { "version": { "type": "string", "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" }, "outputQuantity": { "type": "integer", "format": "int32", "description": "Anzahl der Ausgaben", "minimum": 1 }, "targetOutputConsumerResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "moduleRef", "userRef" ] }, "common-user-User": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "Is the user active?", "readOnly": 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", "default": false, "description": "Is owner user?", "readOnly": true }, "emailVerified": { "type": "boolean", "default": false, "description": "is the email verified", "readOnly": true }, "validTo": { "type": "string", "format": "date-time", "description": "Valid to" }, "type": { "type": "string", "description": "User type", "enum": [ "REGULAR", "SUPPORT", "SYSTEM", "LIMITED_WMS", "LIMITED_POS", "LIMITED_DASHBOARD", "LIMITED_AGENT", "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", "format": "uuid", "description": "App-Identifier", "readOnly": true }, "referencedCustomerUserId": { "type": "integer", "format": "int64", "description": "Referenzierte Kundenbenutzer ID (CustomerUserEntity.id aus vab-manager)", "readOnly": true } } }, "common-user-UserPermission": { "properties": { "roles": { "type": "array", "description": "Rollen für diesen User", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "uniqueItems": true }, "groups": { "type": "array", "description": "Gruppen für diesen User", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "uniqueItems": true } } }, "common-user-RolePermission": { "description": "the operation", "properties": { "resource": { "type": "string", "description": "the resource to authorize", "minLength": 1 }, "verb": { "type": "string", "description": "the operation/verb to authorize", "minLength": 1 }, "description": { "type": "string", "description": "description of permission", "readOnly": true }, "autoAppendable": { "type": "boolean", "description": "ist diese Berechtigung eine, die der Admin-Gruppe automatisch hinzugefügt wird", "readOnly": true } }, "required": [ "resource", "verb" ] }, "common-user-UserPermissionRead": { "properties": { "superUser": { "type": "boolean", "default": false, "description": "is user superuser?", "readOnly": true }, "operations": { "type": "array", "description": "list of operations", "items": { "$ref": "#/components/schemas/common-user-UserPermissionRead.RolePermissionWithOrigin" }, "readOnly": true } } }, "common-user-UserPermissionRead.RolePermissionWithOrigin": { "description": "list of operations", "properties": { "permission": { "$ref": "#/components/schemas/common-user-RolePermission" }, "virtual": { "type": "boolean", "default": false, "description": "virtual permission?", "readOnly": true }, "obtainedByRoles": { "type": "array", "description": "Rollen die dieses Recht mitgebracht haben", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true }, "obtainedByGroups": { "type": "array", "description": "Gruppen die dieses Recht mitgebracht haben", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true } } }, "common-user-Role": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "Is the role active?", "readOnly": true }, "label": { "type": "string", "description": "Bezeichnung", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "permissions": { "type": "array", "description": "granted authorities for this role", "items": { "$ref": "#/components/schemas/common-user-RolePermission" } }, "dmsAccessLevelRead": { "type": "integer", "format": "int32", "description": "access level or reading" }, "dmsAccessLevelWrite": { "type": "integer", "format": "int32", "description": "access level for writing" }, "dmsAccessLevelDelete": { "type": "integer", "format": "int32", "description": "access level for deleting" }, "systemPresetting": { "type": "boolean", "description": "system presetting", "readOnly": true } }, "required": [ "label" ] }, "common-user-UserMessage": { "description": "Nachricht", "properties": { "version": { "type": "string", "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", "format": "date-time", "description": "Zeitstempel: Gesendet", "readOnly": true }, "updateTime": { "type": "string", "format": "date-time", "description": "Zeitstempel: Aktualisierungszeit", "readOnly": true }, "lastRead": { "type": "string", "format": "date-time", "description": "Zeitstempel: Gelesen", "readOnly": true }, "state": { "type": "string", "description": "Status", "enum": [ "SEEN", "NOT_SEEN" ], "readOnly": true }, "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "priority": { "type": "string", "description": "Priorität der Nachricht", "enum": [ "HIGH", "NORMAL", "LOW" ], "readOnly": true } } }, "common-user-Group": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "Is the group active?" }, "label": { "type": "string", "description": "Label of this Group", "minLength": 1 }, "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", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true } }, "required": [ "label" ] }, "common-masterdata-UnitType": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "type": { "type": "string", "description": "einheiten typ", "enum": [ "UNDEFINED", "AMOUNT", "LENGTH", "WEIGHT", "AREA", "VOLUME", "SPEED", "TIME" ] }, "name": { "type": "string", "description": "einheiten name", "maxLength": 255, "minLength": 0 }, "abbreviation": { "type": "string", "description": "einheiten abkürzung", "maxLength": 255, "minLength": 0 }, "uneceUnitOfMeasureRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "required": [ "abbreviation", "name", "type" ] }, "common-masterdata-UnitTypeRatio": { "properties": { "version": { "type": "string", "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", "format": "double", "description": "Faktor" } }, "required": [ "baseUnitTypeRef", "factor", "relationUnitTypeRef" ] }, "common-ui-UiSetting": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "category": { "type": "string", "description": "Kategorie" }, "key": { "type": "string", "description": "Schlüssel" }, "token": { "type": "string", "description": "Eindeutiger Import-Schlüssel", "readOnly": true }, "active": { "type": "boolean", "default": true, "description": "Sind die Einstellungen aktiv?" }, "mandatoryForUsers": { "type": "array", "description": "Die Einstellung ist für diese User Pflicht", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "mandatoryForGroups": { "type": "array", "description": "Die Einstellung ist für diese Gruppen Pflicht", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "value": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "permissionAggregation": { "$ref": "#/components/schemas/common-user-ObjectSpecificPermissionAggregation" } }, "required": [ "category", "key", "mandatoryForGroups", "mandatoryForUsers", "permissionAggregation" ] }, "common-user-ObjectSpecificGroupPermission": { "description": "Gruppen-Berechtigungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "groupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "operation": { "type": "string", "description": "Berechtigung", "enum": [ "READ_ONLY", "READ_AND_EDIT" ] } } }, "common-user-ObjectSpecificPermissionAggregation": { "description": "alle Nutzer-/Gruppen-Berechtigungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "userPermissions": { "type": "array", "description": "Nutzer-Berechtigungen", "items": { "$ref": "#/components/schemas/common-user-ObjectSpecificUserPermission" } }, "groupPermissions": { "type": "array", "description": "Gruppen-Berechtigungen", "items": { "$ref": "#/components/schemas/common-user-ObjectSpecificGroupPermission" } }, "operationForAllUsers": { "type": "string", "description": "Zugriffsrechte für alle Nutzer", "enum": [ "READ_ONLY", "READ_AND_EDIT" ] } } }, "common-user-ObjectSpecificUserPermission": { "description": "Nutzer-Berechtigungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "operation": { "type": "string", "description": "Berechtigung", "enum": [ "READ_ONLY", "READ_AND_EDIT" ] } } }, "common-cunit-Translation": { "properties": { "version": { "type": "string", "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ählte Sprachen für dieses Feld" }, "fieldName": { "type": "string", "description": "Feld Name" }, "content": { "type": "string", "description": "übersetzter Text" } } }, "common-cunit-QueryBaseHolderPreset": { "properties": { "version": { "type": "string", "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.", "minLength": 1 }, "templateGroupKey": { "type": "string", "description": "Template-Gruppe, der dieser Filter zugeordnet worden ist.", "minLength": 1 }, "results": { "type": "array", "description": "Ergebnisse", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" } }, "defaultFor": { "type": "string", "description": "Standard-Preset für", "enum": [ "ACCOUNT", "ARTICLE", "BANK", "BANK_TRANSACTION", "DOCUMENT", "DOCUMENT_LINE", "DUNNING", "MANDATE", "OPENITEM", "SHIPPED_DOCUMENT", "SALES_AGENT", "POS_REGISTER", "CASH_DRAWER", "POS_PAYMENT_METHOD", "POS_DEPOSIT_EXPENSE_TYPE", "COMMISSION_RUN_SALES_AGENT" ] } }, "required": [ "templateGroupKey", "templateId" ] }, "common-cunit-QueryPresetResult": { "description": "Ergebnisse", "properties": { "property": { "type": "string", "description": "property", "minLength": 1 }, "displayName": { "type": "string", "description": "title dieser spalte" }, "functions": { "type": "array", "description": "funktionen", "items": { "type": "string", "description": "funktionen" } }, "visible": { "type": "boolean", "default": true, "description": "sichtbare Ergebnisspalte" } }, "required": [ "property" ] }, "common-task-Task": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "label of this task", "minLength": 1 }, "description": { "type": "string", "description": "description of this task" }, "cronExpression": { "type": "string", "description": "valid cron expression (UNIX style)" }, "lastExecutedAt": { "type": "string", "format": "date-time", "description": "last execution date-time", "readOnly": true }, "firstExecutionTime": { "type": "string", "format": "date-time", "description": "first execution date-time" }, "nextExecutionAt": { "type": "string", "format": "date-time", "description": "next execution date-time", "readOnly": true }, "nextExecutionOverride": { "type": "string", "format": "date-time", "description": "Wann eine bevorzugte Abarbeitung angefragt wurde", "readOnly": true }, "lastStatus": { "type": "string", "description": "lastStatus", "enum": [ "CREATED", "QUEUED", "RUNNING", "TERMINATED", "SUCCESSFUL", "ERRONEOUS", "FATAL", "CANCELLED" ], "readOnly": true }, "jobBeanName": { "type": "string", "description": "bean-name/class-name to execute", "minLength": 1 }, "state": { "type": "string", "default": "ACTIVE", "description": "Status", "enum": [ "ACTIVE", "SUSPENDED", "TO_REMOVE" ] }, "category": { "type": "string", "default": "NORMAL", "description": "Category", "enum": [ "QUICK", "NORMAL", "LONG_RUNNING" ], "readOnly": true }, "dataPayloadJson": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "runAsUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "singleton": { "type": "boolean", "default": true, "description": "Is this task a singleton" }, "repetitions": { "type": "integer", "format": "int32", "description": "How often will this task run? (null -> forever)" }, "processId": { "type": "string", "description": "process id" }, "traceActive": { "type": "boolean", "default": false, "description": "Aktiviert Call-Tracing fuer diesen Task", "readOnly": true }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "cronExpression", "firstExecutionTime", "jobBeanName", "label", "runAsUserRef" ] }, "common-sequencer-FreeSequence": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "description": { "type": "string", "description": "Beschreibung" }, "key": { "type": "string", "description": "key", "minLength": 1 }, "active": { "type": "boolean", "description": "active" }, "sequencerConfiguration": { "$ref": "#/components/schemas/common-sequencer-SequencerConfiguration" }, "nextNumber": { "type": "string", "description": "nächste Nummer", "maxLength": 255, "minLength": 0, "readOnly": true } }, "required": [ "active", "key", "label" ] }, "common-scripting-ScriptModule": { "description": "Skript-Modul", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "domain": { "type": "string", "description": "Verwendungsbereiche für die Skriptmodule", "enum": [ "UNDEFINED", "LIBRARY", "APP", "IMPORT_BATCH_PROCESSING", "WORKFLOW_INTERMEDIATE_EVENT", "WORKFLOW_SCRIPT", "WORKFLOW_SPLIT_GATEWAY" ] }, "name": { "type": "string", "description": "Name", "maxLength": 255, "minLength": 0, "pattern": "[a-zA-Z0-9_-]*" }, "description": { "type": "string", "description": "Beschreibung" }, "appIdentifier": { "type": "string", "format": "uuid", "description": "Identifier der App" }, "script": { "type": "string", "description": "Skript", "minLength": 1 }, "sameAsPresettingScript": { "type": "boolean", "default": false, "description": "Entspricht das Skript dem Presetting-Skript?", "readOnly": true }, "withPresettingScript": { "type": "boolean", "default": false, "description": "Gibt es ein Presetting-Skript?", "readOnly": true }, "groupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "parameters": { "type": "array", "description": "Parameter, welche im Skript-Modul verwendet werden", "items": { "$ref": "#/components/schemas/common-scripting-ScriptModuleParameter" } }, "permissionAggregation": { "$ref": "#/components/schemas/common-user-ObjectSpecificPermissionAggregation" } }, "required": [ "domain", "name", "permissionAggregation", "script" ] }, "common-scripting-ScriptModuleParameter": { "description": "Skript-Modul-Parameter", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "name": { "type": "string", "description": "Name des Parameters", "maxLength": 255, "minLength": 0 }, "valueType": { "type": "string", "description": "Typ des Parameters", "maxLength": 255, "minLength": 0 } }, "required": [ "name", "valueType" ] }, "common-scripting-ScriptModuleGroup": { "description": "Skript-Modul-Gruppe", "properties": { "version": { "type": "string", "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", "maxLength": 255, "minLength": 0, "pattern": "[a-zA-Z0-9_-]*" }, "description": { "type": "string", "description": "Beschreibung" }, "appIdentifier": { "type": "string", "format": "uuid", "description": "Identifier der App" }, "moduleRefs": { "type": "array", "description": "Referenzen auf zugehörige Skript-Module", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true } }, "required": [ "name" ] }, "common-output-OutputReport": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "ist dieser Report aktiv?", "readOnly": true }, "groupRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "reportTypeRef": { "$ref": "#/components/schemas/common-output-OutputReport.ReportTypeReference" }, "outputTemplateSource": { "type": "string", "description": "Report Quellen", "enum": [ "PARAMETER_MODE", "FILE_MODE" ], "readOnly": true }, "textTemplates": { "type": "array", "description": "Text als ReportTemplate (Nachrichten)", "items": { "$ref": "#/components/schemas/common-output-OutputTextTemplate" } }, "languages": { "type": "array", "description": "die ausgewählten Sprachen für 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ändert werden", "readOnly": true }, "moduleRule": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "label": { "type": "string", "description": "Label", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "description" }, "alias": { "type": "string", "description": "Alias Name für die Subreporte" }, "copied": { "type": "boolean", "description": "Gibt an, ob es sich um eine Kopie eines anderen Reports handelt", "readOnly": true }, "exportFilename": { "type": "string", "description": "Vorgabe für 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" } }, "required": [ "label" ] }, "common-output-OutputReport.ReportTypeReference": { "description": "der Reporttyp", "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", "enum": [ "VQL_REPORTS", "TEXT_ONLY" ], "readOnly": true } }, "required": [ "id" ] }, "common-output-OutputTextTemplate": { "description": "Text als ReportTemplate (Nachrichten)", "properties": { "contentType": { "type": "string", "description": "Format", "enum": [ "TEXT", "HTML" ] }, "subjectTemplate": { "type": "string", "description": "template anteil für subject" }, "bodyTemplate": { "type": "string", "description": "template anteil für den body" } } }, "common-output-OutputReportLocalizedText": { "properties": { "version": { "type": "string", "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 Übersetzung. dieser Key darf nur bei Einträgen verändert werden, die keinen preset Text haben" }, "presetText": { "type": "string", "description": "original text (Sprache: vario)", "readOnly": true }, "presetParameter": { "type": "array", "description": "mögliche parameter bei dem ausdruck", "items": { "type": "string", "description": "mögliche parameter bei dem ausdruck" }, "readOnly": true }, "text": { "type": "string", "description": "lokalisierte variante" } } }, "common-output-OutputReportGroup": { "properties": { "version": { "type": "string", "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", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true }, "systemPresetting": { "type": "boolean", "description": "handelt es sich um eine System-Gruppe? diese kann nicht gelöscht werden", "readOnly": true }, "defaultGroup": { "type": "boolean", "description": "ist das die default Gruppe für dieses OutputModul", "readOnly": true }, "freePrinting": { "type": "boolean", "default": false, "description": "Sind die reporte aus der Gruppe frei zugänglich" }, "label": { "type": "string", "description": "custom label", "minLength": 1 }, "identifier": { "type": "string", "description": "Identifier für die Gruppe", "minLength": 1 }, "exportFilename": { "type": "string", "description": "Vorgabe für den Dateinamen, falls der Report keinen selbst bestimmt" }, "outputFilterScript": { "type": "string", "description": "output-filter-script (if supported)" } }, "required": [ "identifier", "label" ] }, "erp-sales_channel-Location": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "parent": { "$ref": "#/components/schemas/erp-sales_channel-Location" }, "address": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "label": { "type": "string", "description": "Bezeichnung" }, "defaultLocation": { "type": "boolean", "description": "Standard-Standort", "readOnly": true } }, "required": [ "label" ] }, "common-locknlease-LeasableLockDto": { "properties": { "key": { "type": "string", "description": "Key des Locks", "readOnly": true }, "token": { "type": "integer", "format": "int64", "description": "Token des Locks", "readOnly": true }, "user": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "lockedBySystem": { "type": "boolean", "default": false, "description": "Wurde diese Sperre vom System erzeugt?", "readOnly": true }, "validUntil": { "type": "string", "format": "date-time", "description": "Ablaufuhrzeit", "readOnly": true } } }, "common-masterdata-LanguageCode": { "description": "ISO 369 language codes", "properties": { "version": { "type": "string", "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", "maxLength": 255, "minLength": 1 }, "isoName": { "type": "string", "maxLength": 255, "minLength": 1 }, "isoAlpha2": { "type": "string", "description": "ISO 369-1 alpha-2 code", "minLength": 1 }, "isoAlpha3": { "type": "string", "description": "ISO 369-2 alpha-3 code", "minLength": 1 }, "active": { "type": "boolean", "default": true, "description": "is active", "readOnly": true }, "showInDropDowns": { "type": "boolean", "default": true, "description": "DropDown Visibility" } }, "required": [ "isoAlpha2", "isoAlpha3", "isoName", "label", "showInDropDowns" ] }, "common-cunit-ArithmeticQueryTerm": { "description": "Arithmetische Terme - hier kommt die tatsächliche Berechnung rein", "properties": { "termName": { "type": "string", "description": "Der Name des Terms für die Verarbeitung und Darstellung" }, "terms": { "type": "array", "description": "Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung", "items": { "$ref": "#/components/schemas/common-cunit-ArithmeticQueryTermInner" } }, "operations": { "type": "array", "description": "Die Operationen, die ausgeführt werden sollen mit den Termen", "items": { "type": "string", "description": "Die Operationen, die ausgeführt werden sollen mit den Termen", "enum": [ "PLUS", "MINUS", "MULTIPLY", "DIVIDE" ] } } } }, "common-cunit-ArithmeticQueryTermFragment": { "description": "Das Termfragment - eine weitere Verschachtelung mit eigenen Operationen", "properties": { "operations": { "type": "array", "description": "Die Operationen, die ausgeführt werden sollen mit den Termen", "items": { "type": "string", "description": "Die Operationen, die ausgeführt werden sollen mit den Termen", "enum": [ "PLUS", "MINUS", "MULTIPLY", "DIVIDE" ] } } } }, "common-cunit-ArithmeticQueryTermInner": { "description": "Die inneren Terme - entweder Verweise auf Attribute oder weitere Verschachtelungen der Berechnung", "properties": { "fragment": { "$ref": "#/components/schemas/common-cunit-ArithmeticQueryTermFragment" }, "attribute": { "type": "string", "description": "Ein echtes Attribut aus dem Template" }, "fixedValue": { "type": "number", "description": "Ein Fixwert" } } }, "common-cunit-QueryPreset": { "description": "Adhoc Preset", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "mode": { "type": "string", "default": "QUERY", "description": "Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT", "enum": [ "QUERY", "STATEMENT" ] }, "templateId": { "type": "string", "description": "template dem dieser filter zugeordnet worden ist.", "minLength": 1 }, "templateGroupKey": { "type": "string", "description": "templateGroupKey dem dieser filter zugeordnet worden ist.", "minLength": 1 }, "label": { "type": "string", "description": "label für diesen filter", "minLength": 1 }, "uiPayload": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "variables": { "type": "array", "description": "Variablen für dieses Preset", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariable" } }, "queryStatement": { "type": "string", "description": "bei mode == STATEMENT, das vql-query" }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "results": { "type": "array", "description": "ergebnisse", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" } }, "sortAndOrders": { "type": "array", "description": "sortierung", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetSortOrder" } }, "pageable": { "$ref": "#/components/schemas/common-cunit-QueryPresetPageable" }, "option": { "$ref": "#/components/schemas/common-cunit-QueryPresetOption" }, "transformations": { "type": "array", "description": "zusätzliche konfigurationen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetTransformation" } }, "arithmeticQueryTerms": { "type": "array", "description": "Arithmetische Terme - hier kommt die tatsächliche Berechnung rein", "items": { "$ref": "#/components/schemas/common-cunit-ArithmeticQueryTerm" } }, "definition": { "type": "array", "description": "spaltenbeschreibung dieser zelle (bei verschachtelung)", "items": { "$ref": "#/components/schemas/core-cunit-MetaContent" }, "readOnly": true }, "permissionAggregation": { "$ref": "#/components/schemas/common-user-ObjectSpecificPermissionAggregation" }, "forWorkflow": { "type": "boolean", "default": false, "description": "für Workflows vorgesehen" }, "outputReportGroupIdentifier": { "type": "string", "description": "Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird" }, "userOptions": { "$ref": "#/components/schemas/common-cunit-QueryPresetUserOptions" } }, "required": [ "forWorkflow", "label", "mode", "permissionAggregation", "templateGroupKey", "templateId" ] }, "common-cunit-QueryPresetCrossTableTransformation": { "description": "enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)", "properties": { "rowSpecs": { "type": "array", "description": "enthält die felder, die in einer cross-table für die reihenbildung verantwortlich sind (im grunde -> der group-key)", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" }, "minItems": 1 }, "columnSpecs": { "type": "array", "description": "enthält die felder, die in der cross-table als dynamische spalten erstellt werden sollen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" }, "minItems": 1 }, "results": { "type": "array", "description": "enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell" }, "minItems": 1 } }, "required": [ "columnSpecs", "results", "rowSpecs" ] }, "common-cunit-QueryPresetCrossTableTransformation.QueryPresetCrossTableCell": { "description": "enthält die felder, die pro rowSpec-Kombination je nach Spaltenausprägung ermittelt werden sollen", "properties": { "result": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" }, "cellView": { "type": "string", "description": "darstellung der werte", "enum": [ "AS_IS", "PERCENT_COL" ] }, "sumColumn": { "type": "boolean", "default": false, "description": "soll eine spaltensumme erzeugt werden" }, "rowMode": { "type": "string", "description": "soll eine zeilensumme erzeugt werden", "enum": [ "DATA", "DATA_AND_TOTAL", "TOTAL" ] }, "aggregateFunction": { "type": "string", "description": "die funktion mit der die werte der Zelle aggregiert werden" } } }, "common-cunit-QueryPresetOption": { "description": "options", "properties": { "distinctResult": { "type": "boolean", "description": "soll der Query mit einem Distinct durchgeführt werden" } } }, "common-cunit-QueryPresetPageable": { "description": "pageable", "properties": { "limit": { "type": "integer", "format": "int64", "description": "das Limit (MaxRecordCount) für diesen Query" } } }, "common-cunit-QueryPresetRequest": { "description": "CUnit-Vorlage zum erzeugen des Imports", "properties": { "mode": { "type": "string", "default": "QUERY", "description": "Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT", "enum": [ "QUERY", "STATEMENT" ] }, "queryStatement": { "type": "string", "description": "bei mode == STATEMENT, das vql-query" }, "presetId": { "type": "string", "description": "ID eines Presets" }, "adhocPreset": { "$ref": "#/components/schemas/common-cunit-QueryPreset" }, "overrideResults": { "type": "array", "description": "ergebnisse (überschreiben QueryPreset#results)", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetResult" } }, "arithmeticQueryTerms": { "type": "array", "description": "Arithmetische Terme - hier kommt die tatsächliche Berechnung rein", "items": { "$ref": "#/components/schemas/common-cunit-ArithmeticQueryTerm" } }, "additionalPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "pageable": { "$ref": "#/components/schemas/common-cunit-QueryPresetRequestPageable" }, "variableSubstitutionList": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" } } }, "common-cunit-QueryPresetRequestPageable": { "description": "Paging- und Sortierinformationen", "properties": { "start": { "type": "integer", "format": "int64", "description": "Start-Offset" }, "limit": { "type": "integer", "format": "int32", "description": "Ergebnis-Limit" }, "sortOrders": { "type": "array", "description": "sort and order anweisungen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetSortOrder" } } } }, "common-cunit-QueryPresetSortOrder": { "description": "sort and order anweisungen", "properties": { "property": { "type": "string", "description": "property", "minLength": 1 }, "functions": { "type": "array", "description": "Functions", "items": { "type": "string", "description": "Functions" } }, "direction": { "type": "string", "description": "sort order", "enum": [ "ASC", "DESC" ] } }, "required": [ "direction", "property" ] }, "common-cunit-QueryPresetTransformation": { "description": "zusätzliche konfigurationen", "properties": { "crossTable": { "$ref": "#/components/schemas/common-cunit-QueryPresetCrossTableTransformation" } } }, "common-cunit-QueryPresetUserOptions": { "description": "nutzerbezogene Einstellungen", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "pinned": { "type": "boolean", "default": false, "description": "angepinnt?" } }, "required": [ "pinned" ] }, "common-data_import-ScheduledImport": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Label" }, "responsibleTask": { "$ref": "#/components/schemas/common-task-Task" }, "ruleSetRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "queryPresetRequest": { "$ref": "#/components/schemas/common-cunit-QueryPresetRequest" }, "exportMode": { "type": "string", "description": "Nur für Exporte: Was wird erzeugt? Eigene Datei oder Revision?", "enum": [ "ONE_FILE_PER_RUN", "ONE_REVISION_PER_RUN" ] }, "inputType": { "type": "string", "description": "Was ist die Datenquelle", "enum": [ "FILE", "QUERY" ] } }, "required": [ "inputType" ] }, "common-data_import-DataImportRun": { "properties": { "version": { "type": "string", "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", "enum": [ "CREATED", "EXTRACTING_DATA", "DATA_EXTRACTED", "RUNNING", "ERRONEOUS", "COMPLETED", "IGNORED", "DUMMY" ], "readOnly": true }, "headers": { "type": "array", "description": "Spaltenzuordnungen", "items": { "$ref": "#/components/schemas/common-data_import-ImportHeader" } }, "label": { "type": "string", "description": "Label" }, "validatedSinceLastRuleChange": { "type": "boolean", "default": false, "description": "Wurden die Daten seit der letzten Änderung am Regelwerk validiert?", "readOnly": true }, "lastImportProcess": { "type": "string", "format": "uuid", "description": "Prozess-ID der letzten Tasks zu diesem Import-Vorgang" }, "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": { "description": "Spaltenzuordnungen", "properties": { "id": { "type": "integer", "format": "int64", "description": "id", "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?" } }, "required": [ "array", "caption", "columnRef" ] }, "common-data_import-DataImportEntry": { "properties": { "version": { "type": "string", "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", "format": "int64", "description": "1-basierter Index", "readOnly": true }, "state": { "type": "string", "description": "Status dieses Eintrags", "enum": [ "NOT_YET_RUN", "ERRONEOUS", "SUCCESSFUL", "IGNORED", "OUT_OF_BOUNDS", "MANUALLY_IGNORED", "MANUALLY_COMPLETED" ], "readOnly": true }, "content": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "transformationResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "violations": { "type": "array", "description": "ggf. aufgetretene Fehlermeldungen", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" }, "readOnly": true }, "validationState": { "type": "string", "description": "Ergebnis der Validierung", "enum": [ "NOT_YET_RUN", "ERRONEOUS", "SUCCESSFUL", "IGNORED", "OUT_OF_BOUNDS", "ALREADY_COMPLETED" ], "readOnly": true }, "lastValidatedAt": { "type": "string", "format": "date-time", "description": "Zeitpunkt der letzten Validierung", "readOnly": true } } }, "common-data_import-CsvExportSetting": { "description": "Einstellungen für CSV-Export", "properties": { "targetFieldDefinitions": { "type": "array", "description": "Spaltendefinitionen (in korrekter Reihenfolge)", "items": { "type": "string", "description": "Spaltendefinitionen (in korrekter Reihenfolge)" }, "minItems": 1 }, "columnSeparator": { "type": "string", "default": ";", "description": "Spaltentrenner", "maxLength": 1, "minLength": 1 }, "quotingChar": { "type": "string", "default": "\"", "description": "Quotierungszeichen", "maxLength": 1, "minLength": 1 }, "writeHeaderLine": { "type": "boolean", "default": true, "description": "Kopfzeile schreiben?" }, "linebreakType": { "type": "string", "default": "CR_LF", "description": "Art des Zeilenumbruchs", "enum": [ "CR_LF", "CR", "LF" ] } }, "required": [ "columnSeparator", "linebreakType", "quotingChar", "targetFieldDefinitions" ] }, "common-data_import-ExportSetting": { "description": "Wenn ein Dateiexport-Modul ausgewählt wurde: Export-Einstellungen", "properties": { "fileName": { "type": "string", "description": "Dateiname ohne Dateinamenserweiterung", "minLength": 1 }, "charset": { "type": "string", "default": "UTF_8_BOM", "description": "Zeichensatz", "enum": [ "UTF_8", "UTF_8_BOM", "ASCII", "LATIN_1" ] }, "csvSetting": { "$ref": "#/components/schemas/common-data_import-CsvExportSetting" }, "jsonSetting": { "$ref": "#/components/schemas/common-data_import-JsonExportSetting" }, "xmlSetting": { "$ref": "#/components/schemas/common-data_import-XmlExportSetting" } }, "required": [ "charset", "fileName" ] }, "common-data_import-FormatDirective": { "description": "Standard-Format für Wahrheitswerte", "properties": { "formatType": { "type": "string", "description": "Für welchen Datentyp ist diese Formatierung gedacht", "enum": [ "NUMERIC", "DATE", "DATETIME", "BOOLEAN" ] }, "patternString": { "type": "string", "description": "Für DATE & DATETIME: Ein Muster zum parsen" }, "groupingSign": { "type": "string", "description": "Das Tausender-Trennzeichen für Zahlwerte" }, "decimalSign": { "type": "string", "description": "Das Dezimal-Trennzeichen für Zahlwerte" }, "representationForTrue": { "type": "string", "description": "Ein Text, der als boolescher Wert für true steht (Beispielsweise 'J')" }, "representationForFalse": { "type": "string", "description": "Ein Text, der als boolescher Wert für false steht (Beispielsweise 'N')" } }, "required": [ "formatType" ] }, "common-data_import-IgnoreRule": { "description": "Bedingungen, unter denen das zu importierende Objekt ignoriert werden soll", "properties": { "version": { "type": "string", "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 Übereinstimmung oder müssen alle Werte übereinstimmen?", "enum": [ "ANY_MATCH", "ALL_MATCH" ] }, "comparisonValue": { "type": "string", "description": "Wert, der zum Ausschluss führen soll" }, "fieldToCompare": { "type": "string", "description": "Mit dem Wert aus welchem Feld soll verglichen Werden?" } } }, "common-data_import-ImportMappingRule": { "description": "Mapping-Regeln", "properties": { "version": { "type": "string", "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" } }, "required": [ "transformation" ] }, "common-data_import-ImportMappingRuleSet": { "description": "Regelsatz für den Import-Vorgang", "properties": { "version": { "type": "string", "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" }, "root": { "type": "string", "description": "Bei JSON- und XML-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ür welchen Import gilt dieser Regelsatz" }, "dataFrom": { "type": "integer", "format": "int64", "description": "Index des ersten Datensatzes (1-basiert) - alle vorherigen werden ignoriert" }, "dataTo": { "type": "integer", "format": "int64", "description": "Index des letzten Datensatzes (1-basiert) - alle danach werden ignoriert" }, "headerIndex": { "type": "integer", "format": "int64", "description": "Falls vorhanden: Index der Kopfzeile (1-basiert)" }, "columnSeparator": { "type": "string", "description": "Nur für CSV: Trennzeichen innerhalb einer Zeile" }, "charSet": { "type": "string", "description": "Für CSV & JSON: Verwendeter Zeichensatz", "enum": [ "UTF_8", "ASCII", "LATIN_1", "AUTO_DETECT" ] }, "quotingChar": { "type": "string", "description": "Nur für 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ür eine Eav-Gruppe bei der Ausführung 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ührendes 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" } }, "parallelExecutionAllowed": { "type": "boolean", "default": true, "description": "Aufsplitten in mehrere parallel ausgeführte Tasks erlauben?" }, "advancedUi": { "type": "boolean", "default": false, "description": "Erweiterte Darstellung im UI verwenden?" }, "ignoreEmptyData": { "type": "boolean", "default": false, "description": "Bei JSON-Import: Leere Datenmenge ignorieren?" }, "exportSetting": { "$ref": "#/components/schemas/common-data_import-ExportSetting" }, "suppressWebhooks": { "type": "boolean", "default": false, "description": "Sollen Webhooks bei Ausführung deaktiviert werden?" }, "suppressWorkflows": { "type": "boolean", "default": false, "description": "Sollen Workflows bei Ausführung deaktiviert werden?" }, "createMissingHeadersFromRuleSet": { "type": "boolean", "default": false, "description": "Nur JSON & XML: Fehlende Header automatisch aus den im RuleSet referenzierten Spalten erzeugen?" } }, "required": [ "mode" ] }, "common-data_import-ImportMappingRuleSetParameter": { "description": "Parameter zu einem Import-Rule-Set", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "name": { "type": "string", "description": "Name des Parameters", "maxLength": 255, "minLength": 0 }, "requiredValueType": { "type": "string", "description": "Typ des Parameters, falls er z.B. durch ein Skript-Modul vorgegeben wurde", "maxLength": 255, "minLength": 0, "readOnly": true }, "fixedValue": { "type": "string", "description": "Fester Wert (nur in Kombination mit fixedValueType)", "maxLength": 255, "minLength": 0 }, "fixedValueType": { "type": "string", "description": "Datentyp vom festen Wert (nur in Kombination mit fixedValue)", "maxLength": 255, "minLength": 0 }, "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" } }, "required": [ "name" ] }, "common-data_import-JsonExportSetting": { "description": "Einstellungen für JSON-Export", "properties": { "rootFieldDefinitions": { "type": "array", "description": "Feld-Definitionen der JSON", "items": { "$ref": "#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition" }, "minItems": 1 }, "prettyPrint": { "type": "boolean", "default": false, "description": "soll die JSON schön formatiert werden (speicherintensiver)" }, "linebreakType": { "type": "string", "default": "CR_LF", "description": "Art des Zeilenumbruchs", "enum": [ "CR_LF", "CR", "LF" ] } }, "required": [ "rootFieldDefinitions" ] }, "common-data_import-JsonExportSetting.FieldDefinition": { "description": "Feld-Definitionen der JSON", "properties": { "name": { "type": "string", "description": "Feld-Name", "minLength": 1 }, "type": { "type": "string", "description": "Datentyp für das Feld", "enum": [ "TEXT", "NUMBER", "BOOLEAN", "DATE", "DATE_TIME", "OBJECT" ] }, "children": { "type": "array", "description": "Bei Objekten: Felder innerhalb des Objekts", "items": { "$ref": "#/components/schemas/common-data_import-JsonExportSetting.FieldDefinition" } }, "array": { "type": "boolean", "default": false, "description": "Handelt es sich bei dem Feld um ein Array?" } }, "required": [ "name", "type" ] }, "common-data_import-TargetFieldRule": { "description": "Gibt an, wie mit Zielfeldern und Unterobjekten umgegangen werden soll.", "properties": { "version": { "type": "string", "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ür LOAD_OR_INSERT, UPDATE und UPSERT.", "items": { "type": "string", "description": "Anhand welcher Felder soll das Objekt identifiziert werden? Nur für 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" } } }, "required": [ "path" ] }, "common-data_import-Transformation": { "description": "Gibt an, wie der Wert für target erzeugt wird.", "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ür die Transformation", "items": { "$ref": "#/components/schemas/common-data_import-Transformation" } }, "columnName": { "type": "string", "description": "für DIRECT, GET_AT_INDEX & ITERATE: Spalte, aus der die Daten entnommen werden sollen" }, "fixedValue": { "type": "string", "description": "für FIXED_VALUE: Wert" }, "replacements": { "type": "array", "description": "für REPLACE: Ersetzungen", "items": { "$ref": "#/components/schemas/common-data_import-Transformation.Replacement" } }, "matchWholeFieldsOnly": { "type": "boolean", "description": "für REPLACE: Ersetzung nur, wenn der gesamte Wert übereinstimmt, keine Substrings" }, "regexSearch": { "type": "string", "description": "für REGEX_REPLACE: Der Reguläre Ausdruck, nach dem gesucht wird" }, "regexReplacement": { "type": "string", "description": "für REGEX_REPLACE: Die Ersetzung, die für den Regex durchgeführt wird" }, "caseSensitive": { "type": "boolean", "description": "für (REGEX_)REPLACE: Nur ersetzen, wenn Groß-/Kleinschreibung passt?" }, "useDefaultValueForReplacement": { "type": "boolean", "default": false, "description": "für REPLACE mit matchWholeFieldsOnly:Soll durch den default-Wert ersetzt werden, wenn kein Ausdruck passt?" }, "defaultValue": { "type": "string", "description": "für REPLACE mit matchWholeFieldsOnly: Ersetzung, wenn kein Ausdruck passt" }, "index": { "type": "integer", "format": "int32", "description": "für GET_AT_INDEX: Das wievielte Element des Array wollen wir? (0-basierter Index)" }, "target": { "type": "string", "description": "Ziel, wohin das Transformationsergebnis geschrieben wird" }, "formatDirective": { "$ref": "#/components/schemas/common-data_import-FormatDirective" }, "moduleSpecificTransformationKey": { "type": "string", "description": "Key für Sonder-Transformationen" }, "suppressFailures": { "type": "boolean", "description": "für Sonder-Transformationen: Wenn ein Fehler auftritt ignorieren und null verwenden?" }, "auxiliaryTransformation": { "type": "boolean", "default": false, "description": "Hilfs-Transformation ohne echtes Mapping-Target?" }, "dataType": { "type": "string", "description": "für Hilfs-Transformationen: Datentyp" } }, "required": [ "type" ] }, "common-data_import-Transformation.Replacement": { "description": "für REPLACE: Ersetzungen", "properties": { "from": { "type": "string", "description": "zu ersetzende Zeichenkette", "minLength": 1 }, "to": { "type": "string", "description": "Ersatz für die Zeichenkette" } }, "required": [ "from" ] }, "common-data_import-UpdateMultiPartImportRunRequest": { "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": { "description": "Import-Regelwerk mit definierter Reihenfolge", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID eines MultiPartImportOrderedRuleSet" }, "step": { "type": "integer", "format": "int32", "description": "Stufe, auf der der einzelne Import gestartet wird" }, "fileName": { "type": "string", "description": "Datei, die für den Import verwendet wird (inkl. Dateiendung)" }, "label": { "type": "string", "description": "Name des Imports" }, "ruleSet": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" } } }, "common-data_import-XmlExportSetting": { "description": "Einstellungen für XML-Export", "properties": { "rootTagName": { "type": "string", "description": "Root-Element der XML" }, "entryRootDefinition": { "$ref": "#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition" }, "prettyPrint": { "type": "boolean", "default": false, "description": "soll die XML schön formatiert werden (braucht mehr Speicher)" }, "writeXmlDeclaration": { "type": "boolean", "default": true, "description": "XML-Deklaration am Dateianfang einfügen" } }, "required": [ "entryRootDefinition", "rootTagName" ] }, "common-data_import-XmlExportSetting.FieldDefinition": { "description": "Struktur der einzelnen Datensätze", "properties": { "name": { "type": "string", "description": "Name eines XML-Tags", "minLength": 1 }, "attributes": { "type": "array", "description": "Attribute innerhalb des Tags", "items": { "type": "string", "description": "Attribute innerhalb des Tags" } }, "childTags": { "type": "array", "description": "optional: Tags innerhalb dieses Tags", "items": { "$ref": "#/components/schemas/common-data_import-XmlExportSetting.FieldDefinition" } } }, "required": [ "name" ] }, "common-data_import-MultiPartImportOrderedRuleSet": { "description": "Import-Regelwerk und -Lauf nach Reihenfolge", "properties": { "version": { "type": "string", "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", "format": "int32", "description": "Stufe, auf dem der Import-Run gestartet wird" }, "fileName": { "type": "string", "description": "Datei, die für den Import verwendet wird" }, "importMappingRuleSetRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "label": { "type": "string", "description": "Bezeichnung" } } }, "common-data_import-MultiPartImportRun": { "properties": { "version": { "type": "string", "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", "default": false, "description": "Handelt es sich um eine Vorlage?" } } }, "common-masterdata-CustomsMeasure": { "description": "Zollsatz zu Warennummer", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "active", "readOnly": true }, "commodityCodeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "originCountryCodeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "destinationCountryCodeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "dutyRate": { "type": "number", "description": "Zollsatz" }, "penaltyDutyRate": { "type": "number", "description": "Straf-Zollsatz" }, "validFrom": { "type": "string", "format": "date", "description": "gültig ab" } }, "required": [ "commodityCodeRef", "destinationCountryCodeRef", "dutyRate", "originCountryCodeRef" ] }, "common-masterdata-CurrencyCode": { "description": "currency codes - ISO 4217", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "label of this currency", "maxLength": 255, "minLength": 1 }, "isoAlpha3": { "type": "string", "description": "ISO A(3) value of this currency", "maxLength": 3, "minLength": 3 }, "isoNumeric": { "type": "string", "description": "ISO N(3) value of this currency", "maxLength": 3, "minLength": 3 }, "symbol": { "type": "string", "description": "symbol of this currency", "maxLength": 5, "minLength": 1 }, "active": { "type": "boolean", "default": true, "description": "is active", "readOnly": true }, "showInDropDowns": { "type": "boolean", "default": true, "description": "DropDown Visibility" } }, "required": [ "isoAlpha3", "isoNumeric", "label", "showInDropDowns", "symbol" ] }, "common-masterdata-CurrencyExchangeRate": { "description": "currency exchange rates", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "fromCurrency": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" }, "toCurrency": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" }, "exchangeRate": { "type": "number", "description": "exchange rate", "minimum": 0 }, "validFrom": { "type": "string", "format": "date", "description": "valid from" }, "comment": { "type": "string", "description": "Kommentar" }, "active": { "type": "boolean", "default": true, "description": "is active", "readOnly": true } }, "required": [ "exchangeRate", "fromCurrency", "toCurrency", "validFrom" ] }, "common-create_template-CreateTemplate": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "domain": { "type": "string", "description": "Domain" }, "name": { "type": "string", "description": "Name" }, "standard": { "type": "boolean", "default": false, "description": "Standard-Vorlage?" }, "content": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "content", "domain", "name" ] }, "common-create_template-CreateTemplateGroup": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 2147483647, "minLength": 0 }, "domain": { "type": "string", "description": "Domain dieser Gruppe", "maxLength": 255, "minLength": 0 }, "templateRefs": { "type": "array", "description": "Templates in dieser Gruppe", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "required": [ "label" ] }, "common-masterdata-CountryRegion": { "description": "Bundesland bzw. Regions-Verwaltung", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Label", "minLength": 1 }, "abbreviation": { "type": "string", "description": "Abkürzung" }, "regionalCode": { "type": "string", "description": "Eindeutiger regionaler Code (z. B. FIPS-Code, NUTS-Code, spezifischer Landescode)" }, "iso3166_2Code": { "type": "string", "description": "ISO 3166-2 Code für die Region", "maxLength": 6, "minLength": 4 }, "countryCode": { "$ref": "#/components/schemas/common-masterdata-CountryReference" }, "active": { "type": "boolean", "default": true, "description": "is active", "readOnly": true } }, "required": [ "countryCode", "label" ] }, "common-masterdata-CountryCode": { "description": "ISO_3166_country_codes ", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "nameEnglish": { "type": "string" }, "isoAlpha2": { "type": "string", "description": "ISO 3166-1 alpha-2 code", "maxLength": 2, "minLength": 2 }, "isoAlpha3": { "type": "string", "description": "ISO 3166-1 alpha-3 code", "maxLength": 3, "minLength": 3 }, "isoNumeric": { "type": "string", "description": "ISO 3166-1 numeric code", "maxLength": 3, "minLength": 3 }, "ewuMemberFrom": { "type": "string", "format": "date", "description": "this country is member in the ewu from..." }, "ewuMemberTo": { "type": "string", "format": "date", "description": "this country is member in the ewu unti..." }, "active": { "type": "boolean", "default": true, "description": "is active", "readOnly": true }, "regionSelectableInAddress": { "type": "boolean", "default": true, "description": "Region auswählbar in der Adresse" }, "languageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "currencyRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "showInDropDowns": { "type": "boolean", "default": true, "description": "DropDown Visibility" } }, "required": [ "isoAlpha2", "isoAlpha3", "isoNumeric", "name", "showInDropDowns" ] }, "common-connector-HttpWhitelist": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "type": { "type": "string", "description": "Typ der Whitelist-Prüfung (DOMAIN, URL, URL_PATTERN)", "enum": [ "DOMAIN", "URL", "URL_PATTERN" ] }, "value": { "type": "string", "description": "Wert der Whitelist-Prüfung (z.B. '.vario.cloud', 'https://api.example.com', 'https://*.example.com/*')", "minLength": 1 }, "active": { "type": "boolean", "description": "Ist der Eintrag aktiv?", "readOnly": true } }, "required": [ "type", "value" ] }, "common-cunit-ComputedQueryResource.BindReportGroupRequest": { "properties": { "identifier": { "type": "string", "description": "Identifier of an existing output report group in the cunit module", "minLength": 1 } }, "required": [ "identifier" ] }, "common-cunit-ComputedQueryResource.PresetReportGroupBinding": { "properties": { "groupId": { "type": "string" }, "identifier": { "type": "string" }, "label": { "type": "string" }, "reportCount": { "type": "integer", "format": "int64" } } }, "common-masterdata-CommodityCode": { "description": "Warennummer", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "active": { "type": "boolean", "default": true, "description": "active", "readOnly": true }, "commodityCode": { "type": "string", "description": "Warennummer", "maxLength": 8, "minLength": 8, "pattern": "^[0-9]*$" }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "specialUnitType": { "type": "string", "description": "besondere Maßeinheit", "maxLength": 16, "minLength": 0 }, "specialUnitTypeCode": { "type": "string", "description": "besondere Maßeinheit (numerischer Code)", "pattern": "\\d{2}" } }, "required": [ "commodityCode" ] }, "common-masterdata-Category": { "description": "Kategorie", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "parentCategoryTreeRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "parentCategoryRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "childCategories": { "type": "array", "description": "Untergeordnete Kategorien", "items": { "$ref": "#/components/schemas/common-masterdata-Category" } }, "hasChildren": { "type": "boolean", "description": "Hat untergeordnete Kategorien (nur bei Kind-Kategorien gesetzt, deren Kinder nicht geladen werden)", "readOnly": true }, "labels": { "type": "array", "description": "Bezeichnung (mehrsprachig)", "items": { "$ref": "#/components/schemas/common-masterdata-CategoryDescription" }, "minItems": 1 }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortierung" }, "externalReference": { "type": "string", "description": "Externe Referenz", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "Aktiv", "readOnly": true } }, "required": [ "labels", "sortOrder" ] }, "common-masterdata-CategoryDescription": { "description": "Mehrsprachige Kategorie-Bezeichnung", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "languageCode": { "type": "string", "description": "Sprachcode (ISO 639-1)" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "label", "languageCode" ] }, "common-masterdata-CategoryTree": { "description": "Kategorie-Baum", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "childCategories": { "type": "array", "description": "Untergeordnete Kategorien", "items": { "$ref": "#/components/schemas/common-masterdata-Category" } }, "label": { "type": "string", "description": "Bezeichnung", "maxLength": 255, "minLength": 0 }, "description": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "Aktiv", "readOnly": true } }, "required": [ "label" ] }, "banking-api-BankingUser": { "properties": { "version": { "type": "string", "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", "minLength": 1 }, "password": { "type": "string", "description": "password", "writeOnly": true }, "email": { "type": "string", "description": "email", "minLength": 1 }, "replicated": { "type": "boolean", "default": false, "description": "is user replicated", "readOnly": true }, "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" } }, "required": [ "email", "username", "varioUserRef" ] }, "banking-api-BankingProvider": { "properties": { "version": { "type": "string", "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", "APP" ] }, "bankingUsers": { "type": "array", "description": "banking users for this provider", "items": { "$ref": "#/components/schemas/banking-api-BankingUser" } } }, "required": [ "bpIdentifier", "bpName" ] }, "banking-connector-BankingParameter": {}, "erp-wms-StockTransferProcessingRequest": { "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "stockTransferType": { "type": "string", "description": "Umlagerungsarten", "enum": [ "FROM_TRANSIT", "TO_TRANSIT" ] }, "pickTrolleyId": { "type": "integer", "format": "int64", "description": "Der aktuelle Wagen" }, "quantity": { "type": "number", "description": "Mengenänderung" }, "processingAction": { "type": "string", "description": "Spezielle Aktion bei der Verarbeitung von Picklisten", "enum": [ "NONE", "END" ] }, "articleId": { "type": "integer", "format": "int64", "description": "ID vom aktuellen Artikel" }, "storageBinId": { "type": "integer", "format": "int64", "description": "ID vom Ziel Lagerplatz" }, "articleSerialNumberId": { "type": "integer", "format": "int64", "description": "ID einer Seriennummer" } }, "required": [ "stockTransferType" ] }, "erp-stock-Stock": { "description": "Bestand", "properties": { "articleId": { "type": "integer", "format": "int64", "description": "Artikel" }, "storageBinId": { "type": "integer", "format": "int64", "description": "Lagerplatz" }, "storageBinDisplayName": { "type": "string", "description": "Anzeigename vom Lagerplatz", "readOnly": true }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "amount": { "type": "number", "description": "Bestand" } }, "required": [ "amount", "articleId", "storageBinId" ] }, "erp-wms-ArticleTrolleyStockInfo": { "description": "Artikel Bestand", "properties": { "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "unit": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "articleNumber": { "type": "string", "description": "Article-Number" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "amount": { "type": "number", "description": "Bestand" }, "lastBookedStorageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "presetStorageBinRefs": { "type": "array", "description": "Für den Artikel vordefinierter Lagerplatzu", "items": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" } } }, "required": [ "amount", "unit" ] }, "erp-wms-StockTransferProcessingResponse": { "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "stockTransferType": { "type": "string", "description": "Umlagerungsarten", "enum": [ "FROM_TRANSIT", "TO_TRANSIT" ] }, "storageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "pickTrolleyRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "article": { "$ref": "#/components/schemas/erp-product-Article" }, "stockInPickTrolley": { "$ref": "#/components/schemas/erp-stock-Stock" }, "stockInStorageBin": { "$ref": "#/components/schemas/erp-stock-Stock" }, "lastBookedSerialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "stockInPickTrolleyList": { "type": "array", "description": "Liste aller Artikel im Wagen", "items": { "$ref": "#/components/schemas/erp-wms-ArticleTrolleyStockInfo" } }, "showStorageBin": { "type": "boolean", "default": false, "description": "Sollen Lagerplätze angezeigt werden?" }, "workbenchStorageBinRefs": { "type": "array", "description": "Werkbank-Lagerplätze zu Produktionsaufträgen", "items": { "$ref": "#/components/schemas/erp-wms-StockTransferProcessingResponse.WorkbenchStorageBinRef" } } } }, "erp-wms-StockTransferProcessingResponse.WorkbenchStorageBinRef": { "description": "Werkbank-Lagerplatz zu einem Produktionsauftrag", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID" }, "displayName": { "type": "string", "description": "Anzeigename" }, "routePosition": { "type": "integer", "format": "int32", "description": "Laufwegposition" }, "color": { "type": "string", "description": "Anzeigefarbe" }, "storageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "fabricationOrderRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" } } }, "erp-wms-PickTrolleyBoxGenerateRequest": { "description": "Infos zur Generierung von Pickboxen", "properties": { "pickTrolleyId": { "type": "integer", "format": "int64", "description": "ID des Pickwagens" }, "labelPrefix": { "type": "string", "description": "Präfix des Labels der generierten Boxen" }, "labelPostfixStart": { "type": "integer", "format": "int32", "default": 1, "description": "Startwert des Postfix vom Label" }, "desiredCount": { "type": "integer", "format": "int32", "description": "Gewünschte Anzahl" } } }, "erp-wms-PicklistParcel": { "description": "Paket zur Pickliste", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID" }, "weight": { "type": "number", "description": "Gewicht" }, "weightUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "length": { "type": "number", "description": "Länge" }, "width": { "type": "number", "description": "Breite" }, "height": { "type": "number", "description": "Höhe" }, "sizeUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" } }, "required": [ "weight", "weightUnitTypeRef" ] }, "erp-spi-VdsParcel": { "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": { "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": { "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "processingType": { "type": "string", "description": "Art der Picklisten-Verarbeitung", "enum": [ "PICKING", "PACKING" ] }, "processingAction": { "type": "string", "default": "NONE", "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", "PRINT_ARTICLE_LABELS", "SKIP_POSITION", "CLOSE_POSITION" ] }, "picklistId": { "type": "integer", "format": "int64", "description": "ID der aktuellen Pickliste" }, "pickTrolleyId": { "type": "integer", "format": "int64", "description": "ID des aktuellen Pickwagen" }, "pickTrolleyBoxId": { "type": "integer", "format": "int64", "description": "ID der aktuellen Pickbox" }, "lastProcessedPicklistLineId": { "type": "integer", "format": "int64", "description": "ID der letzten verarbeitete Position" }, "lastProcessedPicklistLineComponentId": { "type": "integer", "format": "int64", "description": "ID der letzten verarbeiteten Komponente" }, "lastProcessedOrderId": { "type": "integer", "format": "int64", "description": "ID vom Letzten verarbeiteter Auftrag" }, "articleId": { "type": "integer", "format": "int64", "description": "ID vom aktuellen Artikel" }, "serialNumberId": { "type": "integer", "format": "int64", "description": "ID der aktuellen Seriennummer" }, "storageBinId": { "type": "integer", "format": "int64", "description": "ID vom aktueller Lagerplatz" }, "deviatingDeliveryTermId": { "type": "integer", "format": "int64", "description": "ID der geänderten Lieferbedingung" }, "deviatingDeliveryMethodId": { "type": "integer", "format": "int64", "description": "ID der geänderten Lieferart" }, "manualQuantityChange": { "type": "number", "description": "Manuelle Mengenänderung" }, "serialNumberIdsToProcess": { "type": "array", "description": "Liste von IDs von Artikel-Seriennummern, welche verarbeitet werden sollen", "items": { "type": "integer", "format": "int64", "description": "Liste von IDs von Artikel-Seriennummern, welche verarbeitet werden sollen" } }, "weighedParcels": { "type": "array", "description": "Pakete, zu denen das Gewicht ermittelt wurde", "items": { "$ref": "#/components/schemas/erp-wms-PicklistParcel" } }, "absoluteManualQuantityChange": { "type": "boolean" } }, "required": [ "processingType" ] }, "erp-wms-PicklistProcessingResponse": { "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", "CHANGED_DELIVERY_METHOD", "CHANGED_DELIVERY_METHOD_DELIVERY_TERM", "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", "SHIPPING_LABEL_PRINTED", "SCAN_DELIVERY_DOCUMENT_OR_SHIPPING_LABEL", "SCAN_DELIVERY_DOCUMENT", "SCAN_SHIPPING_LABEL", "PICKLIST_FOR_MISSING_GOODS_PICKING_CREATED", "SCAN_PICK_TROLLEY_BOX_FOR_CONFIRMATION", "PICK_TROLLEY_BOX_SCANNED_FOR_CONFIRMATION" ] }, "picklist": { "$ref": "#/components/schemas/erp-wms-ProcessedPicklist" }, "pickTrolleyId": { "type": "integer", "format": "int64", "description": "ID des aktuellen Pickwagen" }, "pickTrolleyBoxId": { "type": "integer", "format": "int64", "description": "ID der aktuellen Pickbox" }, "lastProcessedPicklistLineId": { "type": "integer", "format": "int64", "description": "ID der letzten verarbeitete Position" }, "lastProcessedPicklistLineComponentId": { "type": "integer", "format": "int64", "description": "ID der letzten verarbeiteten Komponente" }, "lastProcessedOrderId": { "type": "integer", "format": "int64", "description": "ID vom Letzten verarbeiteter Auftrag" }, "createdDeliveryIds": { "type": "array", "description": "IDs der erstellten Liefer-Belege", "items": { "type": "integer", "format": "int64", "description": "IDs der erstellten Liefer-Belege" } }, "erroneousOutputs": { "type": "array", "description": "Fehlerhafte Druckauftraege", "items": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } }, "articleId": { "type": "integer", "format": "int64", "description": "ID vom aktuellen Artikel" }, "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", "format": "int64", "description": "ID des Shipments für 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" }, "parcelId": { "type": "integer", "format": "int64", "description": "ID des aktuellen Pakets, wenn das Gewicht benötigt wird und/oder der Versanddialog gezeigt werden soll" }, "parcelCarrierResponse": { "type": "string", "description": "Nachricht vom Versender, wenn zu einem Problem beim Druck vom Versandlabel kam" }, "pickTrolleyRequired": { "type": "boolean", "default": false, "description": "Wird ein Pickwagen für die Verarbeitung benötigt?" }, "currentParcelCount": { "type": "integer", "format": "int32", "description": "Anzahl der aktuell zum Auftrag erstellten Pakete" }, "estimatedParcelCount": { "type": "integer", "format": "int32", "description": "Anzahl der erwarteten Paketanzahl zum Auftrag" }, "unpackagedWeight": { "type": "number", "description": "Aktuell erfasstes Gewicht, welches noch nicht in ein Paket gebucht wurde (unverpacktes Gewicht)" }, "unpackagedWeightUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" } } }, "erp-wms-ProcessedPicklist": { "description": "Verarbeitete Pickliste", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID der Pickliste" }, "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" } }, "required": [ "id", "lines", "number" ] }, "erp-wms-ProcessedPicklistLine": { "description": "Verarbeitete Position einer Pickliste", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID der Position" }, "componentId": { "type": "integer", "format": "int64", "description": "ID der Position der hier dargestellten Komponente" }, "position": { "type": "integer", "format": "int32", "description": "Nummer der Position in der aktuellen Ansicht diese Positionsliste" }, "lineType": { "type": "string", "description": "Arten von Picklistenpositionen", "enum": [ "ARTICLE", "ASSEMBLY_GROUP" ] }, "articleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "assemblyGroupArticleNumber": { "type": "string", "description": "Artikelnummer der Baugruppe, falls diese Position eine Komponente zu einer Baugruppe darstellt" }, "storageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "storageLocation": { "type": "string", "description": "Lagerort, wenn keine Lagerplätze vorhanden" }, "pickTrolleyBoxId": { "type": "integer", "format": "int64", "description": "Zu verwendende PickTrolleyBox" }, "pickTrolleyBoxLabel": { "type": "string", "description": "Label der zu verwendenden PickTrolleyBox" }, "showPickTrolleyBox": { "type": "boolean", "default": false, "description": "Pickbox der Positionen der Picklisten im UI anzeigen" }, "quantity": { "type": "number", "description": "Geforderte Menge der Position" }, "quantityCommitted": { "type": "number", "description": "Verarbeitete Menge der Position" }, "storageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" } } }, "erp-wms-PicklistForIncorrectlyPickedGoodsProcessingRequest": { "description": "Anfrage zur Eingabeverarbeitung von Picklisten mit falsch gesammelten Artikeln", "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "processingAction": { "type": "string", "description": "Aktionen in der Verarbeitung Picklisten mit falsch gesammelten Artikeln", "enum": [ "NONE", "CREATE_NEW", "FINISH" ] }, "picklistId": { "type": "integer", "format": "int64", "description": "ID der zu verarbeitenden Pickliste" }, "targetStorageId": { "type": "integer", "format": "int64", "description": "ID vom Ziel-Lager zum Verräumen der Ware" }, "articleId": { "type": "integer", "format": "int64", "description": "ID des zu verarbeitenden Artikels" }, "serialNumberId": { "type": "integer", "format": "int64", "description": "ID der zu verarbeitenden Seriennummer" }, "manualQuantityChange": { "type": "number", "description": "Manuelle Mengenänderung" }, "absoluteManualQuantityChange": { "type": "boolean" } } }, "erp-wms-Picklist": { "description": "Pickliste", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "number": { "type": "string", "description": "Nummer der Pickliste" }, "state": { "type": "string", "description": "Status der Pickliste", "enum": [ "IN_CREATION", "CREATED", "PAUSED_IN_PICKING", "IN_PICKING", "PICKED", "PAUSED_IN_PACKING", "IN_PACKING", "CANCELLED", "FINISHED" ] }, "pickingUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "pickingStartedAt": { "type": "string", "format": "date-time", "description": "Zeitpunkt, zu dem der Pickvorgang gestartet wurde" }, "pickingFinishedAt": { "type": "string", "format": "date-time", "description": "Zeitpunkt, zu dem der Pickvorgang beendet wurde" }, "lines": { "type": "array", "description": "Positionen der Pickliste ", "items": { "$ref": "#/components/schemas/erp-wms-PicklistLine" } }, "usedTemplate": { "$ref": "#/components/schemas/erp-wms-PicklistTemplate" }, "targetStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "required": [ "lines", "number", "state" ] }, "erp-wms-PicklistForIncorrectlyPickedGoodsProcessingResponse": { "description": "Antwort der Eingabeverarbeitung von Picklisten mit falsch gesammelten Artikeln", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "processingState": { "type": "string", "description": "Status der Verarbeitung von Pickliste mit falsch gesammelten Artikeln", "enum": [ "CREATED", "PICKLIST_CHOSEN", "ARTICLE_CHOSEN", "SERIAL_NUMBER_CHOSEN", "ABSOLUTE_QUANTITY_MANUAL_CHANGED", "RELATIVE_QUANTITY_MANUAL_CHANGED", "FINISHED" ] }, "picklist": { "$ref": "#/components/schemas/erp-wms-Picklist" }, "targetStorageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumberRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-wms-PicklistLine": { "description": "Positionen einer Pickliste", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "state": { "type": "string", "description": "Status der Position einer Pickliste", "enum": [ "IN_CREATION", "CREATED", "NEWLY_ADDED", "PICKED", "NEWLY_ADDED_AND_PICKED", "WAITING_FOR_SHIPPING_DOCUMENTS", "CANCELLED", "FINISHED" ] }, "lineType": { "type": "string", "description": "Arten von Picklistenpositionen", "enum": [ "ARTICLE", "ASSEMBLY_GROUP" ] }, "sourceDocumentId": { "type": "integer", "format": "int64", "description": "ID des Quell-Dokuments" }, "sourceDocumentLineId": { "type": "integer", "format": "int64", "description": "ID der Quell-Dokumentposition" }, "articleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "storageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "quantity": { "type": "number", "description": "Menge der Position" }, "quantityCollected": { "type": "number", "description": "Gesammelte Menge der Position" }, "quantityPacked": { "type": "number", "description": "Verpackte Menge der Position" }, "targetDocumentId": { "type": "integer", "format": "int64", "description": "ID des Ziel-Dokuments" }, "targetDocumentLineId": { "type": "integer", "format": "int64", "description": "ID der Ziel-Dokumentposition" }, "pickTrolleyBoxRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "bookings": { "type": "array", "description": "Buchungen zu dieser Position", "items": { "$ref": "#/components/schemas/erp-wms-PicklistLineBooking" } }, "components": { "type": "array", "description": "Komponenten dieser Position, falls es sich bei dieser Position um eine Baugruppe handelt", "items": { "$ref": "#/components/schemas/erp-wms-PicklistLineComponent" } } }, "required": [ "articleRef", "lineType", "quantity", "sourceDocumentId", "sourceDocumentLineId", "state", "storageRef" ] }, "erp-wms-PicklistLineBooking": { "description": "Buchungen zu Positionen einer Pickliste", "properties": { "state": { "type": "string", "description": "Status der Buchung einer Position einer Pickliste", "enum": [ "PRESETTING", "PROCESSED" ] }, "quantity": { "type": "number", "description": "Zu buchende Menge (gesammelt)" }, "quantityPacked": { "type": "number", "description": "Zu buchende Menge (verpackt)" }, "storageBinId": { "type": "integer", "format": "int64", "description": "ID vom bebuchten Lagerplatz" }, "storageBinDisplayName": { "type": "string", "description": "Anzeigename vom Lagerplatz", "readOnly": true }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" } }, "required": [ "quantity", "quantityPacked", "state", "storageBinId" ] }, "erp-wms-PicklistLineComponent": { "description": "Komponenten einer Position einer Pickliste", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "picklistLineId": { "type": "integer", "format": "int64", "description": "ID einer Position einer Pickliste" }, "position": { "type": "integer", "format": "int32", "description": "Position der Komponente in der Baugruppe" }, "sourceDocumentLineComponentId": { "type": "integer", "format": "int64", "description": "ID der Komponente der Quell-Dokumentposition" }, "articleId": { "type": "integer", "format": "int64", "description": "ID des Artikels" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleDescription": { "type": "string", "description": "Artikelbeschreibung", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelbezeichnung", "readOnly": true }, "articleAlternativeName": { "type": "string", "description": "abweichende Artikelbezeichnung", "readOnly": true }, "quantity": { "type": "number", "description": "Menge der Position" }, "quantityCollected": { "type": "number", "description": "Gesammelte Menge der Position" }, "quantityPacked": { "type": "number", "description": "Verpackte Menge der Position" }, "quantityPerAssemblyGroup": { "type": "number", "description": "Menge pro Baugruppe (falls die Picklist-Line eine Baugruppe ist)" }, "targetDocumentLineComponentId": { "type": "integer", "format": "int64", "description": "ID der Komponente der Ziel-Dokumentposition" }, "bookings": { "type": "array", "description": "Buchungen zu dieser Komponente", "items": { "$ref": "#/components/schemas/erp-wms-PicklistLineBooking" } } }, "required": [ "articleId", "picklistLineId", "position", "quantity", "sourceDocumentLineComponentId" ] }, "erp-wms-PickingState": { "description": "Ergebnis vom Picking-Start/Stop", "properties": { "state": { "type": "string", "description": "Status des Pickvorgangs", "enum": [ "NOT_STARTED", "STARTED", "FINISHED" ] }, "pickingUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "startedAt": { "type": "string", "format": "date-time", "description": "Der Beginn des Packvorgangs" }, "finishedAt": { "type": "string", "format": "date-time", "description": "Das Ende des Packvorgangs" } } }, "erp-wms-PicklistCreationResult": { "description": "Ergebnis der Erzeugung von Picklisten", "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" } } } }, "erp-wms-PicklistInfo": { "description": "Pickliste ohne Details", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID der Pickliste" }, "number": { "type": "string", "description": "Nummer der Pickliste" }, "state": { "type": "string", "description": "Status der Pickliste", "enum": [ "IN_CREATION", "CREATED", "PAUSED_IN_PICKING", "IN_PICKING", "PICKED", "PAUSED_IN_PACKING", "IN_PACKING", "CANCELLED", "FINISHED" ] }, "processedByUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "lineCount": { "type": "integer", "format": "int64", "description": "Anzahl der Positionen auf der Pickliste" }, "orderCount": { "type": "integer", "format": "int64", "description": "Anzahl der Aufträge auf der Pickliste" }, "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", "FABRICATION", "MISSING_GOODS_PICKING", "INCORRECTLY_PICKED_GOODS" ] }, "processingType": { "type": "string", "description": "Art der Picklisten-Verarbeitung", "enum": [ "PICKING", "PACKING" ] }, "useDigitalPicklist": { "type": "boolean", "default": false, "description": "Digitale Pickliste verwenden: wenn processingType = PICKING -> Positionen nur durch tippen oder swippen bestätigt" }, "usePickNPack": { "type": "boolean", "default": false, "description": "Pick'n'Pack verwenden: wenn processingType = PICKING" }, "hideTargetQuantityInViews": { "type": "boolean", "default": false, "description": "Zielmengen in Masken verstecken: nur sinnvoll bei useDigitalPicklist = false oder processingType = PACKING" }, "allowFullConfirmation": { "type": "boolean", "default": false, "description": "Sammelbestätigung erlauben: wenn processingType = PACKING, dann Button zur Sammelbestätigung einblenden" }, "assemblyGroupAtOnce": { "type": "boolean", "default": false, "description": "Baugruppen als Ganzes erfassen" } } }, "core-api-QueryPageableApi": { "description": "Paging", "properties": { "sort": { "type": "string", "description": "Liste an Feldern zur Sortierung (komma-getrennt)" }, "_start": { "type": "integer", "format": "int32", "description": "Start-Offset" }, "_limit": { "type": "integer", "format": "int32", "description": "Ergebnis-Limit" }, "_order": { "type": "string", "description": "Sortierart der Felder (asc/desc, Liste, komma-getrennt)" } } }, "erp-stock-StorageBinSelectionApi": { "description": "Selektionskriterien zur Ermittlung von Lagerplätzen", "properties": { "pageable": { "$ref": "#/components/schemas/core-api-QueryPageableApi" }, "storageId": { "type": "integer", "format": "int64", "description": "Lager zu dem ein Lagerplatz gehört" }, "storageAreaId": { "type": "integer", "format": "int64", "description": "Lagerbereich zu dem ein Lagerplatz gehört" }, "onlyWithoutStorageArea": { "type": "boolean", "default": false, "description": "Nur Lagerplätze ohne Lagerbereich" }, "defaultBin": { "type": "boolean", "default": false, "description": "Standard-Lagerplatz eines Lagers (nur relevant für Lager ohne Lagerplätze" }, "level1": { "type": "string", "description": "Ebene1" }, "level2": { "type": "string", "description": "Ebene2" }, "level3": { "type": "string", "description": "Ebene3" }, "level4": { "type": "string", "description": "Ebene4" }, "level5": { "type": "string", "description": "Ebene5" }, "level6": { "type": "string", "description": "Ebene6" }, "shelfSpace": { "type": "boolean", "default": false, "description": "Normaler Regalplatz?" }, "forIncomingGoods": { "type": "boolean", "default": false, "description": "Für Wareneingang?" }, "palletSpace": { "type": "boolean", "default": false, "description": "Für Paletten/Nachschubmengen?" }, "clarifySpace": { "type": "boolean", "default": false, "description": "Zur Klärung?" }, "forReturnedGoods": { "type": "boolean", "default": false, "description": "Für Retouren?" }, "useInAvailabilityDetermination": { "type": "boolean", "default": false, "description": "Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?" }, "state": { "type": "string", "description": "Status eines Lagerplatzes", "enum": [ "ACTIVE", "INACTIVE", "SUSPENDED", "BLOCKED_FOR_INVENTORY" ] }, "maxAllowedWeight": { "$ref": "#/components/schemas/erp-stock-StorageBinSelectionApi.Range" }, "heightInCM": { "$ref": "#/components/schemas/erp-stock-StorageBinSelectionApi.Range" }, "widthInCM": { "$ref": "#/components/schemas/erp-stock-StorageBinSelectionApi.Range" }, "depthInCM": { "$ref": "#/components/schemas/erp-stock-StorageBinSelectionApi.Range" } } }, "erp-stock-StorageBinSelectionApi.Range": { "description": "Selektionsbereich von/bis", "properties": { "from": { "type": "number" }, "to": { "type": "number" } } }, "erp-wms-InventoryProcessingRequest": { "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "inventoryId": { "type": "integer", "format": "int64", "description": "ID der aktuellen Inventur" }, "areaToCount": { "type": "string", "description": "Aktueller Inventurzählbereich" }, "processedCountingIds": { "type": "array", "description": "IDs der aktuell erfasstem Zähllisten-Positionen zu einer Inventur", "items": { "type": "integer", "format": "int64", "description": "IDs der aktuell erfasstem Zähllisten-Positionen zu einer Inventur" } }, "lastProcessedCountingId": { "type": "integer", "format": "int64", "description": "ID der letzten verarbeiteten Position einer Zählliste zur Inventur" }, "storageBinId": { "type": "integer", "format": "int64", "description": "ID vom aktueller Lagerplatz" }, "articleId": { "type": "integer", "format": "int64", "description": "ID vom aktuellen Artikel" }, "serialNumberId": { "type": "integer", "format": "int64", "description": "ID der aktuellen Seriennummer/Charge" }, "manualQuantityChange": { "type": "number", "description": "Manuelle Mengenänderung" }, "absoluteManualQuantityChange": { "type": "boolean" } } }, "erp-wms-InventoryProcessingResponse": { "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "inventory": { "$ref": "#/components/schemas/erp-wms-Inventory" }, "areaToCount": { "type": "string", "description": "Zu zählender Inventurzählbereich" }, "inventoryCountings": { "type": "array", "description": "Aktuell erfasste Zähllisten-Positionen zu einer Inventur", "items": { "$ref": "#/components/schemas/erp-wms-InventoryCounting" } }, "lastProcessedCountingId": { "type": "integer", "format": "int64", "description": "ID der letzten verarbeitete Position der Zählliste" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "storageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" } } }, "node-api-MultiTenantWebsocketTokenDto": { "properties": { "userId": { "type": "integer", "format": "int64", "description": "USER ID" }, "tokenKey": { "type": "string", "description": "Token Key" }, "token": { "type": "string", "description": "Token" }, "tenantId": { "type": "integer", "format": "int64", "description": "USER ID" } } }, "erp-rma-ReturnReceivingRequest": { "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "returnReceivingId": { "type": "integer", "format": "int64", "description": "ID eines laufenden Vorgangs" }, "returnReceivingLineId": { "type": "integer", "format": "int64", "description": "ID einer bestimmten Position (optional)" }, "quantity": { "type": "number", "description": "Menge (optional)" }, "action": { "type": "string", "description": "Auszuführende Aktion", "enum": [ "NONE", "ADD_LINE", "REMOVE_LINE", "ADD_UNKNOWN_ARTICLE", "FINISH", "CANCEL" ] }, "chosenAccountId": { "type": "integer", "format": "int64", "description": "Gewählter Account" }, "chosenDocumentId": { "type": "integer", "format": "int64", "description": "Gewählter Beleg" }, "chosenDocumentLineId": { "type": "integer", "format": "int64", "description": "Gewählte Belegposition" }, "chosenReturnReceivingComponentInfoId": { "type": "integer", "format": "int64", "description": "Gewählte Komponenten-Info der Retourenannahmeposition" } } }, "erp-rma-DocumentLineCandidateInfo": { "description": "Kandidaten-Belegpositionen bei mehrdeutiger Artikelzuordnung", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "position": { "type": "integer", "format": "int32", "description": "Position" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "articleName": { "type": "string", "description": "Artikelname" }, "quantity": { "type": "number", "description": "Menge" }, "documentRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "componentRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-rma-ReturnHandlingLineInfo": { "description": "Alle Positionen des Vorgangs", "properties": { "returnReceivingLineId": { "type": "integer", "format": "int64", "description": "ID der referenzierten Retourenannahmeposition" }, "documentLineId": { "type": "integer", "format": "int64", "description": "ID der referenzierten Belegposition" }, "position": { "type": "integer", "format": "int32", "description": "Position" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "articleNumber": { "type": "string", "description": "Artikelnummer" }, "componentInfos": { "type": "array", "description": "Erfasste Mengen/Seriennummern je Komponente", "items": { "$ref": "#/components/schemas/erp-rma-ReturnReceivingComponentInfo" } }, "quantity": { "type": "number", "description": "Menge" }, "returnCauseRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "processingState": { "type": "string", "description": "Verarbeitungsstatus" }, "documentRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "targetStorageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "returnValidity": { "type": "string", "description": "Retouren-Gültigkeit" }, "returnType": { "type": "string", "description": "Art der Retoure (MONEY, GOODS, UNDECIDED)" } } }, "erp-rma-ReturnReceivingComponentInfo": { "description": "Erfasste Mengen/Seriennummern je Komponente", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "quantity": { "type": "number", "description": "Menge" }, "serialNumberRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "sourceComponentRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-rma-ReturnReceivingResponse": { "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "returnReceivingRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "returnReceivingNumber": { "type": "string", "description": "Vorgangsnummer" }, "returnReceivingState": { "type": "string", "description": "Status des Vorgangs" }, "returnCauseRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "lineCount": { "type": "integer", "format": "int32", "description": "Anzahl der Positionen im Vorgang" }, "lines": { "type": "array", "description": "Alle Positionen des Vorgangs", "items": { "$ref": "#/components/schemas/erp-rma-ReturnHandlingLineInfo" } }, "currentReturnReceivingLineId": { "type": "integer", "format": "int64", "description": "ID der aktuell selektierten Position" }, "unknownArticleInputs": { "type": "array", "description": "Gescannte Eingaben für unbekannte Artikel", "items": { "type": "string", "description": "Gescannte Eingaben für unbekannte Artikel" } }, "documentRef": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "storageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumberRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "candidateDocumentLines": { "type": "array", "description": "Kandidaten-Belegpositionen bei mehrdeutiger Artikelzuordnung", "items": { "$ref": "#/components/schemas/erp-rma-DocumentLineCandidateInfo" } } } }, "erp-rma-ReturnProcessingRequest": { "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "returnReceivingId": { "type": "integer", "format": "int64", "description": "ID eines laufenden Vorgangs" }, "returnReceivingLineId": { "type": "integer", "format": "int64", "description": "ID einer bestimmten Position (optional)" }, "quantity": { "type": "number", "description": "Menge (optional)" }, "action": { "type": "string", "description": "Auszuführende Aktion", "enum": [ "NONE", "SET_RETURN_VALIDITY_FOR_LINE", "FINISH" ] } } }, "erp-rma-ReturnProcessingResponse": { "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "returnReceivingRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "returnReceivingNumber": { "type": "string", "description": "Vorgangsnummer" }, "returnReceivingState": { "type": "string", "description": "Status des Vorgangs" }, "returnCauseRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "lineCount": { "type": "integer", "format": "int32", "description": "Anzahl der Positionen im Vorgang" }, "lines": { "type": "array", "description": "Alle Positionen des Vorgangs", "items": { "$ref": "#/components/schemas/erp-rma-ReturnHandlingLineInfo" } }, "currentReturnReceivingLineId": { "type": "integer", "format": "int64", "description": "ID der aktuell selektierten Position" }, "unknownArticleInputs": { "type": "array", "description": "Gescannte Eingaben für unbekannte Artikel", "items": { "type": "string", "description": "Gescannte Eingaben für unbekannte Artikel" } } } }, "erp-stock-StorageBinGenerateRequest": { "description": "Infos zur Generierung von Lagerplätzen", "properties": { "storageId": { "type": "integer", "format": "int64", "description": "ID des Lagers, für das die Lagerplätze generiert werden sollen" }, "storageAreaId": { "type": "integer", "format": "int64", "description": "Lagerbereich, zu dem dieser Lagerplatz gehört" }, "numOfLevels": { "type": "integer", "format": "int32", "description": "Anzahl der Ebenen", "maximum": 6, "minimum": 1 }, "rangeLevel1": { "$ref": "#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange" }, "rangeLevel2": { "$ref": "#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange" }, "rangeLevel3": { "$ref": "#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange" }, "rangeLevel4": { "$ref": "#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange" }, "rangeLevel5": { "$ref": "#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange" }, "rangeLevel6": { "$ref": "#/components/schemas/erp-stock-StorageBinGenerateRequest.LevelRange" }, "generateUniqueIdentifier": { "type": "boolean", "default": false, "description": "Sollen eindeutige Identifier für die Lagerplätze generiert werden" }, "startOfRoutePosition": { "type": "integer", "format": "int32", "description": "Start der Laufwegposition für diese generierten Lagerplätze" }, "shelfSpace": { "type": "boolean", "default": false, "description": "Normaler Regalplatz?" }, "forIncomingGoods": { "type": "boolean", "default": false, "description": "Für Wareneingang?" }, "palletSpace": { "type": "boolean", "default": false, "description": "Für Paletten/Nachschubmengen?" }, "clarifySpace": { "type": "boolean", "default": false, "description": "Zur Klärung?" }, "forReturnedGoods": { "type": "boolean", "default": false, "description": "Für Retouren?" }, "useInAvailabilityDetermination": { "type": "boolean", "default": false, "description": "Soll der Lagerplatz in der Ermittlung der verfügbaren Mengen beachtet werden?" }, "maxAllowedWeight": { "type": "number", "description": "Maximal zulässiges Gewicht" }, "heightInCM": { "type": "number", "description": "Höhe in CM" }, "widthInCM": { "type": "number", "description": "Breite in CM" }, "depthInCM": { "type": "number", "description": "Tiefe in CM" }, "color": { "type": "string", "description": "Farbe zur Anzeige", "pattern": "^#[0-9A-Fa-f]{6}$" }, "separator": { "type": "string", "description": "Trenner", "pattern": "^[-/_\\\\| ]+$" } }, "required": [ "numOfLevels" ] }, "erp-stock-StorageBinGenerateRequest.LevelRange": { "description": "Bereich für eine Ebene", "properties": { "from": { "type": "string" }, "to": { "type": "string" } } }, "erp-stock-StockTransferApi": { "description": "Infos zur Durchführung einer Lagerumbuchung", "properties": { "articleId": { "type": "integer", "format": "int64", "description": "Artikel" }, "serialNumberId": { "type": "integer", "format": "int64", "description": "Seriennummer" }, "bookDate": { "type": "string", "format": "date", "description": "Buchungsdatum" }, "quantity": { "type": "number", "description": "Menge" }, "note": { "type": "string", "description": "Bemerkung" }, "sourceStorageId": { "type": "integer", "format": "int64", "description": "Quell-Lager" }, "sourceStorageBinId": { "type": "integer", "format": "int64", "description": "Quell-Lagerplatz" }, "targetStorageId": { "type": "integer", "format": "int64", "description": "Ziel-Lager" }, "targetStorageBinId": { "type": "integer", "format": "int64", "description": "Ziel-Lagerplatz" }, "picklistLineComponentId": { "type": "integer", "format": "int64", "description": "Komponente einer Picklistenposition, falls dafür die Buchung stattfindet" } }, "required": [ "articleId", "quantity", "sourceStorageId", "targetStorageId" ] }, "erp-stock-StockTransferResult": { "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-DummySerialNumberStockTransferApi": { "description": "Infos zur Umbuchung einer Dummy-Seriennummer in eine gültige Seriennummer", "properties": { "articleId": { "type": "integer", "format": "int64", "description": "Artikel" }, "serialNumberId": { "type": "integer", "format": "int64", "description": "Seriennummer" }, "bookDate": { "type": "string", "format": "date", "description": "Buchungsdatum" }, "quantity": { "type": "number", "description": "Menge" }, "note": { "type": "string", "description": "Bemerkung" }, "sourceStorageId": { "type": "integer", "format": "int64", "description": "Quell-Lager" }, "sourceStorageBinId": { "type": "integer", "format": "int64", "description": "Quell-Lagerplatz" }, "targetStorageId": { "type": "integer", "format": "int64", "description": "Ziel-Lager" }, "targetStorageBinId": { "type": "integer", "format": "int64", "description": "Ziel-Lagerplatz" }, "picklistLineComponentId": { "type": "integer", "format": "int64", "description": "Komponente einer Picklistenposition, falls dafür die Buchung stattfindet" }, "targetSerialNumber": { "type": "string", "description": "Die gültige Seriennummer" }, "targetExpiryDate": { "type": "string", "format": "date", "description": "Ggf. ein MHD-/Verfallsdatum, falls der Artikel ein solches benötigt" } }, "required": [ "articleId", "quantity", "sourceStorageId", "targetStorageId" ] }, "erp-stock-StockMovementManualApi": { "description": "Infos zur Durchführung einer manuellen Lagerbuchung", "properties": { "factor": { "type": "string", "description": "Zugang oder Abgang", "enum": [ "NONE", "INCREMENT", "DECREMENT" ] }, "articleId": { "type": "string", "description": "Artikel" }, "quantity": { "type": "number", "description": "Menge", "minimum": 0 }, "note": { "type": "string", "description": "Bemerkung" }, "storageId": { "type": "string", "description": "Lager" }, "storageBinId": { "type": "string", "description": "Lagerplatz" }, "storageLocation": { "type": "string", "description": "Lagerort (spielt nur bei Zugängen eine Rolle)" }, "purchasePrice": { "type": "number", "description": "EK pro Preiseinheit (siehe priceUnit); spielt nur bei Zugängen eine Rolle" }, "priceUnit": { "type": "number", "description": "Preiseinheit, auf die sich der EK bezieht", "minimum": 0 }, "serialNumber1": { "type": "string", "description": "Seriennummer 1, welche gebucht werden soll" }, "serialNumber2": { "type": "string", "description": "Seriennummer 2, welche gebucht werden soll" }, "expiryDate": { "type": "string", "format": "date", "description": "Haltbarkeitsdatum" }, "serialNumberNote": { "type": "string", "description": "Notiz zur Seriennummer" } }, "required": [ "articleId", "factor", "quantity", "storageId" ] }, "erp-stock-BulkTransferRequestApi": { "description": "Infos zur Durchführung einer Stapel-Lagerumbuchung", "properties": { "createReportAfterTransfer": { "type": "boolean", "description": "Soll nach der Umbuchung ein Report dazu erstellt werden?" }, "stockTransfers": { "type": "array", "description": "Enthält die Anweisungen für die Umbuchungen", "items": { "$ref": "#/components/schemas/erp-stock-StockTransferApi" } } } }, "erp-stock-BulkTransferResult": { "description": "Infos zur Durchführung einer Stapel-Lagerumbuchung", "properties": { "reportId": { "type": "integer", "format": "int64", "description": "Falls der Report im Request angefordert wurde, wird hier die ID aus dem DMS geliefert" }, "stocks": { "type": "array", "description": "Die durch die Lagerbuchung geänderten Lagerplatz-Bestände", "items": { "$ref": "#/components/schemas/erp-stock-StockTransferResult" } }, "date": { "type": "string", "format": "date", "description": "Das Buchungsdatum" } } }, "erp-statistic-DataSeriesRequest": { "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", "default": false, "description": "sollen Zeiteinheiten ohne Datenwerte mit zurückgeliefert werden?" }, "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": { "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": { "description": "List of series entries", "properties": { "entryLabel": { "type": "integer", "format": "int64", "description": "the position of this Entry with respect to the given TimeSeriesGrouping " }, "value": { "type": "array", "description": "value of this entry", "items": { "type": "object", "description": "value of this entry" } } } }, "erp-product-ArticleCopyEntry": { "description": "Mapping of Articles to be copied", "properties": { "originalArticleId": { "type": "string", "description": "ID of original article" }, "newNumber": { "type": "string", "description": "new number for the copy", "minLength": 1 } }, "required": [ "newNumber" ] }, "erp-product-ProductCopyCommand": { "properties": { "modules": { "type": "array", "description": "Relations to be copied", "items": { "type": "string", "description": "Relations to be copied", "enum": [ "CUSTOM", "CUSTOMERS", "MEDIA", "SUPPLIERS", "TEXTS", "PRICES", "SERIAL_NUMBER" ] }, "uniqueItems": true }, "copyEntries": { "type": "array", "description": "Mapping of Articles to be copied", "items": { "$ref": "#/components/schemas/erp-product-ArticleCopyEntry" }, "minItems": 1, "uniqueItems": true }, "productType": { "type": "string", "description": "Artikelarten", "enum": [ "WITH_STOCK", "WITHOUT_STOCK", "SERVICE_ARTICLE", "SERVICE_CONTINGENT", "ASSEMBLY_GROUP", "JUMBO", "SHIPPING_COSTS", "VARIANT_MAIN_ARTICLE" ] } }, "required": [ "copyEntries" ] }, "erp-product-PriceRecalculationByPurchasePriceRequest": { "description": "Request zur Durchführung der Neuberechnung von Verkaufspreisen bzgl. des EK", "properties": { "articleIdsForRecalculation": { "type": "array", "description": "IDs von Artikeln, deren Preise berechnet werden sollen", "items": { "type": "integer", "format": "int64", "description": "IDs von Artikeln, deren Preise berechnet werden sollen" } }, "articleQueryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "variables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" } } }, "erp-product-ProductVariantUpdateRequest": { "properties": { "mainArticleId": { "type": "integer", "format": "int64", "description": "ID des Hauptartikels" }, "fields": { "type": "array", "description": "zu übertragende Bereiche", "items": { "type": "string", "description": "Bereiche, die vom Variantenhauptartikel auf die Variantenartikel übertragen werden können", "enum": [ "PRICES", "MANUFACTURER", "PRODUCT_GROUP", "SUPPLIER_RELATIONS", "ARTICLE_DESCRIPTIONS", "CUSTOM_FIELDS" ] } } }, "required": [ "mainArticleId" ] }, "erp-product-ProductVariantCreationRequest": { "description": "Request zur Erstellung von Product Varianten", "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", "format": "int64", "description": "combinations of values" } } }, "blackListedCombinations": { "type": "array", "description": "blacklisted combinations of values", "items": { "type": "array", "description": "blacklisted combinations of values", "items": { "type": "integer", "format": "int64", "description": "blacklisted combinations of values" } } }, "productType": { "type": "string", "description": "Artikelarten", "enum": [ "WITH_STOCK", "WITHOUT_STOCK", "SERVICE_ARTICLE", "SERVICE_CONTINGENT", "ASSEMBLY_GROUP", "JUMBO", "SHIPPING_COSTS", "VARIANT_MAIN_ARTICLE" ] }, "createTemplateId": { "type": "integer", "format": "int64", "description": "Vorlage zum Erstellen der Variantenartikel" } }, "required": [ "productType" ] }, "erp-payment-DunningPayment": { "description": "Alle Mahnzahlungen", "properties": { "dunningAmount": { "type": "number", "description": "Wieviel wird auf die Mahnung gezahlt" }, "dunningRecordId": { "type": "integer", "format": "int64", "description": "Welche Mahnung wird damit bezahlt" } } }, "erp-payment-Payment": { "description": "beschreibt eine geleistete Zahlung. eins von openItemReceiptId oder openItemId muss gefüllt sein", "properties": { "paymentDate": { "type": "string", "format": "date", "description": "der zahlungstag" }, "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ährte/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", "default": false, "description": "Ist diese Zahlung für die Anzahlung/Vorkasse gedacht" }, "dunningPayments": { "type": "array", "description": "Alle Mahnzahlungen", "items": { "$ref": "#/components/schemas/erp-payment-DunningPayment" } } }, "required": [ "paymentAmount", "paymentDate", "paymentMethodId" ] }, "erp-finance-ManualPaymentResponse": { "properties": { "message": { "type": "array", "description": "Problems with the manual payment", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" }, "readOnly": true } } }, "erp-finance-PaymentRevertRequest": { "properties": { "openItemRecordId": { "type": "integer", "format": "int64", "description": "ID des Records, der storniert werden soll" }, "comment": { "type": "string", "description": "Kommentar zur Stornierung" } }, "required": [ "openItemRecordId" ] }, "erp-finance-OpenItemMatchingRequest": { "properties": { "openItemMatchingRules": { "type": "array", "description": "Passende Regeln", "items": { "$ref": "#/components/schemas/erp-finance-OpenItemMatchingRule" } }, "bankId": { "type": "integer", "format": "int64", "description": "Bank für den Abgleich" }, "bankAccountId": { "type": "integer", "format": "int64", "description": "Bankkonto für den Abgleich nach Import der Banktransaktionen pro Bankkonto" }, "loggingLevels": { "type": "array", "description": "Logging Level", "items": { "type": "string", "description": "Logging Level", "enum": [ "ERROR", "WARN", "INFO", "DEBUG", "TRACE" ] } } } }, "erp-finance-SyncMarkRequest": { "properties": { "bankAccountId": { "type": "integer", "format": "int64", "description": "Id des BankAccounts, zu dem die Transaktionen verarbeitet werden" }, "minimumPoints": { "type": "integer", "format": "int32", "description": "Wieviele Punkte sind unser unteres Limit fürs Vormerken der Buchung" } } }, "erp-finance-TransactionFinalizationPointsRequest": { "properties": { "accountId": { "type": "integer", "format": "int64", "description": "ID eines Accounts" }, "points": { "type": "integer", "format": "int32", "description": "Die Punkte, ab denen verbucht werden soll" } } }, "erp-finance-OpenItemTransactionDistribution": { "description": "matches", "properties": { "openItemTransactionDistributionData": { "type": "array", "description": "Transaktionsverteilungsdaten", "items": { "$ref": "#/components/schemas/erp-finance-OpenItemTransactionDistributionData" } }, "transactionId": { "type": "integer", "format": "int64", "description": "transaction Id" }, "forceComplete": { "type": "boolean", "description": "erzwungener Abschluss" } } }, "erp-finance-OpenItemTransactionDistributionData": { "description": "Transaktionsverteilungsdaten", "properties": { "openItemId": { "type": "integer", "format": "int64", "description": "item Id" }, "reasoning": { "type": "string", "description": "Argumentation" } } }, "erp-finance-OpenItemTransactionFinalizationRequest": { "properties": { "matches": { "type": "array", "description": "matches", "items": { "$ref": "#/components/schemas/erp-finance-OpenItemTransactionDistribution" } } } }, "erp-finance-DiscountCalculationResponse": { "properties": { "discountDate": { "type": "string", "format": "date", "description": "Skontodatum" }, "discountAmount": { "type": "number", "description": "Skontobetrag" }, "isApplicable": { "type": "boolean", "description": "Skonto ist anwandbar" } } }, "erp-finance-OpenItemTransactionReassignRequest": { "properties": { "targetOpenItemId": { "type": "integer", "format": "int64", "description": "neuer OP dem die Transaction zugewiesen werden soll" } } }, "erp-finance-ClearingResponse": { "properties": { "firstOpenItemId": { "type": "integer", "format": "int64", "description": "ID des ersten OPs" }, "secondOpenItemId": { "type": "integer", "format": "int64", "description": "ID des zweiten OPs" }, "clearedAmount": { "type": "number", "description": "Verrechneter Betrag" } } }, "erp-finance-OpenItemRecalculateRequest": { "properties": { "grantDeliveryApproval": { "type": "boolean", "description": "Lieferfreigabe erteilen" }, "newBalance": { "type": "number", "description": "neuer Saldo" } } }, "erp-finance-OpenItemPlanRunRequest": { "properties": { "dueDate": { "type": "string", "format": "date", "description": "Fälligkeit der nächsten Buchung" }, "accountIds": { "type": "array", "description": "Einschränkung auf spezielle Adressen?", "items": { "type": "integer", "format": "int64", "description": "Einschränkung auf spezielle Adressen?" } }, "startDate": { "type": "string", "format": "date", "description": "Starttag des Zahlungsplanes - bis" }, "endDate": { "type": "string", "format": "date", "description": "Endtag des Zahlungsplanes - bis" } }, "required": [ "dueDate" ] }, "erp-finance-PaymentCreationResponseDetail": { "properties": { "payment": { "$ref": "#/components/schemas/erp-bank-BankPayment" }, "messages": { "type": "array", "description": "Meldungen", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" } } } }, "erp-finance-OpenItemDunningChargeRequest": { "properties": { "dunningFee": { "type": "number", "description": "Mahngebühr" }, "dunningInterest": { "type": "number", "description": "Mahnzins" }, "comment": { "type": "string", "description": "freie Bemerkung zur Mahngebühr" } } }, "erp-finance-TransactionToOpenItemRequest": { "properties": { "transactionId": { "type": "integer", "format": "int64", "description": "ID of the bank transaction" }, "accountId": { "type": "integer", "format": "int64", "description": "ID of the account the new open item is assigned to" }, "paymentMethodId": { "type": "integer", "format": "int64", "description": "ID of the payment method to set on the open item" }, "bookingAccountType": { "type": "string", "description": "Booking account type: CUSTOMER (debtor) or SUPPLIER (creditor)", "enum": [ "CUSTOMER", "SUPPLIER" ] } }, "required": [ "bookingAccountType" ] }, "erp-finance-OpenItemReopenRequest": { "properties": { "comment": { "type": "string", "description": "Kommentar zur Wiederöffnung" }, "businessTransactionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-finance-OpenItemCloseRequest": { "properties": { "reimbursePayments": { "type": "boolean", "description": "bisherige Zahlungen zurückerstatten" }, "comment": { "type": "string", "description": "Kommentar zur Schliessung" }, "closeableAmount": { "type": "number", "description": "Betrag zur Schliessung" }, "businessTransactionRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "grantDeliveryApproval": { "type": "boolean", "description": "Lieferfreigabe erteilen" } } }, "erp-finance-OpenItemCloseableAmounts": { "properties": { "reimbursableAmount": { "type": "number", "description": "zurückzuerstattender Betrag" }, "cancellationDunningAmount": { "type": "number", "description": "zurückzubuchende Mahnbeträge" }, "closeableAmount": { "type": "number", "description": "abzuschliessender Betrag" } } }, "erp-finance-OpenItemOffsetLine": { "description": "Die einzelnen Verrechnungen (Gutschrift gegen Rechnung)", "properties": { "receivableOpenItemId": { "type": "integer", "format": "int64", "description": "ID des Rechnungs-OPs (Forderung)" }, "receivableNumber": { "type": "string", "description": "Nummer des Rechnungs-OPs" }, "creditNoteOpenItemId": { "type": "integer", "format": "int64", "description": "ID des Gutschrift-OPs (Verbindlichkeit)" }, "creditNoteNumber": { "type": "string", "description": "Nummer des Gutschrift-OPs" }, "offsetAmount": { "type": "number", "description": "Verrechneter Betrag" }, "currencyCode": { "type": "string", "description": "Währung der Verrechnung (ISO-Code)" } } }, "erp-finance-OpenItemOffsetResult": { "properties": { "preview": { "type": "boolean", "default": false, "description": "true = nur Vorschau (es wurde nicht gebucht), false = tatsächlich verrechnet" }, "totalOffsetAmount": { "type": "number", "description": "Gesamtsumme der verrechneten Beträge" }, "lines": { "type": "array", "description": "Die einzelnen Verrechnungen (Gutschrift gegen Rechnung)", "items": { "$ref": "#/components/schemas/erp-finance-OpenItemOffsetLine" } } } }, "erp-finance-DunningRunRequest": { "properties": { "paymentDueDate": { "type": "string", "format": "date", "description": "Fälligkeitsdatum (Stichtag: nur bis dahin fällige OPs)" }, "includeAccountIds": { "type": "array", "description": "Account-IDs, deren fällige OPs gemahnt werden (leer = alle fälligen mahnbaren Accounts)", "items": { "type": "integer", "format": "int64", "description": "Account-IDs, deren fällige OPs gemahnt werden (leer = alle fälligen mahnbaren Accounts)" } }, "excludeAccountIds": { "type": "array", "description": "Account-IDs, die vom Mahnlauf ausgeschlossen werden", "items": { "type": "integer", "format": "int64", "description": "Account-IDs, die vom Mahnlauf ausgeschlossen werden" } }, "label": { "type": "string", "description": "Bezeichnung des Mahnlaufs (frei; leer wenn nicht gesetzt)" }, "grouping": { "type": "string", "description": "Gruppierung der erzeugten Mahnungen (je OP, je Kunde, je Kunde und Mahnstufe)", "enum": [ "PER_OPEN_ITEM", "PER_CUSTOMER", "PER_CUSTOMER_AND_LEVEL" ] }, "feeHandling": { "type": "string", "description": "Umgang mit der Mahngebühr (verteilen, unterdrücken, eigener Gebühren-OP)", "enum": [ "DISTRIBUTE", "IGNORE", "OWN_OPEN_ITEM" ] }, "paymentConsideredUntil": { "type": "string", "format": "date", "description": "Zahlung berücksichtigt bis (Stichtag für den Andruck auf der Mahnung; Default: Tagesdatum)" }, "openItemIdsToProcess": { "type": "array", "description": "Explizite OP-IDs, die gemahnt werden sollen (schränkt die Kriterien-Selektion auf diese ein)", "items": { "type": "integer", "format": "int64", "description": "Explizite OP-IDs, die gemahnt werden sollen (schränkt die Kriterien-Selektion auf diese ein)" } }, "openItemIdsToIgnore": { "type": "array", "description": "OP-IDs, die vom Mahnlauf ausgeschlossen werden", "items": { "type": "integer", "format": "int64", "description": "OP-IDs, die vom Mahnlauf ausgeschlossen werden" } }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "variables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" } } }, "erp-fabrication-FabricationComponentForProduction": { "description": "Für die Produktion zu verwendendes Material", "properties": { "serialNumberId": { "type": "integer", "format": "int64", "description": "Zu produzierende Seriennummer, für die die Komponente verwendet werden" }, "documentLineComponentId": { "type": "integer", "format": "int64", "description": "ID der Komponente" }, "articleSerialNumberId": { "type": "integer", "format": "int64", "description": "ID einer Seriennummer" }, "quantity": { "type": "number", "description": "Zu verwendende Menge" } }, "required": [ "documentLineComponentId", "quantity" ] }, "erp-fabrication-FabricationRevertRequest": { "description": "Details zur Stornierung der Produktion einer Position", "properties": { "documentLineId": { "type": "integer", "format": "int64", "description": "ID der zu stornierenden Position" }, "quantity": { "type": "number", "description": "Zu stornierende Menge" }, "autoRevertComponents": { "type": "boolean", "default": true, "description": "Material automatisch stornieren" }, "serialNumbers": { "type": "array", "description": "Zu stornierende Seriennummern", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationSerialNumber" } }, "componentsToRevert": { "type": "array", "description": "Zu stornierendes Material", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationComponentForProduction" } } }, "required": [ "documentLineId", "quantity" ] }, "erp-fabrication-FabricationProduceRequest": { "description": "Details zur Produktion einer Position", "properties": { "documentLineId": { "type": "integer", "format": "int64", "description": "ID der zu produzierenden Position" }, "quantity": { "type": "number", "description": "Zu produzierende Menge" }, "autoCommitComponents": { "type": "boolean", "default": true, "description": "Material automatisch bestätigen" }, "serialNumbers": { "type": "array", "description": "Zu produzierende Seriennummern", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationSerialNumber" } }, "componentsForProduction": { "type": "array", "description": "Für die Produktion zu verwendendes Material", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationComponentForProduction" } } }, "required": [ "documentLineId", "quantity" ] }, "erp-fabrication-FabricationDefectiveRequest": { "description": "Details zur Markierung einer Position als (nicht mehr) defekt", "properties": { "quantity": { "type": "number", "default": 1, "description": "(Nicht mehr) defekte Menge", "minimum": 0 }, "serialNumberIdsWithQuantity": { "type": "array", "description": "(Nicht mehr) defekte Seriennummern", "items": { "$ref": "#/components/schemas/erp-fabrication-SerialNumberWithQuantityApi" } }, "createLineForReproduction": { "type": "boolean", "default": false, "description": "Soll eine neue Position zur Nachproduktion der defekten Artikel erstellt werden?" } } }, "erp-fabrication-SerialNumberWithQuantityApi": { "description": "Seriennummer mit Menge", "properties": { "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "quantity": { "type": "number", "description": "Menge" } } }, "erp-document-DocumentTypeTransitionRequest": { "properties": { "transitionId": { "type": "string", "description": "transition id" }, "targetTypeId": { "type": "integer", "format": "int64", "description": "Ggf. die ID der Ziel-Belegart" }, "parameters": { "type": "array", "description": "additional parameters for transition", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } }, "document": { "$ref": "#/components/schemas/erp-document-RequestDocument" } }, "required": [ "transitionId" ] }, "erp-account-TaxIDProtocol": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "accountAddressRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "documentAddressRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "taxIdentificationNumber": { "type": "string", "description": "Geprüfte Ust-ID", "maxLength": 255, "minLength": 0 }, "validity": { "type": "string", "description": "Gültigkeit einer Ust-ID", "enum": [ "NOT_YET_VALIDATED", "VALID", "VALID_WITH_INVALID_ADDRESS", "NOT_VALID" ] }, "validatedCompanyName": { "type": "string", "description": "Geprüfter Firmenname" }, "companyNameValidationResult": { "type": "string", "description": "Ergebnis der Detail-Prüfung einer Ust-ID", "enum": [ "VALID", "NOT_VALID", "NOT_REQUESTED", "NOT_DELIVERED", "UNKNOWN" ] }, "validatedCity": { "type": "string", "description": "Geprüfter Ort" }, "cityValidationResult": { "type": "string", "description": "Ergebnis der Detail-Prüfung einer Ust-ID", "enum": [ "VALID", "NOT_VALID", "NOT_REQUESTED", "NOT_DELIVERED", "UNKNOWN" ] }, "validatedPostalCode": { "type": "string", "description": "Geprüfte PLZ" }, "postalCodeValidationResult": { "type": "string", "description": "Ergebnis der Detail-Prüfung einer Ust-ID", "enum": [ "VALID", "NOT_VALID", "NOT_REQUESTED", "NOT_DELIVERED", "UNKNOWN" ] }, "validatedStreet": { "type": "string", "description": "Geprüfte Straße" }, "streetValidationResult": { "type": "string", "description": "Ergebnis der Detail-Prüfung einer Ust-ID", "enum": [ "VALID", "NOT_VALID", "NOT_REQUESTED", "NOT_DELIVERED", "UNKNOWN" ] }, "usedApi": { "type": "string", "description": "USt-ID Prüfverfahren", "enum": [ "NONE", "BZST", "VIES" ] }, "apiResultCode": { "type": "string", "description": "Ergebnis-Code der Prüfung" }, "apiResultMessage": { "type": "string", "description": "Ergebnis-Meldung der Prüfung (falls vorhanden" } } }, "erp-spi-CreateShipmentResponse": { "properties": { "shipmentId": { "type": "integer", "format": "int64", "description": "description/delivery Text of this order (internal vds description)" } } }, "erp-document-DocumentInputProcessingRequest": { "description": "Request zur Eingabeverarbeitung zu Belegen", "properties": { "inputData": { "type": "string", "description": "Benutzereingabe/Scan" }, "lastProcessedLineId": { "type": "integer", "format": "int64", "description": "Die letzte verarbeitete Position" }, "lastProcessedBookingId": { "type": "integer", "format": "int64", "description": "Die letzte verarbeitete Buchung" }, "inputList": { "type": "array", "description": "Liste von Eingaben, die nacheinander ausgeführt werden", "items": { "type": "string", "description": "Liste von Eingaben, die nacheinander ausgeführt werden" } } } }, "erp-document-DocumentInputProcessingResponse": { "description": "Response zur Eingabeverarbeitung zu Belegen", "properties": { "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "document": { "$ref": "#/components/schemas/erp-document-Document" }, "lastProcessedLineId": { "type": "integer", "format": "int64", "description": "Die letzte verarbeitete Position" }, "lastProcessedBookingId": { "type": "integer", "format": "int64", "description": "Die letzte verarbeitete Buchung" }, "validationHints": { "$ref": "#/components/schemas/erp-document-DocumentValidationHints" } } }, "erp-document-ContractEvaluationJobRequest": { "description": "Request zur Erstellung des Jobs für Abrechnungen der Verträge", "properties": { "blackList": { "type": "array", "description": "Ignore ID-List", "items": { "type": "integer", "format": "int64", "description": "Ignore ID-List" } }, "whiteList": { "type": "array", "description": "Use ID-List", "items": { "type": "integer", "format": "int64", "description": "Use ID-List" } }, "variableSubstitutionList": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "documentDate": { "type": "string", "format": "date", "description": "Abweichendes Belegdatum" }, "deliveryDate": { "type": "string", "format": "date", "description": "Abweichendes Lieferdatum" }, "addBillingPeriod": { "type": "boolean", "default": true, "description": "Abrechnungszeitraum hinzufügen?" }, "note": { "type": "string", "description": "Notiz" }, "print": { "type": "boolean", "default": false, "description": "Drucken?" } } }, "einvoice-unknownmodule-ValidationEmbeddingDetails": { "properties": { "validFileEmbedding": { "type": "boolean" }, "validFilename": { "type": "boolean" }, "validXMP": { "type": "boolean" }, "canExtractXML": { "type": "boolean" }, "versionFromXML": { "type": "string" }, "documentTypeFromXML": { "type": "string" }, "guidelineFromXML": { "type": "string" }, "variantFromXML": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } }, "information": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } } } }, "einvoice-unknownmodule-ValidationPdfDetails": { "properties": { "valid": { "type": "boolean" }, "foundFlavour": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } }, "information": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } } } }, "einvoice-unknownmodule-ValidationResponse": { "properties": { "xmlDetails": { "$ref": "#/components/schemas/einvoice-unknownmodule-ValidationXmlDetails" }, "pdfDetails": { "$ref": "#/components/schemas/einvoice-unknownmodule-ValidationPdfDetails" }, "embeddingDetails": { "$ref": "#/components/schemas/einvoice-unknownmodule-ValidationEmbeddingDetails" }, "systemError": { "type": "string" }, "shelfDocumentId": { "type": "integer", "format": "int64" } } }, "einvoice-unknownmodule-ValidationXmlDetails": { "properties": { "valid": { "type": "boolean" }, "hasWarnings": { "type": "boolean" }, "validSchema": { "type": "boolean" }, "validNamespaces": { "type": "boolean" }, "validEncoding": { "type": "boolean" }, "validCodelists": { "type": "boolean" }, "validFormat": { "type": "boolean" }, "validVat": { "type": "boolean" }, "validBusinessRules": { "type": "boolean" }, "validProfile": { "type": "array", "items": { "$ref": "#/components/schemas/einvoice-unknownmodule-ValidationXmlType" } }, "warnings": { "type": "array", "items": { "type": "string" } }, "information": { "type": "array", "items": { "type": "string" } }, "errors": { "type": "array", "items": { "type": "string" } } } }, "einvoice-unknownmodule-ValidationXmlType": { "properties": { "value": { "type": "boolean" }, "profile": { "type": "integer", "format": "int32" } } }, "erp-document-DocumentMultipleLinesRequest": { "properties": { "documentLines": { "type": "array", "description": "Die neuen Belegpositionen", "items": { "$ref": "#/components/schemas/erp-document-DocumentLine" } }, "incomingGoodsPickTrolleyId": { "type": "integer", "format": "int64", "description": "ID vom Pickwagen für den Wareneingang (wenn incomingGoodsStorageBinId = null)" }, "incomingGoodsStorageBinId": { "type": "integer", "format": "int64", "description": "ID vom Lagerplatz für den Wareneingang (wenn incomingGoodsPickTrolleyId = null)" }, "additionalParameters": { "type": "array", "description": "Zusätzliche Parameter und Benutzerentscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-document-DocumentMultipleSourceLinesRequest": { "description": "Request zum Hinzufügen von mehreren Quell-Positionen zu einem Dokument", "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", "format": "int64", "description": "IDs von DocumentLines, die ignoriert werden sollen" } }, "sourceLineIdsToAdd": { "type": "array", "description": "IDs von DocumentLines, die als Quelle dem Dokument hinzugefügt werden sollen", "items": { "type": "integer", "format": "int64", "description": "IDs von DocumentLines, die als Quelle dem Dokument hinzugefügt werden sollen" } } } }, "erp-document-SalesSingleCollectiveInvoiceRequest": { "properties": { "accountId": { "type": "string", "description": "Account Id" }, "deliveryDocumentVariables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "deliveryDocumentQueryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "deliveryDocumentIdsToIgnore": { "type": "array", "description": "IDs von Lieferscheinen, die (nach der Template-Auflösung) ignoriert werden sollen.", "items": { "type": "integer", "format": "int64", "description": "IDs von Lieferscheinen, die (nach der Template-Auflösung) ignoriert werden sollen." } }, "deliveryDocumentIdsToAdd": { "type": "array", "description": "IDs von Lieferscheinen, die explizit verarbeitet werden sollen. Wenn gesetzt, werden Predicate und Variables nicht ausgewertet.", "items": { "type": "integer", "format": "int64", "description": "IDs von Lieferscheinen, die explizit verarbeitet werden sollen. Wenn gesetzt, werden Predicate und Variables nicht ausgewertet." } } }, "required": [ "accountId" ] }, "erp-document-SalesMultiCollectiveInvoiceRequest": { "properties": { "accountVariables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "accountQueryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "accountIdsToIgnore": { "type": "array", "description": "IDs von Accounts, die (nach der Template-Auflösung) ignoriert werden sollen.", "items": { "type": "integer", "format": "int64", "description": "IDs von Accounts, die (nach der Template-Auflösung) ignoriert werden sollen." } }, "accountIdsToAdd": { "type": "array", "description": "IDs von Accounts, die explizit verarbeitet werden sollen. Wenn gesetzt, werden Predicate und Variables nicht ausgewertet.", "items": { "type": "integer", "format": "int64", "description": "IDs von Accounts, die explizit verarbeitet werden sollen. Wenn gesetzt, werden Predicate und Variables nicht ausgewertet." } }, "deliveryDocumentVariables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "deliveryDocumentQueryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "dueDate": { "type": "string", "format": "date", "description": "Stichtag des Laufs. Nur Accounts mit Customer#dueDateSchedule.dueDate kleiner/gleich diesem Datum werden verarbeitet." } }, "required": [ "dueDate" ] }, "erp-crm-CrmDealVisibilityUpdateRequest": { "description": "Request zur Aktualisierung von Sichtbarkeiten zu Deals", "properties": { "dealUserId": { "type": "integer", "format": "int64", "description": "ID vom User, zu dem die lese-berechtigten Benutzer aktualisert werden sollen" }, "readPermittedUserIds": { "type": "array", "description": "Die IDs der lese-berechtigten Benutzer", "items": { "type": "integer", "format": "int64", "description": "Die IDs der lese-berechtigten Benutzer" } } }, "required": [ "dealUserId", "readPermittedUserIds" ] }, "erp-crm-CrmActivityPerformBillingRequest": { "description": "Request zur Durchführung der Abrechnung von Aktivitäten", "properties": { "variables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "crmActivityIdsToIgnore": { "type": "array", "description": "IDs von Aktivitäten, die nicht abgerechnet werden sollen", "items": { "type": "integer", "format": "int64", "description": "IDs von Aktivitäten, die nicht abgerechnet werden sollen" } }, "crmActivityIdsToBill": { "type": "array", "description": "IDs von Aktivitäten, die abgerechnet werden sollen", "items": { "type": "integer", "format": "int64", "description": "IDs von Aktivitäten, die abgerechnet werden sollen" } } } }, "erp-crm-CreateActivityByEmailRequest": { "description": "Request zum Anlegen einer Aktivität E-Mail", "properties": { "crmId": { "type": "integer", "format": "int64", "description": "ID vom CRM-Objekt" }, "crmType": { "type": "string", "description": "Möglich CRM-Typen", "enum": [ "TASK", "DEAL", "PROJECT" ] }, "accountId": { "type": "integer", "format": "int64", "description": "ID vom Account" }, "emailsAsProcessing": { "type": "boolean", "default": false, "description": "Soll die Aktivität als \"E-Mail-Bearbeitung\" angelegt werden?" } } }, "erp-commission-CommissionExportFile": { "description": "export files", "properties": { "shelfDocumentId": { "type": "integer", "format": "int64", "description": "Shelf Document ID" }, "description": { "type": "string", "description": "Beschreibung" } } }, "erp-commission-CommissionRun": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "number": { "type": "string", "description": "number of commission run", "maxLength": 255, "minLength": 0 }, "runState": { "type": "string", "description": "Verarbeitungsstatus Provisionslauf", "enum": [ "OPEN", "COMMITTED", "REVERTED" ], "readOnly": true }, "salesAgents": { "type": "array", "description": "sales agents", "items": { "$ref": "#/components/schemas/erp-commission-CommissionRunSalesAgent" }, "readOnly": true }, "runDate": { "type": "string", "format": "date", "description": "run date", "readOnly": true }, "dateFrom": { "type": "string", "format": "date", "description": "date from", "readOnly": true }, "dateTo": { "type": "string", "format": "date", "description": "date to", "readOnly": true }, "numberFrom": { "type": "string", "description": "SalesAgent number from", "readOnly": true }, "numberTo": { "type": "string", "description": "SalesAgent number to", "readOnly": true } } }, "erp-commission-CommissionRunFee": { "description": "fees", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "commissionDate": { "type": "string", "format": "date", "description": "Commission Date" }, "description": { "type": "string", "description": "Description" }, "comment": { "type": "string", "description": "User comment" }, "valueType": { "type": "string", "description": "Typ von Werten", "enum": [ "PERCENT", "FIX" ] }, "value": { "type": "number", "description": "Commission Value" }, "valueCurrencyCode": { "type": "string", "description": "the currency-code IsoAlpha3 for the fee value" }, "feeOrigin": { "type": "string", "description": "Fee origin type", "enum": [ "USER_DEFINED", "USER_DEFINED_REVERTED", "SALES_DOCUMENT", "SALES_DOCUMENT_REVERTED" ] }, "valueOrigin": { "type": "string", "description": "value origin", "enum": [ "NOT_COMMISSIONABLE", "USER_DEFINED", "AUTOMATIC", "PREDECESSOR", "RECALCULATE" ] }, "originReference": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "commissionableNetPrice": { "type": "number", "description": "commissionable Net Price" }, "commissionableGrossPrice": { "type": "number", "description": "commissionable Gross Price" }, "commissionableCurrencyCode": { "type": "string", "description": "the Commissionable currency-code IsoAlpha3" }, "commissionableExchangeRate": { "type": "number", "description": "Commissionable Exchange rate" }, "baseCommissionableCurrencyCode": { "type": "string", "description": "the Commissionable base currency-code IsoAlpha3" }, "baseCommissionableNetPrice": { "type": "number", "description": "commissionable base Net Price" }, "baseCommissionableGrossPrice": { "type": "number", "description": "commissionable base Gross Price" }, "taxRateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "commissionNetPrice": { "type": "number", "description": "Commission Net Price" }, "commissionGrossPrice": { "type": "number", "description": "Commission Gross Price" }, "commissionCurrencyCode": { "type": "string", "description": "the Commission currency-code IsoAlpha3" }, "baseCommissionCurrencyCode": { "type": "string", "description": "the Commission base currency-code IsoAlpha3" }, "commissionExchangeRate": { "type": "number", "description": "Commission Exchange rate" }, "baseCommissionNetPrice": { "type": "number", "description": "Commission Base Net Price" }, "baseCommissionGrossPrice": { "type": "number", "description": "Commission Base Gross Price" } } }, "erp-commission-CommissionRunSalesAgent": { "description": "sales agents", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "salesAgentAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "commissionType": { "type": "string", "description": "commission type of sales agent", "enum": [ "INVOICE", "ORDER", "PAYMENT" ] }, "taxRateRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "fees": { "type": "array", "description": "fees", "items": { "$ref": "#/components/schemas/erp-commission-CommissionRunFee" }, "readOnly": true }, "files": { "type": "array", "description": "export files", "items": { "$ref": "#/components/schemas/erp-commission-CommissionExportFile" }, "readOnly": true }, "totalCommissionNetPrice": { "type": "number", "description": "Sum Commission Net Price" }, "totalCommissionGrossPrice": { "type": "number", "description": "Sum Commission Gross Price" }, "commissionCurrencyCode": { "type": "string", "description": "the currency-code IsoAlpha3" }, "documentRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-commission-CommissionRunRequest": { "properties": { "dateFrom": { "type": "string", "format": "date", "description": "date from" }, "dateTo": { "type": "string", "format": "date", "description": "date to" }, "runDate": { "type": "string", "format": "date", "description": "run date" }, "numberFrom": { "type": "string", "description": "SalesAgent number from" }, "numberTo": { "type": "string", "description": "SalesAgent number to" } } }, "erp-bank-BankConnectionUpdateRequest": { "properties": { "importNewAccounts": { "type": "boolean", "default": false, "description": "Sollen neue Bankkonten importiert werden?" }, "manageSavedSettings": { "type": "string", "default": "NONE", "description": "Sollen die gespeicherten Einwilligungen bearbeitet werden?", "enum": [ "CREDENTIALS", "DEFAULT_TWO_STEP_PROCEDURE", "NONE" ] } } }, "erp-bank-ApiPayload": { "description": "api Payload", "properties": { "bankConnectionId": { "type": "integer", "format": "int64", "description": "bank connection ID" }, "paymentId": { "type": "integer", "format": "int64", "description": "payment Id" }, "standingOrderId": { "type": "integer", "format": "int64", "description": "standing order Id" } } }, "erp-bank-ApiTaskInfo": { "properties": { "id": { "type": "string", "description": "Die ID des externen Tasks" }, "createdAt": { "type": "string", "format": "date-time", "description": "Wann der Task angelegt wurde" }, "status": { "type": "string", "description": "Was ist der Status des Tasks derzeit", "enum": [ "NOT_YET_STARTED", "IN_PROGRESS", "WEB_FORM_REQUIRED", "COMPLETED", "COMPLETED_WITH_ERROR" ] }, "payload": { "$ref": "#/components/schemas/erp-bank-ApiPayload" }, "webform": { "$ref": "#/components/schemas/erp-bank-ApiWebform" } } }, "erp-bank-ApiWebform": { "description": "Informationen über ein Webform wenn eines angelegt wurde", "properties": { "webformId": { "type": "string", "description": "web form Id" }, "type": { "type": "string", "description": "web form Type", "enum": [ "BANK_CONNECTION_IMPORT", "BANK_CONNECTION_UPDATE", "PAYMENT_WITH_ACCOUNT_ID", "STANDALONE_PAYMENT", "DIRECT_DEBIT_WITH_ACCOUNT_ID", "STANDING_ORDER" ] }, "status": { "type": "string", "description": "web form Status", "enum": [ "NOT_YET_OPENED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERROR", "EXPIRED", "ABORTED", "CANCELLED" ] }, "payload": { "$ref": "#/components/schemas/erp-bank-ApiPayload" }, "expiresAt": { "type": "string", "format": "date-time", "description": "time expires at" }, "createdAt": { "type": "string", "format": "date-time", "description": "time created At" }, "url": { "type": "string", "description": "web form Url" } } }, "erp-bank-PaymentAssignment": { "properties": { "paymentId": { "type": "integer", "format": "int64", "description": "Id der Sammellastschrift" }, "comment": { "type": "string", "description": "Kommentar zur Buchung" }, "forceComplete": { "type": "boolean", "description": "Soll die Transaktion abgeschlossen und ein Restbetrag als irrelevant verbuicht werden?" } } }, "erp-bank-OpenItemDistributionResult": { "properties": { "type": { "type": "string", "description": "The result type of the attempt to match open item with transaction", "enum": [ "DONE", "TRANSACTION_COMPLETED", "TRANSACTION_FORCEFULLY_COMPLETED", "TRANSACTION_MARKED_RELEVANT", "WITH_OVERPAID_OPEN_ITEMS" ] }, "amount": { "type": "number", "description": "If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant" }, "overpaidOpenItems": { "type": "array", "description": "If applicable a list of overpaid open items", "items": { "$ref": "#/components/schemas/erp-finance-OpenItem" } } } }, "erp-bank-OpenItemDistribution": { "properties": { "openItemId": { "type": "integer", "format": "int64", "description": "The ID of the open item to be matched with the transaction" }, "forceComplete": { "type": "boolean", "description": "The total amount to be booked against this combination of open item and transaction" }, "distributionLines": { "type": "array", "description": "Betragszeilen", "items": { "$ref": "#/components/schemas/erp-bank-OpenItemDistributionLine" } } }, "required": [ "distributionLines", "openItemId" ] }, "erp-bank-OpenItemDistributionLine": { "description": "Betragszeilen", "properties": { "lineType": { "type": "string", "description": "Zeilentyp", "enum": [ "PAYMENT", "DUNNING", "FEE" ] }, "businessTransactionId": { "type": "integer", "format": "int64", "description": "Id des Geschäftsvorfalls" }, "amount": { "type": "number", "description": "der zu buchende (Mahn-)Betrag/die zu buchende Gebühr" }, "discountOrFeeAmount": { "type": "number", "description": "enthaltener Skonto oder Mahngebühren" }, "comment": { "type": "string", "description": "Kommentar" }, "dunningRecordId": { "type": "integer", "format": "int64", "description": "Id of the dunning record to pay towards" } }, "required": [ "amount", "lineType" ] }, "erp-bank-ManualBookingResult": { "properties": { "type": { "type": "string", "description": "The result type of the attempt to manually book transaction", "enum": [ "DONE", "TRANSACTION_COMPLETED", "TRANSACTION_FORCEFULLY_COMPLETED", "TRANSACTION_MARKED_RELEVANT", "WITH_OVERPAID_OPEN_ITEMS" ] }, "amount": { "type": "number", "description": "If applicable the amount that has yet to be distributed/was overdrafted/was marked as irrelevant" }, "bookingIds": { "type": "array", "description": "The ids of the manual bookings if successful", "items": { "type": "integer", "format": "int64", "description": "The ids of the manual bookings if successful" } }, "irrelevantBookingId": { "type": "integer", "format": "int64", "description": "The id of the irrelevancy marker booking if applicable" } } }, "erp-finance-ManualFinanceBookingAccountDistribution": { "description": "list booking account distributions", "properties": { "ledgerNumber": { "type": "string", "description": "FiBu-Konto" }, "transactionKey": { "type": "string", "description": "Buchungsschlüssel" }, "costCenter1": { "type": "string", "description": "Kostenstelle" }, "documentField1": { "type": "string", "description": "Belegfeld 1" }, "distributionAmount": { "type": "number", "description": "Aufteilungsbetrag" } } }, "erp-finance-ManualFinanceBookingRequest": { "properties": { "ledgerBookingAccountDistributions": { "type": "array", "description": "list booking account distributions", "items": { "$ref": "#/components/schemas/erp-finance-ManualFinanceBookingAccountDistribution" } }, "comment": { "type": "string", "description": "commentary", "minLength": 1 }, "forceComplete": { "type": "boolean", "description": "Unbooked value should be marked as irrelevant" }, "notRelevant": { "type": "boolean", "description": "transaction is not relevant for business" }, "templateId": { "type": "integer", "format": "int64", "description": "Template Vorlage" } }, "required": [ "comment" ] }, "erp-bank-BankTransactionComment": { "properties": { "comment": { "type": "string", "description": "the comment to be added to the transaction" }, "replace": { "type": "boolean", "description": "whether the comment of the transaction should be replaced or added onto" } } }, "erp-payment-PaymentSendingResponse": { "properties": { "expirationTime": { "type": "string", "format": "date-time", "description": "Verfallsdatum der Autorisierungs-URL" }, "urlToOpen": { "type": "string", "description": "URL für die Autorisierung" } } }, "erp-bank-BankPaymentRunBuildRequest": { "description": "Request zur Erstellung eines BankPaymentRun aus konkreten OP-IDs und/oder einer CUnit-Selektion", "properties": { "runType": { "type": "string", "description": "Art des Zahlungslaufs: Lastschrift (Debitoren) oder Überweisung (Kreditoren)", "enum": [ "DIRECT_DEBIT", "MONEY_TRANSFER" ] }, "openItemIdsToProcess": { "type": "array", "description": "Konkrete IDs der OffenenPosten, die in den Run aufgenommen werden sollen", "items": { "type": "integer", "format": "int64", "description": "Konkrete IDs der OffenenPosten, die in den Run aufgenommen werden sollen" } }, "openItemIdsToIgnore": { "type": "array", "description": "IDs der OffenenPosten, die ausgeschlossen werden sollen (greift sowohl auf direkte IDs als auch auf Selektions-Treffer)", "items": { "type": "integer", "format": "int64", "description": "IDs der OffenenPosten, die ausgeschlossen werden sollen (greift sowohl auf direkte IDs als auch auf Selektions-Treffer)" } }, "queryPredicate": { "$ref": "#/components/schemas/common-cunit-QueryPresetPredicate" }, "variables": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" }, "paymentTemplateId": { "type": "integer", "format": "int64", "description": "Zahlungsvorlage" }, "executionDateTime": { "type": "string", "format": "date-time", "description": "Manuell gesetzter Ausführungs-Zeitpunkt" }, "bankAccountId": { "type": "integer", "format": "int64", "description": "ID des Bankkontos, dem der Vorschlag zugeordnet wird" } }, "required": [ "bankAccountId" ] }, "erp-finance-PaymentCreationResponse": { "properties": { "openItemCount": { "type": "integer", "format": "int32", "description": "Anzahl der Offenen Posten" }, "totalAmount": { "type": "number", "description": "Gesamtbetrag der Offenen Posten" }, "responseDetails": { "type": "array", "description": "Erzeugte Zahlungen", "items": { "$ref": "#/components/schemas/erp-finance-PaymentCreationResponseDetail" } } } }, "erp-bank-TransactionSyncResponse": { "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-bank-TransactionSyncRequest": { "properties": { "accountId": { "type": "integer", "format": "int64", "description": "Id des Bankkontos" }, "dateRelevant": { "type": "string", "format": "date", "description": "Datum, ab dem die Transaktionen geschäftsrelevant sind" }, "fromDate": { "type": "string", "format": "date", "description": "Startdatum für Transaktionsabgleich" }, "toDate": { "type": "string", "format": "date", "description": "Enddatum für Transaktionsabgleich" }, "syncAll": { "type": "boolean", "default": true, "description": "Alle Transaktionen abrufen?" } }, "required": [ "accountId" ] }, "erp-asset-AssetCreateRequest": { "properties": { "createTemplateId": { "type": "integer", "format": "int64", "description": "Vorlage zum Erstellen eines Assets" }, "asset": { "$ref": "#/components/schemas/erp-asset-Asset" } } }, "erp-product-CreateArticleRequestApi": { "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", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ] }, "createArticlesOrBundles": { "type": "boolean", "default": false, "description": "Direkt Artikel/Gebinde anlegen" }, "permissibleForOrderProposal": { "type": "boolean", "default": true, "description": "zulässig für Aufnahme in Bestellvorschläge" }, "bundle": { "type": "boolean", "default": false, "description": "Nur wenn productRef leer ist: Handelt es sich um ein Gebinde?" }, "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" ] }, "dropShippingPolicy": { "type": "string", "description": "Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf", "enum": [ "ANY", "DROP_SHIPPING", "STORAGE", "STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING" ] }, "bundleSchemaId": { "type": "integer", "format": "int64", "description": "Vorlage zum Erstellen mehrerer Artikel" }, "createTemplateId": { "type": "integer", "format": "int64", "description": "Vorlage zum Erstellen eines Artikel" }, "variantSchemaRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "values": { "type": "array", "description": "Variantenwerte", "items": { "$ref": "#/components/schemas/common-variant-VariantValueReference" } }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "expiryDateType": { "type": "string", "description": "Art des Haltbarkeitsdatums bei Serienartikeln", "enum": [ "NONE", "BEST_BEFORE_DATE", "EXPIRATION_DATE" ] }, "warrantyInMonths": { "type": "integer", "format": "int32", "description": "Haltbarkeit (In Monaten)" }, "serialNumberLabelingType": { "type": "string", "description": "Seriennummer Auszeichnungsart", "enum": [ "MANUAL", "AUTOMATIC_ON_SUPPLIER_ORDER", "AUTOMATIC_ON_SUPPLIER_DELIVERY" ] } }, "required": [ "priceUnit" ] }, "erp-product-ArticlePrintLabelOrderRequest": { "description": "Anfrage Welche Artikel wie oft gedruckt werden soll", "properties": { "position": { "type": "integer", "format": "int32", "description": "Druckreihenfolge" }, "article": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "report": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumber": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "documentLine": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "documentLineComponent": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "picklistLine": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "picklistLineComponent": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "print": { "type": "boolean", "default": false, "description": "Etikettendruck" }, "quantity": { "type": "integer", "format": "int32", "default": 1, "description": "Menge" }, "languageCode": { "type": "string", "description": "Sprache (ISO Alpha-2)" } } }, "erp-stock-ArticleBundleConversionRequest": { "description": "Request zum Zusammenführen oder Auflösen von Gebinden", "properties": { "sourceArticleOrBundleId": { "type": "integer", "format": "int64", "description": "ID vom Quell-Artikel/-Gebinde" }, "sourceSerialNumberId": { "type": "integer", "format": "int64", "description": "Auswahl der Seriennummer (verpflichtend bei Chargen)" }, "targetArticleOrBundleId": { "type": "integer", "format": "int64", "description": "ID vom Ziel-Artikel/-Gebinde" }, "targetSerialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "processingStorageId": { "type": "integer", "format": "int64", "description": "ID vom Lager, in dem die Verarbeitung stattfinden soll" }, "processingStorageBinId": { "type": "integer", "format": "int64", "description": "(Optional, falls Lager mit Lagerplätzen) ID vom Lagerplatz, in dem die Verarbeitung stattfinden soll" }, "sourceQuantityToProcess": { "type": "number", "description": "Zu verarbeitende Menge" } }, "required": [ "processingStorageId", "sourceArticleOrBundleId", "sourceQuantityToProcess", "targetArticleOrBundleId" ] }, "dms-shelf-ShelfDocumentPostRequest": { "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" } } }, "required": [ "shelfDocument" ] }, "dms-shelf-TransferFileCreateRequest": { "properties": { "fileName": { "type": "string", "description": "filename (komplett) der zieldatei" } }, "required": [ "fileName" ] }, "dms-shelf-TransferFileCreateResponse": { "properties": { "token": { "type": "string", "description": "token für den transfer file" } } }, "dms-shelf-TransferFilePartCreateResponse": { "description": "Response wenn ein UploadPart angelegt wird", "properties": { "uploadUri": { "type": "string", "description": "upload-url for the real (tm) upload" } } }, "dms-shelf-TransferFileFinishRequest": { "properties": { "partCount": { "type": "integer", "format": "int64", "description": "anzahl der Teile, die hochgeladen wurden", "minimum": 0 }, "sha256Check": { "type": "string", "description": "sha256 checksumme des komplette files (optional)" } }, "required": [ "partCount" ] }, "dms-shelf-ShelfDocumentEntryResource.DmsUploadLookup": { "description": "Vergleiche, die verundet werden", "properties": { "field": { "type": "string", "description": "cUnit-Pfad" }, "value": { "type": "string", "description": "Vergleichswert" } }, "required": [ "field", "value" ] }, "dms-shelf-ShelfDocumentEntryResource.DmsUploadWrapper": { "properties": { "lookUps": { "type": "array", "description": "Vergleiche, die verundet werden", "items": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentEntryResource.DmsUploadLookup" } }, "resource": { "$ref": "#/components/schemas/dms-shelf-ShelfDocument" }, "purpose": { "type": "string" }, "uiSort": { "type": "integer", "format": "int32" } }, "required": [ "lookUps", "resource" ] }, "erp-finance-LedgerForSingleRecordRequest": { "properties": { "ledger": { "type": "string", "description": "neues Konto" }, "transactionKey": { "type": "string", "description": "neuer Buchungsschlüssel" }, "description": { "type": "string", "description": "Buchungstext" }, "costCenter1": { "type": "string", "description": "Kostenstelle 1" } } }, "erp-finance-FinanceBookingRecord": { "properties": { "version": { "type": "string", "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", "format": "int64", "description": "Eintragsnummer" }, "recordType": { "type": "string", "description": "Soll/Haben-Kennzeichen", "enum": [ "DEBIT", "CREDIT" ] }, "ledger": { "type": "string", "description": "Konto" }, "transactionKey": { "type": "string", "description": "Buchungsschlüssel" }, "ledgerType": { "type": "string", "description": "Konto-Kennzeichen", "enum": [ "PERSONAL_LEDGER", "GENERAL_LEDGER" ] }, "amountGross": { "type": "number", "description": "Bruttobetrag" }, "amountNet": { "type": "number", "description": "Nettobetrag" }, "recordDate": { "type": "string", "format": "date", "description": "Buchungsdatum" }, "performanceDate": { "type": "string", "format": "date", "description": "Leistungsdatum" }, "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ährung" }, "exchangeRate": { "type": "number", "description": "Währungskurs" }, "baseCurrencyCode": { "type": "string", "description": "Basiswährung" }, "baseAmountGross": { "type": "number", "description": "Bruttobetrag in Basiswährung" }, "baseAmountNet": { "type": "number", "description": "Nettobetrag in Basiswährung" }, "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": "§13b-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", "DUNNING_CHARGE_MANUAL", "DUNNING_CHARGE_MANUAL_REVERSAL", "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_CASH_JOURNAL_WITHDRAWAL", "POS_RECEIPT", "POS_RETURN_RECEIPT" ] }, "accountingRefId": { "type": "integer", "format": "int64", "description": "Buchungs-Referenz" }, "accountingRef1": { "$ref": "#/components/schemas/erp-finance-FinanceBookingReference" }, "accountingRef2": { "$ref": "#/components/schemas/erp-finance-FinanceBookingReference" }, "accountingRef3": { "$ref": "#/components/schemas/erp-finance-FinanceBookingReference" } } }, "erp-finance-FinanceBookingReference": { "description": "Finanzbuchungsreferenzen", "properties": { "id": { "type": "integer", "format": "int64", "description": "Id der Referenz" }, "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" } } }, "erp-finance-BookingResultLineComment": { "description": "Hinweis", "properties": { "lineNumber": { "type": "integer", "format": "int32", "description": "Originalzeile des Kommentars (ab 0)" }, "position": { "type": "integer", "format": "int32", "description": "Feld des Kommentars in Zeile (ab 0)" }, "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } } }, "erp-finance-FinanceBookingExportFile": { "description": "export files", "properties": { "shelfDocumentId": { "type": "integer", "format": "int64", "description": "Shelf Document ID" }, "description": { "type": "string", "description": "Beschreibung" }, "comment": { "type": "array", "description": "Hinweis", "items": { "$ref": "#/components/schemas/erp-finance-BookingResultLineComment" } } } }, "erp-finance-FinanceBookingRun": { "properties": { "version": { "type": "string", "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", "enum": [ "PROCESSING", "OPEN", "COMMITTABLE", "COMMITTED", "REVERTED", "FAILED" ], "readOnly": true }, "dateFrom": { "type": "string", "format": "date", "description": "Request date from", "readOnly": true }, "dateTo": { "type": "string", "format": "date", "description": "Request date to", "readOnly": true }, "files": { "type": "array", "description": "export files", "items": { "$ref": "#/components/schemas/erp-finance-FinanceBookingExportFile" }, "readOnly": true }, "persons": { "type": "array", "description": "persons", "items": { "$ref": "#/components/schemas/erp-finance-FinanceBookingRunPerson" }, "readOnly": true }, "stateSummary": { "type": "array", "description": "booking cases per state", "items": { "$ref": "#/components/schemas/erp-finance-FinanceBookingStateSummary" }, "readOnly": true }, "exportTypes": { "type": "array", "description": "Request Types for this run", "items": { "type": "string", "description": "Request Types for this run", "enum": [ "SALES_DOCUMENTS", "PURCHASE_DOCUMENTS", "FINANCE_BOOKINGS", "FINANCE_MANAGEMENT", "POS", "PREPAYMENT" ] }, "readOnly": true }, "bankAccountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "salesChannelRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "financeBookingBackendRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-finance-FinanceBookingRunPerson": { "description": "persons", "properties": { "accountRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "recordType": { "type": "string", "description": "record Type", "enum": [ "DEBIT", "CREDIT" ] }, "accountNumber": { "type": "string", "description": "account number / ledger" } } }, "erp-finance-FinanceBookingStateSummary": { "description": "booking cases per state", "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", "format": "int64", "description": "count of booking cases" } } }, "erp-finance-LedgerForMissingRecordsRequest": { "properties": { "ledger": { "type": "string", "description": "neues Konto" }, "transactionKey": { "type": "string", "description": "neuer Buchungsschlüssel" }, "description": { "type": "string", "description": "Buchungstext" }, "costCenter1": { "type": "string", "description": "Kostenstelle 1" }, "ledgerAssignment": { "$ref": "#/components/schemas/erp-finance-LedgerAssignment" }, "createLedgerAssignment": { "type": "boolean", "description": "Regel für Kontenzuordnung anlegen für diese Kombination" } } }, "erp-finance-BookingRunRequest": { "properties": { "dateFrom": { "type": "string", "format": "date", "description": "Datum von" }, "dateTo": { "type": "string", "format": "date", "description": "Datum bis" }, "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": { "description": "Request zur Durchführung der Abrechnung von Aufgaben", "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", "format": "int64", "description": "IDs von Aufgaben, die nicht abgerechnet werden sollen" } }, "crmTaskIdsToBill": { "type": "array", "description": "IDs von Aufgaben, die abgerechnet werden sollen", "items": { "type": "integer", "format": "int64", "description": "IDs von Aufgaben, die abgerechnet werden sollen" } }, "createCollectiveInvoicePerAccount": { "type": "boolean", "default": false, "description": "Sammelrechnung pro Account erstellen" } } }, "erp-crm-CreateCrmTaskRequest": { "properties": { "crmTask": { "$ref": "#/components/schemas/erp-crm-CrmTask" }, "createTemplateIdsWithTasks": { "type": "array", "description": "IDs von Vorlagen mit ggf. (teilweise) gefüllten Aufgaben", "items": { "$ref": "#/components/schemas/erp-crm-CreateCrmTaskRequest.CreateTemplateIdWithTask" } }, "parameters": { "type": "array", "description": "Zusätzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-crm-CreateCrmTaskRequest.CreateTemplateIdWithTask": { "description": "ID einer Vorlage mit einer (teilweise) gefüllten Aufgabe", "properties": { "createTemplateId": { "type": "integer", "format": "int64", "description": "ID einer Vorlage" }, "task": { "$ref": "#/components/schemas/erp-crm-CrmTask" } }, "required": [ "createTemplateId" ] }, "erp-crm-CreateCrmTaskResponse": { "description": "Antwort auf die Anfrage, Aufgaben zu erstellen", "properties": { "createdCrmTasks": { "type": "array", "description": "Die erstellten CRM-Tasks", "items": { "$ref": "#/components/schemas/erp-crm-CrmTask" } }, "warningsByTemplateRef": { "type": "object", "additionalProperties": { "type": "array", "description": "Ggf. vorhandene Probleme", "items": { "$ref": "#/components/schemas/core-error-ApiErrorDetail" }, "uniqueItems": true }, "description": "Ggf. vorhandene Probleme" } } }, "erp-crm-CreateCrmProjectRequest": { "properties": { "createTemplateId": { "type": "integer", "format": "int64", "description": "Vorlage zum Erstellen eines Projekts" }, "project": { "$ref": "#/components/schemas/erp-crm-CrmProject" }, "parameters": { "type": "array", "description": "Zusätzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-crm-CrmDealCloseRequest": { "description": "Request zum Schließen eines Deals", "properties": { "dealId": { "type": "integer", "format": "int64", "description": "ID des zu schliessenden Deals" }, "closingReasonId": { "type": "integer", "format": "int64", "description": "ID des zu verwendenden Abschlussgrunds" }, "detailedClosingReason": { "type": "string", "description": "Detaillierter Abschlussgrund" } } }, "erp-crm-CreateCrmDealRequest": { "properties": { "createTemplateId": { "type": "integer", "format": "int64", "description": "Vorlage zum Erstellen eines Deals" }, "deal": { "$ref": "#/components/schemas/erp-crm-CrmDeal" }, "parameters": { "type": "array", "description": "Zusätzliche Parameter (z.B. auch Antworten auf Entscheidungen", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } } }, "erp-account-CreateAccountRequestApi": { "properties": { "createTemplateId": { "type": "integer", "format": "int64", "description": "Vorlage zum Erstellen eines Accounts" }, "account": { "$ref": "#/components/schemas/erp-account-Account" } } }, "common-api-AppMessageWebhook": { "properties": { "url": { "type": "string", "description": "url des webhooks. üblicherweise http(s)://host:port/etc", "minLength": 1 }, "destinationOwner": { "type": "string", "description": "owner (optional)" }, "destinationQueue": { "type": "string", "description": "queue", "minLength": 1 }, "appIdentifier": { "type": "string", "format": "uuid", "description": "appIdentifier (registrar)" } }, "required": [ "destinationQueue", "url" ] }, "common-api-OutputQueueStateChangeRequest": { "properties": { "processingResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-api-OutputQueue": { "properties": { "version": { "type": "string", "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": { "type": "string", "description": "(mail) from name", "maxLength": 255, "minLength": 0, "readOnly": true }, "destinations": { "type": "array", "description": "Recipients/Destinations", "items": { "$ref": "#/components/schemas/common-output-OutputRecipient" }, "readOnly": true }, "messages": { "type": "array", "description": "messages)", "items": { "$ref": "#/components/schemas/common-api-OutputQueue.Message" }, "readOnly": true }, "attachmentReferences": { "type": "array", "description": "(mail) additional file references", "items": { "type": "string", "description": "(mail) additional file references" }, "readOnly": true }, "state": { "type": "string", "description": "state of the printing task", "enum": [ "REQUESTED", "PROCESSING", "ERROR", "DONE", "ABORTED" ], "readOnly": true }, "processingResult": { "type": "string", "description": "Prozessierungs-Ergebnis (für Log)", "readOnly": true }, "fromUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "successfulAttempts": { "type": "integer", "format": "int64", "description": "successfulAttempts", "readOnly": true }, "failedAttempts": { "type": "integer", "format": "int64", "description": "failedAttempts", "readOnly": true }, "ruleResult": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "importance": { "type": "string", "description": "Wichtigkeit/Dringlichkeit", "enum": [ "LOW", "NORMAL", "HIGH", "CRITICAL" ], "readOnly": true }, "outputQuantity": { "type": "integer", "format": "int32", "description": "Anzahl der Ausgabe", "minimum": 1 } } }, "common-api-OutputQueue.Message": { "description": "messages)", "properties": { "contentType": { "type": "string", "description": "(mail) content type", "enum": [ "TEXT", "HTML" ], "readOnly": true }, "content": { "type": "string", "description": "(mail) content", "readOnly": true }, "subject": { "type": "string", "description": "short subject", "readOnly": true } } }, "common-output-OutputRecipient": { "description": "Recipients/Destinations" }, "common-api-TextEnumCreate": { "properties": { "label": { "type": "string", "description": "Wert der Aufzählung", "maxLength": 255, "minLength": 0 }, "active": { "type": "boolean", "default": true, "description": "active", "readOnly": true }, "visible": { "type": "boolean", "default": true, "description": "Sichtbar" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "groupKey": { "type": "string", "description": "Gruppe der Text-Aufzählung", "maxLength": 255, "minLength": 0 } }, "required": [ "groupKey" ] }, "common-api-TextEnumGroupCreate": { "properties": { "label": { "type": "string", "description": "Beschreibung", "maxLength": 255, "minLength": 0 }, "key": { "type": "string", "description": "eindeutiger Key der Gruppe", "maxLength": 255, "minLength": 0 }, "autoAppend": { "type": "boolean", "default": false, "description": "automatisches erweitern der Liste aktiv" }, "appendVisible": { "type": "boolean", "default": true, "description": "Neue Werte sichtbar anlegen" } }, "required": [ "key", "label" ] }, "common-eav-EavDataRemoveRequest": { "properties": { "entities": { "type": "array", "description": "Entity-Assoziation, bei denen die Daten gelöscht werden sollen", "items": { "type": "string", "description": "Entity-Assoziation, bei denen die Daten gelöscht werden sollen" }, "minItems": 1 }, "attributeId": { "type": "array", "description": "Attribute Key dessen daten gelöscht werden sollen (optional)", "items": { "type": "integer", "format": "int64", "description": "Attribute Key dessen daten gelöscht werden sollen (optional)" } } }, "required": [ "entities" ] }, "common-workflow-WorkflowScriptExecutionRequest": { "description": "Führt ein Skript in einer \"Sandbox\" aus", "properties": { "workflowId": { "type": "integer", "format": "int64", "description": "ID des Workflows, in dessen Kontext das Skript ausgeführt werden soll" }, "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ührende Skript", "minLength": 1 }, "parameters": { "type": "object", "additionalProperties": { "type": "string", "description": "Parameter die an Skript gegeben werden sollen" }, "description": "Parameter die an Skript gegeben werden sollen" } }, "required": [ "script", "workflowElementType", "workflowId" ] }, "common-user-UserSetting": { "properties": { "userRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "key": { "type": "string", "description": "setting-key" }, "value": { "type": "string", "description": "setting-value" } }, "required": [ "key", "value" ] }, "common-user-UserMessageCreateRequest": { "description": "Nachricht-Umschlag zum verschicken", "properties": { "recipientUserIds": { "type": "array", "description": "Empfänger User", "items": { "type": "integer", "format": "int64", "description": "Empfänger User" } }, "recipientGroupIds": { "type": "array", "description": "Empfänger User-Gruppen (werden zu Usern)", "items": { "type": "integer", "format": "int64", "description": "Empfänger User-Gruppen (werden zu Usern)" } }, "senderBotAlias": { "type": "string", "description": "optional ein BotName als versender. Nur für interne Apps und darf nur mit leeren userIds/groupIds verwendet werden" }, "message": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" } }, "required": [ "message" ] }, "common-masterdata-UnitTypeConversion": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "value": { "type": "number", "description": "Wert, welcher umgerechnet werden soll" }, "sourceTypeAbbreviation": { "type": "string", "description": "Abkürzung der gegebenen Einheit", "minLength": 1 }, "targetTypeAbbreviation": { "type": "string", "description": "Abkürzung der Zieleinheit", "minLength": 1 }, "result": { "type": "number", "description": "Ergebnis der Berechnung", "readOnly": true } }, "required": [ "sourceTypeAbbreviation", "targetTypeAbbreviation", "value" ] }, "common-output-OutputReportCreateRequest": { "properties": { "copyFromId": { "type": "integer", "format": "int64", "description": "kopie: die Id des Reports, der kopiert werden soll. Wenn dieser Wert gesetzt ist, wird outputModuleKey ignoriert" }, "toGroupId": { "type": "integer", "format": "int64", "description": "kopie/neuanlage: die Gruppe, in die der Report als neuer Report angelegt wird" }, "outputModuleKey": { "type": "string", "description": "neuanlage: der modul key" }, "reportTypeId": { "type": "integer", "format": "int64", "description": "neuanlage: welcher Reporttyp liegt vor" }, "label": { "type": "string", "description": "Bezeichnung des neuen Reports" }, "alias": { "type": "string", "description": "Alias des neuen Reports" } } }, "common-ftsearch-SearchPhoneticRequest": { "properties": { "languageCode": { "type": "string", "description": "language code", "maxLength": 2, "minLength": 0 }, "types": { "type": "array", "description": "Die Types, die durchsucht werden sollen. Oder null für alle", "items": { "type": "string", "description": "Die Types, die durchsucht werden sollen. Oder null für 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": { "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": { "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", "default": false, "description": "Als Vorlage anlegen?" } } }, "common-data_import-CreateMultiPartOrderedRuleSetRequest": { "description": "Import-Regelwerk mit definierter Reihenfolge", "properties": { "step": { "type": "integer", "format": "int32", "description": "Stufe, auf der der einzelne Import gestartet wird" }, "fileName": { "type": "string", "description": "Datei, die für den Import verwendet wird (inkl. Dateiendung)" }, "label": { "type": "string", "description": "Name des Imports" }, "ruleSet": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" } } }, "core-cunit-CuResult": { "description": "Der Ergebniscontainer", "properties": { "definition": { "type": "array", "description": "spaltenbeschreibung dieser zelle (bei verschachtelung)", "items": { "$ref": "#/components/schemas/core-cunit-MetaContent" } }, "data": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-cunit-QueryPresetOutputRequest": { "properties": { "exportFormat": { "type": "string", "description": "Exportformate", "enum": [ "PDF", "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", "default": false, "description": "ist veröffentlicht?" }, "presetRequest": { "$ref": "#/components/schemas/common-cunit-QueryPresetRequest" } } }, "common-cunit-CreateQueryPresetRequest": { "properties": { "label": { "type": "string", "description": "label für diesen filter", "minLength": 1 }, "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ätzliche konfigurationen", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetTransformation" } }, "uiPayload": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "variables": { "type": "array", "description": "Variablen für dieses Preset", "items": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariable" } }, "arithmeticQueryTerms": { "type": "array", "description": "Arithmetische Terme - hier kommt die tatsächliche Berechnung rein", "items": { "$ref": "#/components/schemas/common-cunit-ArithmeticQueryTerm" } }, "queryStatement": { "type": "string", "description": "Optional ein VQL Query (bei Mode:STATEMENT)" }, "forWorkflow": { "type": "boolean", "default": false, "description": "für Workflows vorgesehen" } }, "required": [ "forWorkflow", "label", "mode" ] }, "common-cunit-VqlQueryApi": { "properties": { "statement": { "type": "string", "description": "das statement", "minLength": 1 }, "limit": { "type": "integer", "format": "int32", "description": "optionaler wert für limit (wird gerne zusätzlich von tools mitgegeben)", "minimum": 0 }, "offset": { "type": "integer", "format": "int64", "description": "optionaler wert für offset (wird gerne zusätzlich von tools mitgegeben)", "minimum": 0 }, "variableSubstitutionList": { "$ref": "#/components/schemas/common-cunit-QueryPresetVariableSubstitutionList" } }, "required": [ "statement" ] }, "node-api-AppTokenDto": { "properties": { "appIdentifier": { "type": "string", "format": "uuid", "description": "App-Identifikationsnummer" }, "bearerToken": { "type": "string", "description": "Bearer-Token fuer Companion-App Api" }, "expiresIn": { "type": "integer", "format": "int32", "description": "Token wird ablaufen in Sekunden" }, "issuedAt": { "type": "string", "format": "date-time", "description": "Token erstellt am" } } }, "node-api-PermittedTokenRequest": { "properties": { "expiresAt": { "type": "string", "format": "date-time", "description": "gueltig bis UTC Timestamp" }, "permissions": { "type": "array", "description": "Permissions", "items": { "type": "string", "description": "Permissions" } } } }, "common-api-AppSettings": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "appIdentifier": { "type": "string", "format": "uuid", "description": "Identifier der App" }, "custom": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } }, "required": [ "appIdentifier" ] }, "banking-api-BankingProviderCreationRequest": { "properties": { "bankType": { "type": "string", "description": "Bankschnittstelle", "enum": [ "FINAPI", "FINAPI_SANDBOX", "MOCKBANK", "APP" ] }, "username": { "type": "string", "description": "Username für Bankschnittstelle (falls benötigt)" }, "password": { "type": "string", "description": "Password für Bankschnittstelle (falls benötigt)" } } }, "banking-api-BankingProviderCreationMessage": {}, "erp-document-DocumentPatchRequest": { "properties": { "document": { "$ref": "#/components/schemas/erp-document-Document" }, "parameters": { "type": "array", "description": "additional parameters for transition", "items": { "$ref": "#/components/schemas/common-api-AdditionalParameter" } } }, "required": [ "document" ] }, "erp-wms-ScannableCodePart": { "description": "Liste der Teile des Codes", "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 } }, "readOnly": true }, "erp-wms-ScannableCodeRecognitionResult": { "properties": { "articleId": { "type": "integer", "format": "int64", "description": "ID vom erkannten Artikel (falls einer erkannt wurde)", "readOnly": true }, "articleNumber": { "type": "string", "description": "Nummer vom erkannten Artikel (falls einer erkannt wurde)", "readOnly": true }, "storageBinId": { "type": "integer", "format": "int64", "description": "ID vom erkannten Lagerplatz (falls einer erkannt wurde)", "readOnly": true }, "storageBinDisplayName": { "type": "string", "description": "Anzeigename vom erkannten Lagerplatz (falls einer erkannt wurde)", "readOnly": true }, "codeType": { "type": "string", "description": "Arten von scanbare Codes", "enum": [ "COMMON", "GS1", "HIBC" ], "readOnly": true }, "scannableCodeParts": { "type": "array", "description": "Liste der Teile des Codes", "items": { "$ref": "#/components/schemas/erp-wms-ScannableCodePart" }, "readOnly": true } } }, "core-scripting-ScriptDescription": { "description": "Beschreibung zu einem Skript", "properties": { "mainInstance": { "$ref": "#/components/schemas/core-scripting-ScriptingInstanceDescription" }, "availableTypes": { "type": "array", "description": "Beschreibungen der verfügbaren Typen", "items": { "$ref": "#/components/schemas/core-scripting-ScriptingTypeDescription" } }, "availableInput": { "type": "array", "description": "Verfügbare Eingabedaten", "items": { "$ref": "#/components/schemas/core-scripting-ScriptInputDescription" } } } }, "core-scripting-ScriptInputDescription": { "description": "Beschreibung eines Eingabe-Parameters", "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ür Datentyp \"object\": Typ des Parameters" } } }, "core-scripting-ScriptingInstanceDescription": { "description": "Beschreibung einer Instanz, welcher im Scripting verwendet wird", "properties": { "name": { "type": "string", "description": "Name des Typs" }, "description": { "type": "string", "description": "Beschreibung des Typs" }, "moduleName": { "type": "string", "description": "Name des Moduls, wo diese Instanz definiert ist" }, "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" } }, "usageExample": { "type": "string", "description": "Beispiel für die Verwendung" }, "type": { "type": "string", "description": "Art des Scripting-Typs", "enum": [ "INSTANCE", "SERVICE", "DTO", "EAV", "ENUM", "ARRAY", "MAP", "CALLBACK", "METHOD" ] } } }, "core-scripting-ScriptingTypeAttributeDescription": { "description": "Beschreibung eines Attributs eines Objekts, welches im Scripting verwendet wird", "properties": { "name": { "type": "string", "description": "Name des Attributs" }, "description": { "type": "string", "description": "Beschreibung des Attributs" }, "readOnly": { "type": "boolean", "default": false, "description": "Ist das Attribut read-only" }, "dataType": { "type": "string", "description": "Datentyp des Attributs" }, "dataTypeName": { "type": "string", "description": "Für Datentyp \"object\": Beschreibung des Objekts" } } }, "core-scripting-ScriptingTypeDescription": { "description": "Beschreibungen der verfügbaren Typen", "properties": { "name": { "type": "string", "description": "Name des Typs" }, "description": { "type": "string", "description": "Beschreibung des Typs" }, "type": { "type": "string", "description": "Art des Scripting-Typs", "enum": [ "INSTANCE", "SERVICE", "DTO", "EAV", "ENUM", "ARRAY", "MAP", "CALLBACK", "METHOD" ] } } }, "core-scripting-ScriptingTypeMethodDescription": { "description": "Beschreibung einer Methode eines Objekts, welches im Scripting verwendet wird", "properties": { "name": { "type": "string", "description": "Name der Methode" }, "description": { "type": "string", "description": "Beschreibung der Methode" }, "returnType": { "type": "string", "description": "Rückgabetyp der Methode" }, "returnTypeName": { "type": "string", "description": "Für Datentyp \"object\": Name des Rückgabe-Typs" }, "returnDescription": { "type": "string", "description": "Beschreibung zum Rückgabe-Wert" }, "parameters": { "type": "array", "description": "Parameter der Methode", "items": { "$ref": "#/components/schemas/core-scripting-ScriptingTypeMethodParameterDescription" } }, "type": { "type": "string", "description": "Art des Scripting-Typs", "enum": [ "INSTANCE", "SERVICE", "DTO", "EAV", "ENUM", "ARRAY", "MAP", "CALLBACK", "METHOD" ] }, "dataType": { "type": "string" }, "dataTypeName": { "type": "string" } } }, "core-scripting-ScriptingTypeMethodParameterDescription": { "description": "Beschreibung eines Parameters einer Methode eines Objekts, welches im Scripting verwendet wird", "properties": { "name": { "type": "string", "description": "Name des Parameters" }, "description": { "type": "string", "description": "Beschreibung des Parameters" }, "nonNull": { "type": "boolean", "default": false, "description": "Ist der Parameter als \"non-null\" definiert" }, "dataType": { "type": "string", "description": "Datentyp des Parameters" }, "dataTypeName": { "type": "string", "description": "Für Datentyp \"object\": Name des Parameter-Typs" } } }, "erp-wms-InventoryTransition": { "description": "Inventur-Transition", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID der Transition" }, "label": { "type": "string", "description": "Bezeichnung der Transition" }, "uiHint": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "erp-wms-InventoryDifference": { "description": "Position der Differenzlisten der Inventur", "properties": { "inventoryId": { "type": "integer", "format": "int64", "description": "Inventur" }, "articleId": { "type": "integer", "format": "int64", "description": "Artikel" }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelname", "readOnly": true }, "articleDescription": { "type": "string", "description": "Artikelbeschreibung", "readOnly": true }, "storageBinId": { "type": "integer", "format": "int64", "description": "Lagerplatz, welcher gezählt wurde" }, "storageBinDisplayName": { "type": "string", "description": "Anzeigename vom Lagerplatz, welcher gezählt wurde", "readOnly": true }, "serialNumberRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "purchasePrice": { "type": "number", "description": "EK" }, "averagePurchasePrice": { "type": "number", "description": "DEK" }, "priceUnit": { "type": "number", "description": "Preiseinheit, auf die sich EK und DEK beziehen" }, "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", "format": "int32", "description": "Revision der Zählung", "readOnly": true } }, "required": [ "articleId", "inventoryId", "storageBinId" ] }, "vds-carrier-VdiInitializerKey": { "properties": { "key": { "type": "string", "description": "specific carrier key", "minLength": 1 }, "name": { "type": "string", "description": "specific carrier name", "minLength": 1 }, "description": { "type": "string", "description": "carrier description" } }, "required": [ "key", "name" ] }, "common-system-ThirdPartyDependency": { "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": { "description": "License", "properties": { "License Name": { "type": "string" }, "License URL": { "type": "string" } } }, "core-unknownmodule-GitInfo": { "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": { "properties": { "articleId": { "type": "integer", "format": "int64", "description": "Ein Artikel" }, "storageId": { "type": "integer", "format": "int64", "description": "Ein Lager" }, "storageIds": { "type": "array", "description": "Mehrere Lager", "items": { "type": "integer", "format": "int64", "description": "Mehrere Lager" } }, "storageBinId": { "type": "integer", "format": "int64", "description": "Ein Lagerplatz" }, "serialNumberId": { "type": "integer", "format": "int64", "description": "Eine Seriennummer" }, "productGroupId": { "type": "integer", "format": "int64", "description": "Eine Produktgruppe" }, "fromDate": { "type": "string", "format": "date", "description": "Ab Datum" }, "toDate": { "type": "string", "format": "date", "description": "Bis Datum" }, "goodsReceiptPosting": { "type": "boolean", "description": "Wareneingangsbuchung" }, "type": { "type": "string", "description": "Lagerbuchungsart (Filter auf StockJournalEntity.type)", "enum": [ "MANUAL", "DOCUMENT", "PICKING", "REPLENISHMENT", "RESTOCKING", "INITIAL_INVENTORY", "INVENTORY_CORRECTION", "AVERAGE_PURCHASE_PRICE_CORRECTION", "LAST_PURCHASE_PRICE_CORRECTION", "BUNDLE_MERGE_OR_DISSOLVE", "DUMMY_TO_VALID_SERIAL_NUMBER", "FABRICATION_ARTICLE", "FABRICATION_COMPONENT" ] } } }, "erp-stock-StockJournal": { "description": "Lagerbuchungen", "properties": { "version": { "type": "string", "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": "Lagerbuchungsarten", "enum": [ "MANUAL", "DOCUMENT", "PICKING", "REPLENISHMENT", "RESTOCKING", "INITIAL_INVENTORY", "INVENTORY_CORRECTION", "AVERAGE_PURCHASE_PRICE_CORRECTION", "LAST_PURCHASE_PRICE_CORRECTION", "BUNDLE_MERGE_OR_DISSOLVE", "DUMMY_TO_VALID_SERIAL_NUMBER", "FABRICATION_ARTICLE", "FABRICATION_COMPONENT" ] }, "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" }, "documentLineId": { "type": "string", "description": "Document-Line, zu der die Buchung stattgefunden hat" }, "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", "format": "date", "description": "Buchungs-/Wertstellungs-Datum der Lagerbewegung" }, "note": { "type": "string", "description": "Bemerkung zu der Buchung", "maxLength": 255, "minLength": 0 }, "i18nNote": { "$ref": "#/components/schemas/core-api-LocalizeableMessage" }, "totalPurchasePrice": { "type": "number", "description": "EK dieser Buchung" }, "purchasePriceAdjustment": { "type": "number", "description": "EK-Anpassung dieser Buchung" }, "cancellation": { "type": "boolean", "default": false, "description": "Handelt es sich um ein Storno?" }, "cancellationDetails": { "type": "string", "description": "Details zu einem Storno" }, "priceUnit": { "type": "number", "description": "Preiseinheit" } }, "readOnly": true }, "erp-statistic-QueryAlias": { "properties": { "id": { "type": "string", "description": "id for the query" }, "description": { "type": "string", "description": "description of this query" } } }, "erp-document-GoodsExchangeLine": { "description": "Warenersatz-Positionen für die Übernahme in Kundenauftrag/Versandauftrag", "properties": { "documentLineId": { "type": "string", "description": "Id der DocumentLine", "readOnly": true }, "position": { "type": "integer", "format": "int32", "description": "Positionsnummer", "readOnly": true }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelbezeichnung", "readOnly": true }, "articleId": { "type": "integer", "format": "int64", "description": "Artikel-ID", "readOnly": true }, "quantity": { "type": "number", "description": "Gesamtmenge der Position", "readOnly": true }, "alreadyTransferredQuantity": { "type": "number", "description": "Bereits in Aufträge übernommene Menge", "readOnly": true }, "transferableQuantity": { "type": "number", "description": "Übernehmbare Menge" }, "requiresCustomerOrder": { "type": "boolean", "description": "Erfordert Kundenauftrag (true) oder Versandauftrag (false)", "readOnly": true } }, "required": [ "transferableQuantity" ] }, "erp-document-ReturnableLine": { "description": "Retournierbare Positionen", "properties": { "documentLineId": { "type": "string", "description": "Id der DocumentLine", "readOnly": true }, "position": { "type": "integer", "format": "int32", "description": "Positionsnummer", "readOnly": true }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelbezeichnung", "readOnly": true }, "articleId": { "type": "integer", "format": "int64", "description": "Artikel-ID", "readOnly": true }, "alreadyReturnedQuantity": { "type": "number", "description": "Bereits retournierte Menge", "readOnly": true }, "returnableQuantity": { "type": "number", "description": "Retournierbare Menge" } }, "required": [ "returnableQuantity" ] }, "erp-product-ProductPriceHistory": { "description": "Preishistorie", "properties": { "version": { "type": "string", "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", "enum": [ "NET_PRICE", "GROSS_PRICE" ], "readOnly": true } }, "required": [ "article", "newPrice", "priceBase", "salesChannel" ] }, "erp-product-PurchasePriceStatistic": { "description": "Preisstatistiken (DEK und letzter EK)", "properties": { "averagePrice": { "type": "number", "description": "Durchschnitts-Einkaufspreis", "readOnly": true }, "averagePriceBookedAt": { "type": "string", "format": "date", "description": "Wertstellungsdatum Durchschnitts-Einkaufspreis", "readOnly": true }, "priceUnitAveragePrice": { "type": "number", "description": "Preiseinheit Durchschnitts-Einkaufspreis", "readOnly": true }, "lastPrice": { "type": "number", "description": "letzter Einkaufspreis", "readOnly": true }, "priceUnitLastPrice": { "type": "number", "description": "Preiseinheit letzter Einkaufspreis", "readOnly": true }, "lastPriceUpdatedAt": { "type": "string", "format": "date-time", "description": "Erfassungszeitpunkt letzter Einkaufspreis", "readOnly": true }, "lastPriceBookedAt": { "type": "string", "format": "date", "description": "Wertstellungsdatum letzter Einkaufspreis", "readOnly": true }, "mainSupplierAccount": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "mainSupplierProductPrice": { "$ref": "#/components/schemas/erp-product-ProductPrice" } } }, "erp-product-ProductCombinationDto": { "description": "Verwendete Kombinationen", "properties": { "article": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "combination": { "type": "array", "description": "Wert-Kombination", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true } } }, "erp-product-ProductVariantCombinationsDto": { "properties": { "variantSchema": { "$ref": "#/components/schemas/common-variant-VariantSchema" }, "attributes": { "type": "array", "description": "Verwendete Attribute", "items": { "$ref": "#/components/schemas/common-variant-VariantAttribute" } }, "values": { "type": "array", "description": "Verwendete Werte", "items": { "$ref": "#/components/schemas/common-variant-VariantValue" } }, "usedCombinations": { "type": "array", "description": "Verwendete Kombinationen", "items": { "$ref": "#/components/schemas/erp-product-ProductCombinationDto" } } } }, "erp-product-ProductVariantAttribute": { "description": "Variantenattribut mit ERP-Konfiguration", "properties": { "version": { "type": "string", "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", "readOnly": true }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "labels": { "type": "array", "description": "Bezeichnung (mehrsprachig)", "items": { "$ref": "#/components/schemas/common-variant-VariantDescription" }, "readOnly": true }, "bundleAttribute": { "type": "boolean", "default": false, "description": "Ist dieses Attribut ein Gebinde-Attribut?", "readOnly": true }, "attributeAssignmentConfigId": { "type": "integer", "format": "int64", "description": "ID der zugehörigen ERP-Konfiguration", "readOnly": true } } }, "erp-product-ProductVariantSchema": { "description": "Variantenschema mit ERP-Konfiguration", "properties": { "version": { "type": "string", "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", "readOnly": true }, "description": { "type": "string", "description": "Beschreibung", "readOnly": true }, "active": { "type": "boolean", "default": true, "description": "Aktiv?", "readOnly": true }, "attributes": { "type": "array", "description": "Zugeordnete Attribute mit Gebinde-Information", "items": { "$ref": "#/components/schemas/erp-product-ProductVariantAttribute" }, "readOnly": true }, "eligibleValueRefs": { "type": "array", "description": "Wählbare Werte", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true } } }, "erp-pos-CashJournalOpeningStartBalance": { "properties": { "posPaymentMethodRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "calculatedStartBalance": { "type": "number", "description": "Errechnetes Anfangssaldo" } } }, "erp-pos-CashJournalClosingBalance": { "description": "Abschluss-Salden je bestandsgeführter Zahlungsart (Soll/Ist/Differenz/Abschöpfung/Neuer Anfangsbestand) — vollständig gefüllt nach abgeschlossener Abrechnung", "properties": { "posPaymentMethodRef": { "$ref": "#/components/schemas/erp-pos-PosPaymentMethod" }, "startBalance": { "type": "number", "description": "Ist-Anfangssaldo des Kassenbuchs" }, "targetBalance": { "type": "number", "description": "Endbestand (Soll): errechneter Saldo vor der Schluss-Abschöpfung" }, "countedBalance": { "type": "number", "description": "Gezählter Ist-Endbestand" }, "difference": { "type": "number", "description": "Differenz Ist − Soll (Kassendifferenz dieser Abrechnung)" }, "closingWithdrawal": { "type": "number", "description": "In der Abrechnung abgeschöpfter Betrag (countedBalance − newStartBalance)" }, "newStartBalance": { "type": "number", "description": "Neuer Anfangsbestand (Rest nach Abschöpfung) — Basis für den calculatedStart des Folge-Kassenbuchs" }, "currencyRef": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" } } }, "erp-pos-CashJournalClosingNonCashPayment": { "description": "Umsatz je nicht-barer Zahlungsart aus diesem Kassenbuch-Lauf", "properties": { "posPaymentMethodRef": { "$ref": "#/components/schemas/erp-pos-PosPaymentMethod" }, "totalAmount": { "type": "number", "description": "Umsatz dieser Zahlungsart im aktuellen Kassenbuch-Lauf, gewichtet mit dem Zahlungs-Faktor der jeweiligen POS-Zeile (Zahlungen positiv, Rückgaben negativ)" }, "withdrawalMode": { "type": "string", "description": "Modus für die Entnahme einer Kassenzahlungsart beim Kassenabschluss", "enum": [ "FULL", "BALANCE", "MANUAL", "NONE" ] }, "balanceBeforeWithdrawal": { "type": "number", "description": "Saldo der Zahlungsart vor Abschöpfung (nur für bestandsgeführte Zahlungsarten gesetzt)" }, "withdrawalAmount": { "type": "number", "description": "Abschöpfungsbetrag. Im Modus MANUAL vom Anwender vorgegeben; in den Modi FULL/BALANCE/NONE vom Backend aus aktuellem Saldo berechnet" }, "withdrawToBalance": { "type": "number", "description": "Abschöpfung auf Betrag (Modus BALANCE) — Restbetrag, der in der Kasse verbleibt" } } }, "erp-pos-CashJournalClosingStartBalance": { "description": "Anfangsbestände je bestandsgeführter und im Kassenbuch verwendeter Zahlungsart", "properties": { "posPaymentMethodRef": { "$ref": "#/components/schemas/erp-pos-PosPaymentMethod" }, "startBalance": { "type": "number", "description": "Ist-Anfangssaldo" }, "currencyRef": { "$ref": "#/components/schemas/common-masterdata-CurrencyReference" } } }, "erp-pos-PosDocumentClosingPreview": { "properties": { "finishedDocuments": { "type": "array", "description": "Kennzahlen pro Beleg-Kategorie für abgeschlossene Belege (documentState SAVED, PARTIALLY_ACCEPTED oder ACCEPTED)", "items": { "$ref": "#/components/schemas/erp-pos-PosDocumentClosingPreviewCategoryStats" } }, "unfinishedDocuments": { "type": "array", "description": "Kennzahlen pro Beleg-Kategorie für noch offene Belege (documentState weder SAVED, PARTIALLY_ACCEPTED, ACCEPTED noch CANCELLED)", "items": { "$ref": "#/components/schemas/erp-pos-PosDocumentClosingPreviewCategoryStats" } }, "cancelledDocuments": { "type": "array", "description": "Kennzahlen pro Beleg-Kategorie für stornierte Kassenbelege (documentState CANCELLED, ausschließlich POS_CASH_RECEIPT und POS_RETURN_CASH_RECEIPT)", "items": { "$ref": "#/components/schemas/erp-pos-PosDocumentClosingPreviewCategoryStats" } }, "startBalances": { "type": "array", "description": "Anfangsbestände je bestandsgeführter und im Kassenbuch verwendeter Zahlungsart", "items": { "$ref": "#/components/schemas/erp-pos-CashJournalClosingStartBalance" } }, "closingBalances": { "type": "array", "description": "Abschluss-Salden je bestandsgeführter Zahlungsart (Soll/Ist/Differenz/Abschöpfung/Neuer Anfangsbestand) — vollständig gefüllt nach abgeschlossener Abrechnung", "items": { "$ref": "#/components/schemas/erp-pos-CashJournalClosingBalance" } }, "nonCashPayments": { "type": "array", "description": "Umsatz je nicht-barer Zahlungsart aus diesem Kassenbuch-Lauf", "items": { "$ref": "#/components/schemas/erp-pos-CashJournalClosingNonCashPayment" } }, "totalCurrentBalance": { "type": "number", "description": "Summe aus cashCurrentBalance und nonCashTotalAmount" }, "cashCurrentBalance": { "type": "number", "description": "Aktueller Bar-Saldo des Kassenbuchs" }, "nonCashTotalAmount": { "type": "number", "description": "Summe der Umsätze über alle nicht-baren Zahlungsarten" }, "openItemPaymentTotal": { "type": "number", "description": "Summe aller Kundeneinzahlungen (ON_ACCOUNT_PAYMENT) und OP-Ausgleiche (OPEN_ITEM_SETTLEMENT) der abgeschlossenen Belege. Diese Beträge beeinflussen die Zahlungsmittel-Bestände, zählen jedoch nicht als Umsatz" }, "finishedDocumentsNetSum": { "type": "number", "description": "Reiner Waren-/Leistungsumsatz der abgeschlossenen Belege: Kassenquittungen (POS_CASH_RECEIPT) positiv, Kassenretouren (POS_RETURN_CASH_RECEIPT) negativ, jeweils abzüglich der OP-Buchungen (openItemPaymentTotal) — ohne Kundeneinzahlungen und OP-Ausgleiche" }, "finishedReceiptsTotalGross": { "type": "number", "description": "Bruttosumme der abgeschlossenen Kassenquittungen (POS_CASH_RECEIPT) abzüglich Kassenretouren (POS_RETURN_CASH_RECEIPT), inklusive OP-Ausgleiche und Kundeneinzahlungen — ohne Einlagen, Ausgaben und Abschöpfungen" }, "intermediateSum": { "type": "number", "description": "Zwischensumme = Anfangsbestände + Kassenquittungen + Einzahlungen − Ausgaben − manuelle Abschöpfungen − Stornos (Stand vor der Schluss-Abschöpfung)" } } }, "erp-pos-PosDocumentClosingPreviewCategoryStats": { "description": "Kennzahlen pro Beleg-Kategorie für stornierte Kassenbelege (documentState CANCELLED, ausschließlich POS_CASH_RECEIPT und POS_RETURN_CASH_RECEIPT)", "properties": { "category": { "type": "string", "description": "Dokumenttypen", "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_PROFORMA_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PROGRESS_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PROGRESS_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_DEPOSIT_INVOICE", "CUSTOMER_DEPOSIT_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "CUSTOMER_RETURN_ANNOUNCEMENT", "CUSTOMER_GOODS_RETURN", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "SUPPLIER_DEPOSIT_INVOICE", "SUPPLIER_PROGRESS_INVOICE", "SUPPLIER_PARTIAL_INVOICE", "SUPPLIER_FINAL_INVOICE", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "SUPPLIER_COMMISSION_CREDIT_NOTE", "SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_RETURN_CASH_RECEIPT", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_WITHDRAWAL", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ] }, "count": { "type": "integer", "format": "int64", "description": "Anzahl Belege" }, "totalGrossAmount": { "type": "number", "description": "Summe der Bruttogesamtpreise" } } }, "erp-payment-PaymentTemplateField": { "properties": { "label": { "type": "string" }, "fieldName": { "type": "string" } } }, "erp-stock-OrderProposalToOrdersRun": { "description": "Bestellerstellungslauf entsprechend einem Bestellvorschlag", "properties": { "number": { "type": "integer", "format": "int64", "description": "Nummer", "readOnly": true }, "successful": { "type": "boolean", "description": "Erfolgreich?", "readOnly": true }, "logLines": { "type": "array", "description": "Logeinträge", "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" }, "readOnly": true }, "orderProposalId": { "type": "string", "description": "Bestellvorschlag", "readOnly": true }, "orderDocuments": { "type": "array", "description": "Preisanfragen/Bestellungen", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "readOnly": true } } }, "common-workflow-WorkItem": { "description": "Schritte des Workflows", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "state": { "type": "string", "description": "Bearbeitungszustand eines Work-Items", "enum": [ "OPEN", "IN_PROCESS", "COMPLETED", "ERRONEOUS", "ABORTED" ] }, "workflowElementRef": { "type": "integer", "format": "int64", "description": "Workflow-Element, das abgebildet wird" }, "parentWorkItemRef": { "type": "integer", "format": "int64", "description": "Work-Item im übergeordneten Workflow, wenn es sich um einen Unter-Workflow handelt" }, "responsibleUserRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "logEntries": { "type": "array", "description": "Logging-Einträge chronologisch sortiert", "items": { "$ref": "#/components/schemas/common-workflow-WorkflowInstanceLogLine" } }, "splitResult": { "type": "string", "description": "Für Split-Gateways: mit welchem Ergebnis wurde dieses Work-Item ausgeführt" } } }, "common-workflow-WorkflowInstance": { "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "state": { "type": "string", "description": "Status einer Workflow-Instanz", "enum": [ "CREATED", "IN_PROCESS", "COMPLETED_SUCCESSFULLY", "COMPLETED_WITH_FAILURE", "ERRONEOUS", "ABORTED_CRASHED", "ABORTED_MANUALLY", "CRASHED", "WAITING", "INTERRUPTED" ] }, "workflowRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "workItems": { "type": "array", "description": "Schritte des Workflows", "items": { "$ref": "#/components/schemas/common-workflow-WorkItem" } }, "logEntries": { "type": "array", "description": "Logging-Einträge chronologisch sortiert", "items": { "$ref": "#/components/schemas/common-workflow-WorkflowInstanceLogLine" } } } }, "common-workflow-WorkflowInstanceLogLine": { "description": "Logging-Einträge chronologisch sortiert", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "workflowInstanceId": { "type": "integer", "format": "int64", "description": "ID der Workflow-Instanz" }, "workItemId": { "type": "integer", "format": "int64", "description": "ID des Work-Items" }, "logTime": { "type": "string", "format": "date-time", "description": "Zeitstempel" }, "origin": { "type": "string", "description": "Wodurch wurde dieser Eintrag ausgelöst", "enum": [ "DEBUG", "INFO", "WARNING", "ERROR", "CONSOLE", "STACKTRACE" ] }, "message": { "type": "string", "description": "Nachricht" }, "messageKey": { "type": "string", "description": "I18n-Key" }, "propertyPath": { "type": "string", "description": "Pfad" }, "messageParameter": { "type": "object", "additionalProperties": { "type": "object", "description": "Parameter für die I18n-Nachricht" }, "description": "Parameter für die I18n-Nachricht" } } }, "erp-finance-ClearingExpectedResponse": { "properties": { "qualifier": { "type": "string", "description": "Forderung oder Verbindlichkeit", "enum": [ "PAYABLE", "RECEIVABLE" ] }, "amount": { "type": "number", "description": "saldo" } } }, "erp-finance-ManualEntry": { "properties": { "version": { "type": "string", "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": { "properties": { "version": { "type": "string", "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": "Ein Kurzname für den Mahnlauf" }, "number": { "type": "string", "description": "Die Mahnlauf-Nummer", "readOnly": true }, "processedAt": { "type": "string", "format": "date-time", "description": "Verbuchungsdatum", "readOnly": true } } }, "erp-fabrication-DetailsForProductionReversal": { "description": "Details zur Stornierung einer Position", "properties": { "documentId": { "type": "integer", "format": "int64", "description": "ID des Belegs" }, "documentLineId": { "type": "integer", "format": "int64", "description": "ID der Belegposition" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "producedQuantity": { "type": "number", "description": "Noch zu produzierende Menge" }, "producedSerialNumbers": { "type": "array", "description": "Produzierte Seriennummern", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationProducedSerialNumber" } }, "usedComponents": { "type": "array", "description": "Verbaute Komponenten", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationUsedComponent" } } } }, "erp-fabrication-FabricationProducedSerialNumber": { "description": "Produzierte Seriennummer zu einer Position", "properties": { "articleSerialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "quantity": { "type": "number", "description": "Menge" } } }, "erp-fabrication-FabricationUsedComponent": { "description": "Verbaute Komponenten", "properties": { "documentLineComponentId": { "type": "integer", "format": "int64", "description": "ID der Komponente" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "quantity": { "type": "number", "description": "Verbaute Menge" }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ] } } }, "erp-fabrication-DetailsForProduction": { "description": "Details zur Produktion einer Position", "properties": { "documentId": { "type": "integer", "format": "int64", "description": "ID des Belegs" }, "documentLineId": { "type": "integer", "format": "int64", "description": "ID der Belegposition" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ] }, "serialNumbersToProduce": { "type": "array", "description": "Zu produzierende Seriennummern", "items": { "$ref": "#/components/schemas/erp-fabrication-SerialNumberWithQuantityApi" } }, "serialNumbersRequired": { "type": "boolean", "default": false, "description": "Müssen noch Seriennummern erfasst werden?" }, "remainingQuantity": { "type": "number", "description": "Noch zu produzierende Menge" }, "remainingComponents": { "type": "array", "description": "Offene zu verbauende Komponenten", "items": { "$ref": "#/components/schemas/erp-fabrication-FabricationRemainingComponent" } } } }, "erp-fabrication-FabricationRemainingComponent": { "description": "Noch offenes zu verbauendes Material", "properties": { "lineSerialNumber": { "$ref": "#/components/schemas/erp-product-ArticleSerialNumber" }, "documentLineComponentId": { "type": "integer", "format": "int64", "description": "ID der Komponente" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "quantity": { "type": "number", "description": "Offene Menge" }, "serialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ] } } }, "erp-fabrication-DetailsForDefectiveMarking": { "description": "Details zur Markierung von fehlerhaften Positionen", "properties": { "documentId": { "type": "integer", "format": "int64", "description": "ID des Belegs" }, "documentLineId": { "type": "integer", "format": "int64", "description": "ID der Belegposition" }, "articleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "quantityInQA": { "type": "number", "description": "Noch zu prüfende Menge" }, "quantityDefective": { "type": "number", "description": "Bereits als defekt markierte Menge" }, "requiredSerialType": { "type": "string", "description": "Serientyp eines Artikels", "enum": [ "NONE", "SERIAL_NUMBER", "LOT", "BEST_BEFORE", "DOUBLE_SERIAL_NUMBER" ] }, "serialNumbersInQA": { "type": "array", "description": "Seriennummern in QS", "items": { "$ref": "#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber" } }, "defectiveSerialNumbers": { "type": "array", "description": "Defekte Seriennummern", "items": { "$ref": "#/components/schemas/erp-fabrication-DocumentLineFabricationDetailSerialNumber" } } } }, "erp-document-DocumentUiHintCollection": { "properties": { "documentHints": { "type": "array", "description": "UI-Hints, die sich auf den Dokumenttypen und den Account beziehen", "items": { "type": "string", "description": "UI-Hints, die sich auf den Dokumenttypen und den Account beziehen" } }, "positionHints": { "type": "array", "description": "UI-Hints, die sich auf den Dokumenttypen und einen Artikel beziehen", "items": { "$ref": "#/components/schemas/erp-document-PositionUiHintCollection" } } } }, "erp-document-PositionUiHintCollection": { "description": "UI-Hints, die sich auf den Dokumenttypen und einen Artikel beziehen", "properties": { "articleId": { "type": "integer", "format": "int64", "description": "Artikel, auf den sich die UI-Hints beziehen" }, "uiHints": { "type": "array", "description": "UI-Hints für den Artikel und Dokumenttypen", "items": { "type": "string", "description": "UI-Hints für den Artikel und Dokumenttypen" } } } }, "erp-document-DocumentTransitionRef": { "properties": { "id": { "type": "string", "description": "das gleiche wie transition id für das UI" }, "transitionId": { "type": "string", "description": "transition id" }, "transitionLabel": { "type": "string", "description": "label of this transition", "readOnly": true }, "uiHint": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "stateDefinition": { "type": "string", "description": "state definition of the target state", "readOnly": true }, "typeCategory": { "type": "string", "description": "Dokumenttypen", "enum": [ "CUSTOMER_OFFER", "CUSTOMER_ORDER", "CUSTOMER_DELIVERY_DOCUMENT", "CUSTOMER_INVOICE", "CUSTOMER_PROFORMA_INVOICE", "CUSTOMER_DELIVERY_INVOICE", "CUSTOMER_PROGRESS_INVOICE", "CUSTOMER_FINAL_INVOICE", "CUSTOMER_PARTIAL_INVOICE", "CUSTOMER_INVOICE_CANCELLATION", "CUSTOMER_DELIVERY_INVOICE_CANCELLATION", "CUSTOMER_PROGRESS_INVOICE_CANCELLATION", "CUSTOMER_FINAL_INVOICE_CANCELLATION", "CUSTOMER_PARTIAL_INVOICE_CANCELLATION", "CUSTOMER_DEPOSIT_INVOICE", "CUSTOMER_DEPOSIT_INVOICE_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK", "CUSTOMER_CREDIT_NOTE_WITHOUT_STOCK_CANCELLATION", "CUSTOMER_CREDIT_NOTE_WITH_STOCK_CANCELLATION", "CUSTOMER_RETURN_ANNOUNCEMENT", "CUSTOMER_GOODS_RETURN", "SUPPLIER_PRICE_REQUEST", "SUPPLIER_ORDER", "SUPPLIER_DELIVERY_DOCUMENT", "SUPPLIER_INVOICE", "SUPPLIER_DELIVERY_INVOICE", "SUPPLIER_CREDIT_NOTE_WITH_STOCK", "SUPPLIER_CREDIT_NOTE_WITHOUT_STOCK", "SUPPLIER_DEPOSIT_INVOICE", "SUPPLIER_PROGRESS_INVOICE", "SUPPLIER_PARTIAL_INVOICE", "SUPPLIER_FINAL_INVOICE", "COMMISSION_SETTLEMENT", "COMMISSION_SETTLEMENT_CANCELLATION", "SUPPLIER_COMMISSION_CREDIT_NOTE", "SUPPLIER_COMMISSION_CREDIT_NOTE_CANCELLATION", "CUSTOMER_SUBSCRIPTION_CONTRACT", "POS_CASH_JOURNAL_OPENING", "POS_CASH_RECEIPT", "POS_RETURN_CASH_RECEIPT", "POS_CASH_JOURNAL_DEPOSIT", "POS_CASH_JOURNAL_EXPENSE", "POS_CASH_JOURNAL_WITHDRAWAL", "POS_CASH_JOURNAL_CLOSING", "FABRICATION_ORDER" ], "readOnly": true }, "typeId": { "type": "string", "description": "document-type-id des ziels", "readOnly": true }, "typeKey": { "type": "string", "description": "document-type-key des ziels", "readOnly": true }, "typeLabel": { "type": "string", "description": "type-label", "readOnly": true }, "isDefaultTypeForCategory": { "type": "boolean", "description": "document-type ist Default für die Kategorie", "readOnly": true }, "targetState": { "type": "string", "description": "Der Ziel-Status der Transition", "readOnly": true }, "sortOrder": { "type": "integer", "format": "int32", "description": "Sortier-Reihenfolge", "readOnly": true } }, "required": [ "id", "transitionId" ] }, "erp-document-DocumentHistoryNode": { "properties": { "documentId": { "type": "string", "description": "the id of the document" }, "number": { "type": "string", "description": "the number of the document" }, "documentDate": { "type": "string", "format": "date", "description": "documentDate" }, "totalGrossPrice": { "type": "number", "description": "gross total price (GROSS)" }, "totalNetPrice": { "type": "number", "description": "net total price (NET)" }, "documentType": { "type": "string", "description": "type of this document" }, "documentTypeId": { "type": "string", "description": "typeId of this document" }, "documentState": { "type": "string", "description": "state of this document" }, "documentTypeCategory": { "type": "string", "description": "category of this document" }, "childNodes": { "type": "array", "description": "list of documents, this document was transferred into", "items": { "$ref": "#/components/schemas/erp-document-DocumentHistoryNode" } }, "requested": { "type": "boolean", "default": false, "description": "indicates that this document was requested" }, "chainIdentifier": { "type": "string", "description": "Belegketten-Id" } } }, "erp-document-SuccessorDocumentAssignableLinesDocumentLine": { "description": "Belegpositionen für die Vorbelegszuordnung", "properties": { "unassignedLines": { "type": "array", "description": "Positionen ohne Vorbelegsposition", "items": { "$ref": "#/components/schemas/erp-document-DocumentLine" }, "readOnly": true }, "uncompletedLines": { "type": "array", "description": "Nicht (vollständig) übernommene Positionen", "items": { "$ref": "#/components/schemas/erp-document-DocumentLine" }, "readOnly": true }, "completedLines": { "type": "array", "description": "Vollständig übernommene Positionen", "items": { "$ref": "#/components/schemas/erp-document-DocumentLine" }, "readOnly": true } } }, "erp-document-DocumentLineStorageResponse": { "description": "storage option for a document-line", "properties": { "storageRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "reservedQuantity": { "type": "number", "description": "reserved quantity (from customer-orders)" }, "orderedQuantity": { "type": "number", "description": "already ordered quantity (from supplier-orders)" }, "stockAmount": { "type": "number", "description": "the current stock amount" }, "stockAvailable": { "type": "number", "description": "the current available stock amount" } } }, "erp-document-OrderableLine": { "description": "Bestellbare Positionen für Übernahme in Bestellung", "properties": { "documentLineId": { "type": "string", "description": "Id der DocumentLine", "readOnly": true }, "position": { "type": "integer", "format": "int32", "description": "Positionsnummer", "readOnly": true }, "articleNumber": { "type": "string", "description": "Artikelnummer", "readOnly": true }, "articleName": { "type": "string", "description": "Artikelbezeichnung", "readOnly": true }, "articleId": { "type": "integer", "format": "int64", "description": "Artikelnummer", "readOnly": true }, "quantity": { "type": "number", "description": "Menge" }, "order": { "type": "boolean", "default": true, "description": "Bestellen?" }, "supplierRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "availableQuantity": { "type": "number", "description": "Verfügbare Menge", "readOnly": true }, "orderedQuantity": { "type": "number", "description": "Bestellte Menge", "readOnly": true }, "dropShippingPolicy": { "type": "string", "description": "Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf", "enum": [ "ANY", "DROP_SHIPPING", "STORAGE", "STORAGE_WITH_FALLBACK_TO_DROP_SHIPPING" ], "readOnly": true } }, "required": [ "order", "quantity" ] }, "erp-document-DeliveryTransferData": { "description": "In Lieferschein übernehmbare Positionen mit Belegnummern", "properties": { "deliveryTransferableLines": { "type": "array", "description": "In Lieferschein übernehmbare Positionen", "items": { "$ref": "#/components/schemas/erp-document-DeliveryTransferableLine" } }, "externalDocumentNumber": { "type": "string", "description": "externe Belegnummer" }, "documentNumber": { "type": "string", "description": "Belegnummer" }, "deliveryDate": { "type": "string", "format": "date", "description": "Wunsch-Lieferdatum" }, "deliveryDateEnd": { "type": "string", "format": "date", "description": "Wunsch-Lieferdatum bis" }, "confirmedDeliveryDate": { "type": "string", "format": "date", "description": "Bestätigtes Lieferdatum" }, "confirmedDeliveryDateEnd": { "type": "string", "format": "date", "description": "Bestätigtes Lieferdatum bis" } } }, "erp-document-DeliveryTransferableLine": { "description": "In Lieferschein übernehmbare Position", "properties": { "documentLineId": { "type": "integer", "format": "int64", "description": "ID der Document-Line" }, "position": { "type": "integer", "format": "int32", "description": "Positionsnummer" }, "articleNumber": { "type": "string", "description": "Artikelnummer" }, "articleName": { "type": "string", "description": "Artikelbezeichnung" }, "quantity": { "type": "number", "description": "Menge" }, "orderedQuantity": { "type": "number", "description": "Bestellte Menge" }, "targetQuantity": { "type": "number", "description": "Ziel-Menge" }, "storageId": { "type": "integer", "format": "int64", "description": "Die Lager-ID der Position" }, "presetStorageBinRef": { "$ref": "#/components/schemas/erp-stock-StorageBinRef" }, "hasStorageBins": { "type": "boolean", "default": false, "description": "Hat das Ziel-Lager der Position Lagerplätze?" }, "hasPrintLabel": { "type": "boolean", "default": false, "description": "Vorgabe Etikettendruck" }, "deliveryDate": { "type": "string", "format": "date", "description": "Wunsch-Lieferdatum" }, "deliveryDateEnd": { "type": "string", "format": "date", "description": "Wunsch-Lieferdatum bis" }, "confirmedDeliveryDate": { "type": "string", "format": "date", "description": "Bestätigtes Lieferdatum" }, "confirmedDeliveryDateEnd": { "type": "string", "format": "date", "description": "Bestätigtes Lieferdatum bis" } } }, "erp-document-DocumentLineWithBooking": { "properties": { "line": { "$ref": "#/components/schemas/erp-document-DocumentLine" }, "booking": { "$ref": "#/components/schemas/erp-document-DocumentLineBooking" }, "quantity": { "type": "number", "description": "Die Menge dieser Kombination" } } }, "erp-document-CompleteDocumentAvailabilityInfoApi": { "description": "Verfügbarkeitsinformationen zu einem Beleg und seinen Positionen", "properties": { "documentAvailabilityInfo": { "$ref": "#/components/schemas/erp-document-DocumentAvailabilityInfoApi" }, "lineAvailabilityInfos": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/erp-document-DocumentLineAvailabilityInfoApi" }, "description": "Verfügbarkeitsinformationen zu den einzelnen Positionen" } } }, "erp-document-DocumentAvailabilityInfoApi": { "description": "Verfügbarkeitsinformationen zu einem Beleg", "properties": { "orderAvailability": { "type": "string", "description": "Verfügbarkeit eines Auftrags", "enum": [ "FULL_DELIVERABLE", "NOTHING_DELIVERABLE", "AT_LEAST_ONE_LINE_IS_FULL_DELIVERABLE", "AT_LEAST_ONE_LINE_IS_PARTIALLY_DELIVERABLE" ] }, "orderStackProcessingType": { "type": "string", "description": "Stapelverarbeitungsinformationen für Aufträge", "enum": [ "NO_PICKING", "ACCORDING_TO_CRITERIA", "ONLY_FULL_ORDER", "ONLY_FULL_ORDER_LINES", "AVAILABLE_QUANTITIES", "NO_PROCESSING", "FULL_ORDER_LINES_MAX_TWO_PARTIAL_DELIVERIES", "AVAILABLE_QUANTITIES_MAX_TWO_PARTIAL_DELIVERIES", "FULL_ORDER_LINES_MAX_THREE_PARTIAL_DELIVERIES", "AVAILABLE_QUANTITIES_MAX_THREE_PARTIAL_DELIVERIES", "AVAILABLE_QUANTITIES_FINISH_ORDER" ] }, "maxPossibleDeliveries": { "type": "integer", "format": "int32", "description": "Maximale Anzahl an Lieferungen" } } }, "erp-document-DocumentLineAvailabilityInfoApi": { "description": "Verfügbarkeitsinformationen zu einer Position", "properties": { "orderLineAvailability": { "type": "string", "description": "Verfügbarkeit einer Auftragsposition", "enum": [ "FULL_DELIVERABLE", "NOTHING_DELIVERABLE", "PARTIALLY_DELIVERABLE", "LINE_ALREADY_DELIVERED" ] }, "availableQuantity": { "type": "number", "description": "(Benötigte) verfügbare Menge" }, "maxAvailableQuantity": { "type": "number", "description": "Maximal verfügbare Menge" }, "orderedQuantity": { "type": "number", "description": "Bestellte Menge" } } }, "erp-document-DocumentTypeTransition": { "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" } }, "required": [ "key", "label", "targetState" ] }, "erp-document-DocumentTypeStateRef": { "properties": { "key": { "type": "string", "description": "key for this state" }, "label": { "type": "string", "description": "label/name of this state" } } }, "erp-crm-CrmBillingRun": { "description": "CRM Abrechnungslauf", "properties": { "number": { "type": "integer", "format": "int64", "description": "Nummer", "readOnly": true }, "successful": { "type": "boolean", "description": "Erfolgreich?", "readOnly": true }, "logLines": { "type": "array", "description": "Logeinträge", "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" }, "readOnly": true }, "billingDocuments": { "type": "array", "description": "Abrechnungseinträge", "items": { "$ref": "#/components/schemas/erp-document-DocumentRef" }, "readOnly": true } } }, "erp-bank-BankAction": { "properties": { "description": { "type": "string", "description": "Description of the action" }, "type": { "type": "string", "description": "action type", "enum": [ "OPEN_URL" ] }, "expiration": { "type": "string", "format": "date-time", "description": "Expiration of the action" }, "payload": { "type": "object", "additionalProperties": { "type": "string", "description": "Payload of actions to take (i.e. URL for type=OPEN_URL" }, "description": "Payload of actions to take (i.e. URL for type=OPEN_URL" } } }, "erp-bank-BankRef": { "properties": { "referenceId": { "type": "string", "description": "reference id" }, "label": { "type": "string", "description": "description" }, "bankName": { "type": "string", "description": "bank name" }, "bic": { "type": "string", "description": "BIC" }, "blz": { "type": "string", "description": "BLZ" }, "logoUrl": { "type": "string", "description": "URL des Bank-Logos" } } }, "erp-bank-BankPaymentAction": { "properties": { "description": { "type": "string", "description": "Description of the action" }, "type": { "type": "string", "description": "action type", "enum": [ "OPEN_URL" ] }, "expiration": { "type": "string", "format": "date-time", "description": "Expiration of the action" }, "webFormUrl": { "type": "string", "description": "die URL der zu öffnenden Webform" } } }, "erp-bank-BankPaymentRun": { "properties": { "version": { "type": "string", "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": "Beschreibung des Vorschlags" }, "number": { "type": "string", "description": "Vorschlags-Nummer" }, "manualExecutionDateTime": { "type": "string", "format": "date-time", "description": "Manuell gesetzter Ausführungs-Zeitpunkt" }, "processed": { "type": "boolean", "description": "Wurde dieser Vorschlag verarbeitet", "readOnly": true }, "canceled": { "type": "boolean", "description": "Wurde dieser Vorschlag storniert", "readOnly": true }, "processedAt": { "type": "string", "format": "date-time", "description": "Verbuchungsdatum", "readOnly": true }, "bankAccount": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } } }, "erp-bank-BankConnectionDto": { "properties": { "referenceId": { "type": "string" }, "bankReferenceId": { "type": "string" }, "label": { "type": "string" }, "bankName": { "type": "string" }, "bic": { "type": "string" }, "blz": { "type": "string" }, "lastManualUpdate": { "type": "string", "format": "date-time" }, "lastManualUpdateMessage": { "type": "string" }, "lastManualUpdateState": { "type": "string", "enum": [ "OK", "BANK_SERVER_REJECTION", "INTERNAL_SERVER_ERROR", "NONE" ] }, "lastAutoUpdate": { "type": "string", "format": "date-time" }, "lastAutoUpdateMessage": { "type": "string" }, "lastAutoUpdateState": { "type": "string", "enum": [ "OK", "BANK_SERVER_REJECTION", "INTERNAL_SERVER_ERROR", "NONE" ] }, "consentExpiresAt": { "type": "string", "format": "date-time" } } }, "erp-stock-ArticleStorageMovement": { "description": "Lagerbewegungs-Infos", "properties": { "articleId": { "type": "string", "description": "Das Produkt, dessen Lagerinfos hier ausgegeben werden" }, "latestDecrement": { "$ref": "#/components/schemas/erp-stock-ArticleStorageMovement.Movement" }, "latestIncrement": { "$ref": "#/components/schemas/erp-stock-ArticleStorageMovement.Movement" }, "nextDelivery": { "$ref": "#/components/schemas/erp-stock-ArticleStorageMovement.Movement" } }, "required": [ "articleId" ] }, "erp-stock-ArticleStorageMovement.Movement": { "description": "Nächste Lieferung", "properties": { "movementDate": { "type": "string", "format": "date", "description": "Datum" }, "documentId": { "type": "integer", "format": "int64", "description": "Document-Id" }, "documentLineId": { "type": "integer", "format": "int64", "description": "DocumentLine-Id" }, "quantity": { "type": "number", "description": "Menge" } } }, "erp-stock-ArticleStock": { "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" }, "quantityInFabrication": { "type": "number", "description": "Aktuelle Menge in Produktion" }, "stockAmount": { "type": "number", "description": "Aktueller Bestand in den Sales-Storages" }, "stockAvailable": { "type": "number", "description": "Aktuelle verfügbare Menge in den Sales-Storages" }, "virtualStockAmount": { "type": "number", "description": "Aktueller \"virtueller\" Bestand in den Sales-Storages (wenn größere Gebinde in dieses aufgelöst werden würden)" }, "virtualStockAvailable": { "type": "number", "description": "Aktuelle \"virtuelle\" verfügbare Menge in den Sales-Storages (wenn größere Gebinde in dieses aufgelöst werden würden)" } } }, "erp-product-ArticleComponentCollection": { "description": "Komponenten eines Baugruppen- oder Jumbo-Artikels mit Summen", "properties": { "version": { "type": "string", "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ören", "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" } }, "required": [ "components" ] }, "erp-product-ArticleBundleConversionInfo": { "description": "Informationen zur Zusammenführung und Auflösung von Artikelgebinden", "properties": { "articleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "dissolveRatios": { "type": "array", "description": "Mögliche Ziele für die Auflösung", "items": { "$ref": "#/components/schemas/erp-product-ArticleConversionRatio" } }, "mergeRatios": { "type": "array", "description": "Mögliche Ziele für die Zusammenführung", "items": { "$ref": "#/components/schemas/erp-product-ArticleConversionRatio" } } } }, "erp-product-ArticleConversionRatio": { "description": "Infos zur Umwandlung in einen Artikel", "properties": { "articleRef": { "$ref": "#/components/schemas/erp-product-ProductArticleRef" }, "sourceUnitTypeRef": { "$ref": "#/components/schemas/common-masterdata-UnitTypeReference" }, "factor": { "type": "number", "format": "double", "description": "Faktor" } } }, "erp-product-ArticlePrintLabelOrderResponse": { "description": "Antwort Welche Artikel wie oft gedruckt werden soll", "properties": { "position": { "type": "integer", "format": "int32", "description": "Position", "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" }, "documentLine": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "documentLineComponent": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "picklistLine": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "picklistLineComponent": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "print": { "type": "boolean", "description": "Etikettendruck" }, "quantity": { "type": "integer", "format": "int32", "description": "Menge" }, "languageCode": { "type": "string", "description": "Sprache (ISO Alpha-2)" }, "description": { "type": "string", "description": "Produktbeschreibung", "maxLength": 2147483647, "minLength": 0 } } }, "erp-account-AccountDuplicate": { "properties": { "version": { "type": "string", "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", "default": false, "description": "wurde der Account als nicht duplikat markiert" } } }, "dms-wiki-WikiTreeNodeDto": { "properties": { "id": { "type": "integer", "format": "int64", "description": "ID der Wiki-Seite" }, "subject": { "type": "string", "description": "Name der Wiki-Seite" }, "subNodes": { "type": "array", "description": "Darunter liegende Wiki-Seiten", "items": { "$ref": "#/components/schemas/dms-wiki-WikiTreeNodeDto" } } } }, "dms-shelf-ShelfDocumentProtocol": { "properties": { "version": { "type": "string", "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", "format": "int64", "description": "Verweis auf das zugehörige Shelf-Document" }, "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", "format": "date-time", "description": "Zeitpunkt, an dem der Eintrag erstellt wurde" }, "userName": { "type": "string", "description": "Nutzer, der den Eintrag ausgelöst hat" } } }, "erp-finance-FinanceBooking": { "properties": { "version": { "type": "string", "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", "format": "int64", "description": "record number" }, "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", "DUNNING_CHARGE_MANUAL", "DUNNING_CHARGE_MANUAL_REVERSAL", "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_CASH_JOURNAL_WITHDRAWAL", "POS_RECEIPT", "POS_RETURN_RECEIPT" ] } } }, "common-system-AppMessageQueueDefinition.QueueDestinationDescription": { "properties": { "owner": { "type": "string" }, "queue": { "type": "string" }, "description": { "type": "string" } } }, "common-scripting-Script": { "description": "Script", "properties": { "version": { "type": "string", "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", "minLength": 1 }, "scriptSource": { "type": "string", "description": "Das auszuführende Skript", "maxLength": 2147483647, "minLength": 0 }, "scriptModuleRef": { "$ref": "#/components/schemas/core-api-ApiObjectReference" } }, "required": [ "moduleName" ] }, "common-scripting-ScriptRun": { "properties": { "version": { "type": "string", "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": { "type": "string", "description": "ID der Session", "maxLength": 255, "minLength": 0 }, "logLines": { "type": "array", "description": "Log des Runs", "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" } }, "startedAt": { "type": "string", "format": "date-time", "description": "Startzeitpunkt" }, "finishAt": { "type": "string", "format": "date-time", "description": "Endzeitpunkt" }, "successful": { "type": "boolean", "default": true, "description": "War der Run erfolgreich?" } }, "required": [ "finishAt", "identifier", "script", "startedAt" ] }, "common-scripting-ScriptDeprecationLog": { "properties": { "version": { "type": "string", "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": "Modul", "maxLength": 255, "minLength": 0 }, "containerId": { "type": "integer", "format": "int64", "description": "Container ID" }, "deprecatedElement": { "type": "string", "description": "Element", "minLength": 1 }, "deprecatedElementType": { "type": "string", "description": "Arten von Elementen in Skript-Typen", "enum": [ "TYPE", "ATTRIBUTE", "METHOD" ] }, "deprecationMessage": { "type": "string", "description": "Meldung", "maxLength": 2147483647, "minLength": 0 } }, "required": [ "containerId", "deprecatedElement", "deprecatedElementType", "moduleName" ] }, "common-eav-EavEntityRef": { "properties": { "key": { "type": "string", "description": "Identifier" }, "label": { "type": "string", "description": "a short description", "readOnly": true } }, "required": [ "key" ] }, "common-workflow-WorkflowTriggerDto": { "properties": { "id": { "type": "string", "description": "Unique identifier of the Object" }, "topic": { "type": "string", "description": "Thema, das diesen Workflow auslöst" }, "triggerName": { "type": "string", "description": "Genauerer Name des auslösers" } } }, "core-cunit-SearchDialogWithIdentifier": { "description": "Definition eines Search-Dialogs", "properties": { "identifier": { "type": "string", "description": "Identifier des Search-Dialogs" }, "searchDialog": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "common-user-MeResponse": { "properties": { "user": { "$ref": "#/components/schemas/common-user-User" }, "company": { "$ref": "#/components/schemas/common-user-MyCompany" }, "tenantId": { "type": "integer", "format": "int64", "description": "Aktuelle Tenant-ID", "readOnly": true }, "managedByPartner": { "type": "boolean", "description": "Ob der Kunde dieses Tenants von einem Partner betreut wird", "readOnly": true } } }, "common-user-MyCompany": { "description": "Meine Adresse", "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ße" }, "streetAddressNumber": { "type": "string", "description": "Hausnummer" }, "city": { "type": "string", "description": "Stadt" }, "postalCode": { "type": "string", "description": "Postleitzahl" }, "languageCodeIso2a": { "type": "string", "description": "Sprachcode Iso2a" }, "languageCodeId": { "type": "integer", "format": "int64", "description": "SprachcodeId" }, "countryCodeIso2a": { "type": "string", "description": "Ländercode Iso2a" }, "countryCodeId": { "type": "integer", "format": "int64", "description": "Id des Landes" }, "currencyCodeIso3a": { "type": "string", "description": "Währungscode Iso3a" }, "currencyCodeId": { "type": "integer", "format": "int64", "description": "Id der Währung" }, "createdAt": { "type": "string", "format": "date-time", "description": "Zeit der Anlegung" } } }, "common-ui-UiSettingResponse": { "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": { "properties": { "property": { "type": "string", "minLength": 1 }, "displayName": { "type": "string" }, "functions": { "type": "array", "items": { "type": "string" } }, "visible": { "type": "boolean" } }, "required": [ "property" ] }, "common-text-QueryBaseHolderPresetEntity": { "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": { "type": "string", "maxLength": 255, "minLength": 0 }, "templateGroupKey": { "type": "string", "maxLength": 255, "minLength": 0 }, "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", "SALES_AGENT", "POS_REGISTER", "CASH_DRAWER", "POS_PAYMENT_METHOD", "POS_DEPOSIT_EXPENSE_TYPE", "COMMISSION_RUN_SALES_AGENT" ] } }, "required": [ "defaultFor", "templateGroupKey", "templateId" ] }, "common-task-TaskLog": { "properties": { "version": { "type": "string", "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", "format": "uuid", "description": "description of this task", "readOnly": true }, "dueTime": { "type": "string", "format": "date-time", "description": "start time (geplant)", "readOnly": true }, "queueDurationInSeconds": { "type": "integer", "format": "int64", "description": "queue zeit", "readOnly": true }, "startTime": { "type": "string", "format": "date-time", "description": "start time", "readOnly": true }, "endTime": { "type": "string", "format": "date-time", "description": "end time", "readOnly": true }, "durationInSeconds": { "type": "integer", "format": "int64", "description": "duration", "readOnly": true }, "status": { "type": "string", "description": "result of run", "enum": [ "CREATED", "QUEUED", "RUNNING", "TERMINATED", "SUCCESSFUL", "ERRONEOUS", "FATAL", "CANCELLED" ], "readOnly": true }, "nodeName": { "type": "string", "description": "node-name ", "readOnly": true }, "logLines": { "type": "array", "description": "lines of log", "items": { "$ref": "#/components/schemas/common-task-TaskLogLine" }, "readOnly": true } } }, "common-task-SupportTask": { "properties": { "identifier": { "type": "string", "description": "identifier", "minLength": 1 }, "description": { "type": "string", "description": "description" } }, "required": [ "identifier" ] }, "core-product-AvailableLicense": { "properties": { "licenseKey": { "type": "string", "description": "der valide lizenz-key" }, "licenseValidTo": { "type": "string", "format": "date", "description": "Bei Testlizenzen -> valide bis" } } }, "common-sequencer-PooledSequence": { "properties": { "version": { "type": "string", "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", "format": "int64", "description": "reserved sequence id", "readOnly": true } } }, "common-sequencer-Sequence": { "properties": { "version": { "type": "string", "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", "format": "int64", "description": "last returned sequence", "readOnly": true } } }, "core-unknownmodule-ParameterSourceRef": { "description": "Referenze auf eine Parameter-Klasse", "properties": { "key": { "type": "string", "description": "der key für diesen Parameter" }, "caption": { "type": "string", "description": "die caption" }, "description": { "type": "string", "description": "die beschreibung" }, "unbounded": { "type": "boolean", "description": "ist es ein allgemeiner parameter" } } }, "common-observer-PossibleSubscription": { "properties": { "refKey": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } } } }, "common-output-ReportTemplateResponse": { "properties": { "id": { "type": "integer", "format": "int64", "description": "id der resource im DMS", "readOnly": true }, "description": { "type": "string", "description": "Beschreibung", "readOnly": true }, "filename": { "type": "string", "description": "der Dateiname", "readOnly": true } } }, "common-output-OutputReportType": { "properties": { "version": { "type": "string", "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ür diesen ReportType", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true }, "engine": { "type": "string", "description": "Druck-Techniken", "enum": [ "VQL_REPORTS", "TEXT_ONLY" ], "readOnly": true }, "systemPresetting": { "type": "boolean", "description": "Die verwendete Druck-Technik", "readOnly": true }, "label": { "type": "string", "description": "Kurzbezeichnung", "readOnly": true } } }, "common-output-OutputModuleInfo": { "properties": { "key": { "type": "string", "description": "output module key" }, "label": { "type": "string", "description": "output module label" }, "domainIdentifier": { "type": "string", "description": "Welcher Domain gehört dieses OutputModul an (wichtig für Platzhalter etc)", "readOnly": true }, "canCreateLayout": { "type": "boolean", "default": false, "description": "gibt es eine möglichkeit, neue Reports für diesen Druck zu hinterlegen", "readOnly": true }, "sources": { "type": "array", "description": "welche neuanlage-modi werden unterstützt", "items": { "type": "string", "description": "Report Quellen", "enum": [ "PARAMETER_MODE", "FILE_MODE" ] }, "readOnly": true }, "supportedOutputType": { "type": "array", "default": false, "description": "welche Ausgabetypen werden unterstützt", "items": { "$ref": "#/components/schemas/core-api-ApiObjectReference" }, "readOnly": true }, "subreportOnlyModule": { "type": "boolean", "default": false, "description": "unterstützt das Modul nur Subreports, bietet als keine eigene Druck-Implementierung", "readOnly": true }, "supportOutputFilterScript": { "type": "boolean", "default": false, "description": "unterstützt das Modul Output-Filter-Scripte", "readOnly": true }, "outputFilterScriptModule": { "type": "string", "description": "Script-Modul für Output-Filter scripte", "readOnly": true }, "freePrinting": { "type": "boolean", "description": "Ist dieses Modul ein freier Report?", "readOnly": true } } }, "common-fulltext-SearchEntryStatistics": { "properties": { "type": { "type": "string" }, "count": { "type": "integer", "format": "int64" } } }, "common-email-EmailContent": { "description": "content", "properties": { "html": { "type": "string", "description": "Inhalt-Html" }, "text": { "type": "string", "description": "Inhalt-Text" } } }, "common-email-EmailList": { "properties": { "version": { "type": "string", "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änger" }, "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": { "properties": { "version": { "type": "string", "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ür den Fehler" }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/common-email-EmailNotificationStatus" } }, "timestamp": { "type": "string", "format": "date-time", "description": "Zeitstempel" } } }, "common-email-EmailNotificationStatus": { "description": "Status", "properties": { "status": { "type": "string" }, "action": { "type": "string" }, "diagnosticCode": { "type": "string" }, "emailAddress": { "type": "string" } } }, "common-data_import-MultiPartImportOrderedRuleSetExtensive": { "description": "Import-Regelwerk und -Lauf nach Reihenfolge", "properties": { "version": { "type": "string", "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", "format": "int32", "description": "Stufe, auf dem der Import-Run gestartet wird" }, "fileName": { "type": "string", "description": "Datei, die für den Import verwendet wird" }, "ruleSet": { "$ref": "#/components/schemas/common-data_import-ImportMappingRuleSet" }, "label": { "type": "string", "description": "Bezeichnung" } } }, "common-data_import-MultiPartImportRunExtensive": { "properties": { "version": { "type": "string", "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", "default": false, "description": "Handelt es sich um eine Vorlage?" } } }, "common-data_import-BatchProcessingTargetFieldApi": { "properties": { "path": { "type": "string", "description": "für das Mapping relavanter Pfad" }, "displayName": { "type": "string", "description": "Anzeigename für 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": { "properties": { "startEntityIdentifier": { "type": "string", "description": "Haupt-Entity des Imports" }, "key": { "type": "string", "description": "Eindeutiger Schlüssel für eine Import-Art" }, "subgraphs": { "type": "array", "description": "Unter-Objekte, für die eine resolving strategy definiert werden kann", "items": { "$ref": "#/components/schemas/common-data_import-ResolvingStrategyInformation" } }, "supportsValidation": { "type": "boolean", "description": "Wird der Validierungsschritt unterstützt?" }, "type": { "type": "string", "enum": [ "ENTITY_IMPORT", "FILE_EXPORT" ] } } }, "common-data_import-ResolvingStrategyInformation": { "description": "Unter-Objekte, für die eine resolving strategy definiert werden kann", "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" ] } } } }, "core-cunit-CuTemplateGroup": { "properties": { "key": { "type": "string", "description": "der group key" }, "label": { "type": "string", "description": "beschreibung der gruppe" } } }, "core-cunit-CuTemplate": { "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": { "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": { "description": "The full list of validation problems", "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" ] } } }, "core-cunit-CuAttributes": { "properties": { "attributes": { "type": "array", "description": "attribute", "items": { "$ref": "#/components/schemas/core-cunit-CuAttribute" } } } }, "core-cunit-CuEntityInfo": { "description": "Eine Entity im CUnit-Modell mit ihren Attributen", "properties": { "identifier": { "type": "string", "description": "Der einfache Identifier der Entity (z.B. 'AccountEntity')", "readOnly": true }, "fullyQualifiedIdentifier": { "type": "string", "description": "Der vollqualifizierte Identifier der Entity (z.B. 'ag.vario.erp.account.AccountEntity')", "readOnly": true }, "displayName": { "type": "string", "description": "Der Anzeigename der Entity", "readOnly": true }, "tableName": { "type": "string", "description": "Der Tabellenname der Entity in der Datenbank", "readOnly": true }, "attributes": { "type": "array", "description": "Die Attribute dieser Entity", "items": { "$ref": "#/components/schemas/core-cunit-CuAttribute" }, "readOnly": true } } }, "core-cunit-CuDialect": { "properties": { "functions": { "type": "array", "description": "Die Funktionen, die verwendet werden können", "items": { "$ref": "#/components/schemas/core-cunit-CuDialect.CuDialectFunctionRef" }, "readOnly": true }, "dataTypes": { "type": "array", "description": "Die Datentype, die im Standard vorhanden sind", "items": { "$ref": "#/components/schemas/core-cunit-CuAttributeDataType" }, "readOnly": true } } }, "core-cunit-CuDialect.CuDialectFunctionRef": { "description": "Die Funktionen, die verwendet werden können", "properties": { "identifier": { "type": "string", "description": "der Function Identifier" }, "aggregate": { "type": "boolean", "default": false, "description": "handelt es sich um eine Aggregat-Funktion", "readOnly": true }, "messageCode": { "type": "string", "description": "localizeable Label", "readOnly": true } } }, "common-audit-SnapshotAndPredecessorApi": { "properties": { "current": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "previous": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" } } }, "core-api-AfterTenantMigrationActionExecutionHistory": { "description": "Historie der ausgeführten einmaligen Aktionen, welche nach den DB-Migrationen ausgeführt werden sollen", "properties": { "version": { "type": "string", "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", "minLength": 1 } }, "required": [ "className" ] }, "node-api-AppManifestBaseDto": { "description": "Manifest", "properties": { "version": { "type": "string", "description": "Version Identifier for this Object (for PUT)" }, "info": { "$ref": "#/components/schemas/core-api-MetaInfo" }, "id": { "type": "string", "description": "Unique identifier of the Object" }, "identifier": { "type": "string", "format": "uuid", "description": "Unique Identifier of this CompanionApp" }, "label": { "type": "string", "description": "label / short description" }, "appVersion": { "type": "string", "description": "the latest version of this app" }, "privateApp": { "type": "boolean", "default": true, "description": "is this a private app or published via the public app-store" }, "description": { "type": "string", "description": "long description" }, "pcInstallationDeletionUrl": { "type": "string", "description": "Webhook called if the customer uninstall the app from their installation" }, "uiIntegrations": { "$ref": "#/components/schemas/node-unknownmodule-UiIntegrationsDto" }, "requirements": { "$ref": "#/components/schemas/node-unknownmodule-RequirementsDto" }, "authorizationVerbs": { "type": "array", "description": "access rights this app needs", "items": { "$ref": "#/components/schemas/node-unknownmodule-AuthorizationVerbDto" } }, "active": { "type": "boolean", "default": true, "description": "ob die App global aktiv ist" } } }, "node-api-InstalledAppDto": { "properties": { "installedFrom": { "type": "integer", "format": "int64", "description": "User Id" }, "installedAt": { "type": "string", "format": "date-time", "description": "Installation-zeit" }, "appManifest": { "$ref": "#/components/schemas/node-api-AppManifestBaseDto" }, "active": { "type": "boolean", "default": true, "description": "Aktiv" }, "status": { "type": "string", "description": "Status", "enum": [ "ONLINE", "OFFLINE_TOKEN_EXPIRED" ] }, "settings": { "$ref": "#/components/schemas/unknownservice-unknownmodule-JsonNode" }, "appDomain": { "type": "string", "description": "App-Domain (FQDN) für iFrame-Loading" } } }, "node-unknownmodule-AuthorizationVerbDto": { "description": "access rights this app needs", "properties": { "verb": { "type": "string", "description": "Authorization verb" }, "description": { "type": "string", "description": "Description" }, "autoAppendable": { "type": "boolean", "description": "Whether auto-appendable" } } }, "node-unknownmodule-RequirementsDto": { "description": "requirements this app needs", "properties": { "licenseKey": { "type": "string", "description": "Single license key" }, "licenseKeys": { "type": "array", "description": "Multiple license keys", "items": { "type": "string", "description": "Multiple license keys" } }, "permissions": { "type": "array", "description": "Permissions list", "items": { "$ref": "#/components/schemas/node-unknownmodule-RequirementsPermissionDto" } } } }, "node-unknownmodule-RequirementsPermissionDto": { "description": "Permissions list", "properties": { "resource": { "type": "string", "description": "Resource name" }, "verb": { "type": "string", "description": "Permission verb" } } }, "node-unknownmodule-UiIntegrationDto": { "description": "List of UI integrations", "properties": { "id": { "type": "string", "description": "Integration ID" }, "permissionKey": { "type": "string", "description": "Permission key" }, "pointOfIntegration": { "type": "string", "description": "Integration point" }, "msgKey": { "type": "string", "description": "Message key" }, "url": { "type": "string", "description": "Integration URL" }, "iconClass": { "type": "string", "description": "Icon CSS class" }, "contextAttribute": { "type": "object", "additionalProperties": { "type": "object", "description": "Context attributes" }, "description": "Context attributes" } } }, "node-unknownmodule-UiIntegrationsDto": { "description": "configuration of ui integrations", "properties": { "integrations": { "type": "array", "description": "List of UI integrations", "items": { "$ref": "#/components/schemas/node-unknownmodule-UiIntegrationDto" } } } }, "banking-api-BankInitializerKey": { "properties": { "key": { "type": "string", "description": "banking provider key", "enum": [ "FINAPI", "FINAPI_SANDBOX", "MOCKBANK", "APP" ] }, "description": { "type": "string", "description": "banking provider description" } }, "required": [ "description", "key" ] }, "banking-api-BankInitializerParameter": { "properties": { "key": { "type": "string" }, "type": { "type": "string", "enum": [ "STRING", "INTEGER", "BOOLEAN" ] }, "mandatory": { "type": "boolean" }, "defaultValue": { "type": "string" }, "description": { "type": "string" } } }, "node-event-CallStackElement": { "properties": { "method": { "type": "string" }, "duration": { "type": "integer", "format": "int64" }, "calls": { "type": "integer", "format": "int64" }, "elements": { "type": "array", "items": { "$ref": "#/components/schemas/node-event-CallStackElement" } }, "statements": { "type": "array", "items": { "$ref": "#/components/schemas/node-event-CallStatementElement" } } } }, "node-event-CallStatementElement": { "properties": { "payload": { "type": "object" }, "duration": { "type": "integer", "format": "int64", "description": "dauer dieses statements" }, "calls": { "type": "integer", "format": "int64", "description": "aufrufe dieses statements" }, "type": { "type": "string", "description": "type dieses statements. kann frei vergeben werden" } } }, "node-event-ExceptionElement": { "properties": { "message": { "type": "string" }, "traces": { "type": "array", "items": { "type": "string" } }, "nested": { "$ref": "#/components/schemas/node-event-ExceptionElement" } } }, "node-event-ScriptingDeprecationTraceElement": { "properties": { "moduleName": { "type": "string" }, "containerId": { "type": "integer", "format": "int64" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/node-event-ScriptingDeprecationTraceElementEntry" } } } }, "node-event-ScriptingDeprecationTraceElementEntry": { "properties": { "deprecatedElement": { "type": "string" }, "deprecatedElementType": { "type": "string", "description": "Arten von Elementen in Skript-Typen", "enum": [ "TYPE", "ATTRIBUTE", "METHOD" ] }, "deprecationMessage": { "type": "string" } } }, "node-event-SqlStatisticElement": { "properties": { "id": { "type": "string" }, "statement": { "type": "array", "items": { "type": "string" } }, "duration": { "type": "integer", "format": "int64" }, "calls": { "type": "integer", "format": "int64" } } }, "node-event-TraceDump": { "properties": { "key": { "type": "string" }, "dateTime": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "SCRIPT_DEPRECATION", "MIGRATION_ERROR", "ERROR", "TRACE" ] }, "userId": { "type": "integer", "format": "int64" }, "userName": { "type": "string" }, "tenantId": { "type": "integer", "format": "int64" }, "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" } }, "scriptingDeprecationTraces": { "type": "array", "items": { "$ref": "#/components/schemas/node-event-ScriptingDeprecationTraceElement" } }, "gitInfo": { "$ref": "#/components/schemas/node-event-TraceDumpGitInfo" }, "sqlStatistic": { "type": "array", "items": { "$ref": "#/components/schemas/node-event-SqlStatisticElement" } } } }, "node-event-TraceDumpGitInfo": { "properties": { "modules": { "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "branch": { "type": "string" }, "buildTime": { "type": "string" }, "buildVersion": { "type": "string" }, "commitId": { "type": "string" } } }, "common-system-WebhookEntityPayload": { "description": "Default webhook payload containing the affected entity ID", "properties": { "id": { "type": "integer", "format": "int64", "description": "ID of the affected entity" } } }, "common-output-OutputWebhookPayload": { "description": "Webhook payload for output queue events", "properties": { "queueId": { "type": "integer", "format": "int64", "description": "ID of the output queue" }, "title": { "type": "string", "description": "Subject of the output queue" }, "fsResourceId": { "type": "string", "description": "File storage resource ID" } } }, "erp-product-ArticleAppMessagePayload": { "description": "Webhook payload for article-related events", "properties": { "articleId": { "type": "integer", "format": "int64", "description": "ID of the affected article" }, "priceId": { "type": "integer", "format": "int64", "description": "ID of the affected price" }, "listingId": { "type": "integer", "format": "int64", "description": "ID of the affected listing" }, "categoryId": { "type": "integer", "format": "int64" } } }, "erp-pos-PosPaymentOrderEvent": { "properties": { "paymentOrderId": { "type": "integer", "format": "int64" }, "externalPaymentId": { "type": "string" }, "amount": { "type": "number" }, "currencyCode": { "type": "string" }, "paymentMethodId": { "type": "integer", "format": "int64" }, "paymentMethodLabel": { "type": "string" }, "paymentConsumerId": { "type": "integer", "format": "int64" }, "paymentOperation": { "type": "string" } } }, "dms-shelf-ShelfDocumentWebhookPayload": { "description": "Webhook payload for DMS shelf document events", "properties": { "shelfDocumentId": { "type": "integer", "format": "int64", "description": "ID of the affected shelf document" }, "externalRef": { "type": "string", "description": "External reference of the share" } } }, "vds-shipment-ShipmentAppMessagePayload": { "description": "Webhook payload for shipment-related events", "properties": { "shipmentId": { "type": "integer", "format": "int64", "description": "ID of shipment" }, "parcelId": { "type": "integer", "format": "int64", "description": "ID of parcel" } } } } }, "webhooks": { "account(sales-channel-id=%s).create": { "post": { "tags": [ "webhook:account(sales-channel-id=%s)" ], "summary": "account(sales-channel-id=%s).create", "operationId": "webhook_account(sales_channel_id=%s)_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "account(sales-channel-id=%s).update": { "post": { "tags": [ "webhook:account(sales-channel-id=%s)" ], "summary": "account(sales-channel-id=%s).update", "operationId": "webhook_account(sales_channel_id=%s)_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "account.create": { "post": { "tags": [ "webhook:account" ], "summary": "Triggered when a new account is created", "operationId": "webhook_account_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "account.update": { "post": { "tags": [ "webhook:account" ], "summary": "Triggered when an existing account is updated", "operationId": "webhook_account_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "article(sales-channel-id=%s)-shelf.update": { "post": { "tags": [ "webhook:article(sales-channel-id=%s)-shelf" ], "summary": "Triggered when an article shelf file is updated for a sales channel", "operationId": "webhook_article(sales_channel_id=%s)_shelf_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "article(sales-channel-id=%s).create": { "post": { "tags": [ "webhook:article(sales-channel-id=%s)" ], "summary": "Triggered when an article is created for a sales channel", "operationId": "webhook_article(sales_channel_id=%s)_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "article(sales-channel-id=%s).update": { "post": { "tags": [ "webhook:article(sales-channel-id=%s)" ], "summary": "Triggered when an article is updated for a sales channel", "operationId": "webhook_article(sales_channel_id=%s)_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "article-price.create": { "post": { "tags": [ "webhook:article-price" ], "summary": "Triggered when a new article price is created", "operationId": "webhook_article_price_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "article-price.delete": { "post": { "tags": [ "webhook:article-price" ], "summary": "Triggered when an article price was deleted", "operationId": "webhook_article_price_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "article-price.update": { "post": { "tags": [ "webhook:article-price" ], "summary": "Triggered when an article price is updated", "operationId": "webhook_article_price_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "article.create": { "post": { "tags": [ "webhook:article" ], "summary": "Triggered when a new article has been created for the default sales-channel", "operationId": "webhook_article_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "article.update": { "post": { "tags": [ "webhook:article" ], "summary": "Triggered when an article has been updated for the default sales-channel", "operationId": "webhook_article_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "asset.create": { "post": { "tags": [ "webhook:asset" ], "summary": "Triggered when a new Asset is created", "operationId": "webhook_asset_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "asset.update": { "post": { "tags": [ "webhook:asset" ], "summary": "Triggered when an existing asset is updated", "operationId": "webhook_asset_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "category-tree.create": { "post": { "tags": [ "webhook:category-tree" ], "summary": "category-tree.create", "operationId": "webhook_category_tree_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "category-tree.delete": { "post": { "tags": [ "webhook:category-tree" ], "summary": "category-tree.delete", "operationId": "webhook_category_tree_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "category-tree.update": { "post": { "tags": [ "webhook:category-tree" ], "summary": "category-tree.update", "operationId": "webhook_category_tree_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "category.create": { "post": { "tags": [ "webhook:category" ], "summary": "category.create", "operationId": "webhook_category_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "category.delete": { "post": { "tags": [ "webhook:category" ], "summary": "category.delete", "operationId": "webhook_category_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "category.update": { "post": { "tags": [ "webhook:category" ], "summary": "category.update", "operationId": "webhook_category_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "crmActivity.create": { "post": { "tags": [ "webhook:crmActivity" ], "summary": "Triggered when a new CRM activity is created", "operationId": "webhook_crmActivity_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "crmActivity.update": { "post": { "tags": [ "webhook:crmActivity" ], "summary": "Triggered when a CRM activity is updated", "operationId": "webhook_crmActivity_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "crmDeal.close": { "post": { "tags": [ "webhook:crmDeal" ], "summary": "Triggered when a CRM deal is closed", "operationId": "webhook_crmDeal_close", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "crmDeal.create": { "post": { "tags": [ "webhook:crmDeal" ], "summary": "Triggered when a new CRM deal is created", "operationId": "webhook_crmDeal_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "crmDeal.update": { "post": { "tags": [ "webhook:crmDeal" ], "summary": "Triggered when a CRM deal is updated", "operationId": "webhook_crmDeal_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "crmProject.create": { "post": { "tags": [ "webhook:crmProject" ], "summary": "Triggered when a new CRM project is created", "operationId": "webhook_crmProject_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "crmProject.update": { "post": { "tags": [ "webhook:crmProject" ], "summary": "Triggered when a CRM project is updated", "operationId": "webhook_crmProject_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "crmTask.create": { "post": { "tags": [ "webhook:crmTask" ], "summary": "Triggered when a new CRM task is created", "operationId": "webhook_crmTask_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "crmTask.update": { "post": { "tags": [ "webhook:crmTask" ], "summary": "Triggered when a CRM task is updated", "operationId": "webhook_crmTask_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement after_workflow_on_create", "operationId": "webhook_document_commission_settlement_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement begin_editing", "operationId": "webhook_document_commission_settlement_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement block_predecessor", "operationId": "webhook_document_commission_settlement_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement cancel_accepted", "operationId": "webhook_document_commission_settlement_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement cancel_editing", "operationId": "webhook_document_commission_settlement_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement cancel_editing_accepted", "operationId": "webhook_document_commission_settlement_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement cancel_saved", "operationId": "webhook_document_commission_settlement_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement copy", "operationId": "webhook_document_commission_settlement_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement create", "operationId": "webhook_document_commission_settlement_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement delete", "operationId": "webhook_document_commission_settlement_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement edit_accepted", "operationId": "webhook_document_commission_settlement_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement edit_accepted_without_follow_up", "operationId": "webhook_document_commission_settlement_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement editing_accepted", "operationId": "webhook_document_commission_settlement_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement end_editing", "operationId": "webhook_document_commission_settlement_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement publish", "operationId": "webhook_document_commission_settlement_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement save_accepted", "operationId": "webhook_document_commission_settlement_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement save_during_edit", "operationId": "webhook_document_commission_settlement_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_commission_settlement_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement ui_hint_create_shipment", "operationId": "webhook_document_commission_settlement_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.commission_settlement.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document commission_settlement unblock_predecessor", "operationId": "webhook_document_commission_settlement_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock accept", "operationId": "webhook_document_customer_credit_note_with_stock_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock after_workflow_on_create", "operationId": "webhook_document_customer_credit_note_with_stock_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock begin_editing", "operationId": "webhook_document_customer_credit_note_with_stock_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock block_predecessor", "operationId": "webhook_document_customer_credit_note_with_stock_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock cancel_accepted", "operationId": "webhook_document_customer_credit_note_with_stock_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock cancel_editing", "operationId": "webhook_document_customer_credit_note_with_stock_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock cancel_editing_accepted", "operationId": "webhook_document_customer_credit_note_with_stock_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock cancel_saved", "operationId": "webhook_document_customer_credit_note_with_stock_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock copy", "operationId": "webhook_document_customer_credit_note_with_stock_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock create", "operationId": "webhook_document_customer_credit_note_with_stock_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock delete", "operationId": "webhook_document_customer_credit_note_with_stock_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.deliveryinvoice_to_creditnote_with_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock deliveryinvoice_to_creditnote_with_stock", "operationId": "webhook_document_customer_credit_note_with_stock_deliveryinvoice_to_creditnote_with_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock edit_accepted", "operationId": "webhook_document_customer_credit_note_with_stock_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock edit_accepted_without_follow_up", "operationId": "webhook_document_customer_credit_note_with_stock_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock editing_accepted", "operationId": "webhook_document_customer_credit_note_with_stock_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock end_editing", "operationId": "webhook_document_customer_credit_note_with_stock_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock freeze", "operationId": "webhook_document_customer_credit_note_with_stock_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.invoice_to_creditnote_with_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock invoice_to_creditnote_with_stock", "operationId": "webhook_document_customer_credit_note_with_stock_invoice_to_creditnote_with_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock publish", "operationId": "webhook_document_customer_credit_note_with_stock_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock save_accepted", "operationId": "webhook_document_customer_credit_note_with_stock_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock save_during_edit", "operationId": "webhook_document_customer_credit_note_with_stock_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_credit_note_with_stock_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock ui_hint_create_shipment", "operationId": "webhook_document_customer_credit_note_with_stock_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_with_stock.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_with_stock unblock_predecessor", "operationId": "webhook_document_customer_credit_note_with_stock_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock accept", "operationId": "webhook_document_customer_credit_note_without_stock_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock after_workflow_on_create", "operationId": "webhook_document_customer_credit_note_without_stock_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock begin_editing", "operationId": "webhook_document_customer_credit_note_without_stock_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock block_predecessor", "operationId": "webhook_document_customer_credit_note_without_stock_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock cancel_accepted", "operationId": "webhook_document_customer_credit_note_without_stock_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock cancel_editing", "operationId": "webhook_document_customer_credit_note_without_stock_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock cancel_editing_accepted", "operationId": "webhook_document_customer_credit_note_without_stock_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock cancel_saved", "operationId": "webhook_document_customer_credit_note_without_stock_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock copy", "operationId": "webhook_document_customer_credit_note_without_stock_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock create", "operationId": "webhook_document_customer_credit_note_without_stock_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock delete", "operationId": "webhook_document_customer_credit_note_without_stock_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.deliveryinvoice_to_creditnote_without_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock deliveryinvoice_to_creditnote_without_stock", "operationId": "webhook_document_customer_credit_note_without_stock_deliveryinvoice_to_creditnote_without_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock edit_accepted", "operationId": "webhook_document_customer_credit_note_without_stock_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock edit_accepted_without_follow_up", "operationId": "webhook_document_customer_credit_note_without_stock_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock editing_accepted", "operationId": "webhook_document_customer_credit_note_without_stock_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock end_editing", "operationId": "webhook_document_customer_credit_note_without_stock_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock freeze", "operationId": "webhook_document_customer_credit_note_without_stock_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.goods_return_to_creditnote_without_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock goods_return_to_creditnote_without_stock", "operationId": "webhook_document_customer_credit_note_without_stock_goods_return_to_creditnote_without_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.invoice_to_creditnote_without_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock invoice_to_creditnote_without_stock", "operationId": "webhook_document_customer_credit_note_without_stock_invoice_to_creditnote_without_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock publish", "operationId": "webhook_document_customer_credit_note_without_stock_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.return_announcement_to_creditnote_without_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock return_announcement_to_creditnote_without_stock", "operationId": "webhook_document_customer_credit_note_without_stock_return_announcement_to_creditnote_without_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock save_accepted", "operationId": "webhook_document_customer_credit_note_without_stock_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock save_during_edit", "operationId": "webhook_document_customer_credit_note_without_stock_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_credit_note_without_stock_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock ui_hint_create_shipment", "operationId": "webhook_document_customer_credit_note_without_stock_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_credit_note_without_stock.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_credit_note_without_stock unblock_predecessor", "operationId": "webhook_document_customer_credit_note_without_stock_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document accept", "operationId": "webhook_document_customer_delivery_document_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document after_workflow_on_create", "operationId": "webhook_document_customer_delivery_document_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document begin_editing", "operationId": "webhook_document_customer_delivery_document_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document block_predecessor", "operationId": "webhook_document_customer_delivery_document_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document cancel_accepted", "operationId": "webhook_document_customer_delivery_document_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document cancel_editing", "operationId": "webhook_document_customer_delivery_document_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document cancel_editing_accepted", "operationId": "webhook_document_customer_delivery_document_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document cancel_saved", "operationId": "webhook_document_customer_delivery_document_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document copy", "operationId": "webhook_document_customer_delivery_document_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document create", "operationId": "webhook_document_customer_delivery_document_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document delete", "operationId": "webhook_document_customer_delivery_document_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document edit_accepted", "operationId": "webhook_document_customer_delivery_document_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document edit_accepted_without_follow_up", "operationId": "webhook_document_customer_delivery_document_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document editing_accepted", "operationId": "webhook_document_customer_delivery_document_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document end_editing", "operationId": "webhook_document_customer_delivery_document_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document freeze", "operationId": "webhook_document_customer_delivery_document_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.order_to_delivery": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document order_to_delivery", "operationId": "webhook_document_customer_delivery_document_order_to_delivery", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document publish", "operationId": "webhook_document_customer_delivery_document_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document save_accepted", "operationId": "webhook_document_customer_delivery_document_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document save_during_edit", "operationId": "webhook_document_customer_delivery_document_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_delivery_document_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document ui_hint_create_shipment", "operationId": "webhook_document_customer_delivery_document_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_document.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_document unblock_predecessor", "operationId": "webhook_document_customer_delivery_document_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice accept", "operationId": "webhook_document_customer_delivery_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice after_workflow_on_create", "operationId": "webhook_document_customer_delivery_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice begin_editing", "operationId": "webhook_document_customer_delivery_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice block_predecessor", "operationId": "webhook_document_customer_delivery_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice cancel_accepted", "operationId": "webhook_document_customer_delivery_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice cancel_editing", "operationId": "webhook_document_customer_delivery_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice cancel_editing_accepted", "operationId": "webhook_document_customer_delivery_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice cancel_saved", "operationId": "webhook_document_customer_delivery_invoice_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice copy", "operationId": "webhook_document_customer_delivery_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice create", "operationId": "webhook_document_customer_delivery_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice delete", "operationId": "webhook_document_customer_delivery_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice edit_accepted", "operationId": "webhook_document_customer_delivery_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_customer_delivery_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice editing_accepted", "operationId": "webhook_document_customer_delivery_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice end_editing", "operationId": "webhook_document_customer_delivery_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice freeze", "operationId": "webhook_document_customer_delivery_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.invoice_payment_plan_true": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice invoice_payment_plan_true", "operationId": "webhook_document_customer_delivery_invoice_invoice_payment_plan_true", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.order_to_deliveryinvoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice order_to_deliveryinvoice", "operationId": "webhook_document_customer_delivery_invoice_order_to_deliveryinvoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice publish", "operationId": "webhook_document_customer_delivery_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice save_accepted", "operationId": "webhook_document_customer_delivery_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice save_during_edit", "operationId": "webhook_document_customer_delivery_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_delivery_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice ui_hint_create_shipment", "operationId": "webhook_document_customer_delivery_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_delivery_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_delivery_invoice unblock_predecessor", "operationId": "webhook_document_customer_delivery_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice accept", "operationId": "webhook_document_customer_deposit_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice after_workflow_on_create", "operationId": "webhook_document_customer_deposit_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice begin_editing", "operationId": "webhook_document_customer_deposit_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice block_predecessor", "operationId": "webhook_document_customer_deposit_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice cancel_accepted", "operationId": "webhook_document_customer_deposit_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice cancel_editing", "operationId": "webhook_document_customer_deposit_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice cancel_editing_accepted", "operationId": "webhook_document_customer_deposit_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice cancel_saved", "operationId": "webhook_document_customer_deposit_invoice_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice copy", "operationId": "webhook_document_customer_deposit_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice create", "operationId": "webhook_document_customer_deposit_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice delete", "operationId": "webhook_document_customer_deposit_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice edit_accepted", "operationId": "webhook_document_customer_deposit_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_customer_deposit_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice editing_accepted", "operationId": "webhook_document_customer_deposit_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice end_editing", "operationId": "webhook_document_customer_deposit_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice freeze", "operationId": "webhook_document_customer_deposit_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.order_to_deposit_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice order_to_deposit_invoice", "operationId": "webhook_document_customer_deposit_invoice_order_to_deposit_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice publish", "operationId": "webhook_document_customer_deposit_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice save_accepted", "operationId": "webhook_document_customer_deposit_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice save_during_edit", "operationId": "webhook_document_customer_deposit_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_deposit_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice ui_hint_create_shipment", "operationId": "webhook_document_customer_deposit_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_deposit_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_deposit_invoice unblock_predecessor", "operationId": "webhook_document_customer_deposit_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice accept", "operationId": "webhook_document_customer_final_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice after_workflow_on_create", "operationId": "webhook_document_customer_final_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice begin_editing", "operationId": "webhook_document_customer_final_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice block_predecessor", "operationId": "webhook_document_customer_final_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice cancel_accepted", "operationId": "webhook_document_customer_final_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice cancel_editing", "operationId": "webhook_document_customer_final_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice cancel_editing_accepted", "operationId": "webhook_document_customer_final_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice cancel_saved", "operationId": "webhook_document_customer_final_invoice_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice copy", "operationId": "webhook_document_customer_final_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice create", "operationId": "webhook_document_customer_final_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice delete", "operationId": "webhook_document_customer_final_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice edit_accepted", "operationId": "webhook_document_customer_final_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_customer_final_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice editing_accepted", "operationId": "webhook_document_customer_final_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice end_editing", "operationId": "webhook_document_customer_final_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice freeze", "operationId": "webhook_document_customer_final_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.order_to_final_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice order_to_final_invoice", "operationId": "webhook_document_customer_final_invoice_order_to_final_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice publish", "operationId": "webhook_document_customer_final_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice save_accepted", "operationId": "webhook_document_customer_final_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice save_during_edit", "operationId": "webhook_document_customer_final_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_final_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice ui_hint_create_shipment", "operationId": "webhook_document_customer_final_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_final_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_final_invoice unblock_predecessor", "operationId": "webhook_document_customer_final_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return accept", "operationId": "webhook_document_customer_goods_return_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return after_workflow_on_create", "operationId": "webhook_document_customer_goods_return_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return begin_editing", "operationId": "webhook_document_customer_goods_return_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return block_predecessor", "operationId": "webhook_document_customer_goods_return_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return cancel_accepted", "operationId": "webhook_document_customer_goods_return_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return cancel_editing", "operationId": "webhook_document_customer_goods_return_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return cancel_editing_accepted", "operationId": "webhook_document_customer_goods_return_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return cancel_saved", "operationId": "webhook_document_customer_goods_return_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return copy", "operationId": "webhook_document_customer_goods_return_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return create", "operationId": "webhook_document_customer_goods_return_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return delete", "operationId": "webhook_document_customer_goods_return_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.delivery_to_goods_return": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return delivery_to_goods_return", "operationId": "webhook_document_customer_goods_return_delivery_to_goods_return", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.deliveryinvoice_to_goods_return": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return deliveryinvoice_to_goods_return", "operationId": "webhook_document_customer_goods_return_deliveryinvoice_to_goods_return", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return edit_accepted", "operationId": "webhook_document_customer_goods_return_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return edit_accepted_without_follow_up", "operationId": "webhook_document_customer_goods_return_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return editing_accepted", "operationId": "webhook_document_customer_goods_return_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return end_editing", "operationId": "webhook_document_customer_goods_return_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.final_invoice_to_goods_return": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return final_invoice_to_goods_return", "operationId": "webhook_document_customer_goods_return_final_invoice_to_goods_return", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.invoice_to_goods_return": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return invoice_to_goods_return", "operationId": "webhook_document_customer_goods_return_invoice_to_goods_return", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.partial_invoice_to_goods_return": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return partial_invoice_to_goods_return", "operationId": "webhook_document_customer_goods_return_partial_invoice_to_goods_return", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return publish", "operationId": "webhook_document_customer_goods_return_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.return_announcement_to_goods_return": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return return_announcement_to_goods_return", "operationId": "webhook_document_customer_goods_return_return_announcement_to_goods_return", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return save_accepted", "operationId": "webhook_document_customer_goods_return_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return save_during_edit", "operationId": "webhook_document_customer_goods_return_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_goods_return_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return ui_hint_create_shipment", "operationId": "webhook_document_customer_goods_return_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_goods_return.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_goods_return unblock_predecessor", "operationId": "webhook_document_customer_goods_return_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice accept", "operationId": "webhook_document_customer_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice after_workflow_on_create", "operationId": "webhook_document_customer_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice begin_editing", "operationId": "webhook_document_customer_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice block_predecessor", "operationId": "webhook_document_customer_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice cancel_accepted", "operationId": "webhook_document_customer_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice cancel_editing", "operationId": "webhook_document_customer_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice cancel_editing_accepted", "operationId": "webhook_document_customer_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice cancel_saved", "operationId": "webhook_document_customer_invoice_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice copy", "operationId": "webhook_document_customer_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice create", "operationId": "webhook_document_customer_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.customer_subscription_contract_to_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice customer_subscription_contract_to_invoice", "operationId": "webhook_document_customer_invoice_customer_subscription_contract_to_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice delete", "operationId": "webhook_document_customer_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.delivery_to_collective_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice delivery_to_collective_invoice", "operationId": "webhook_document_customer_invoice_delivery_to_collective_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.delivery_to_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice delivery_to_invoice", "operationId": "webhook_document_customer_invoice_delivery_to_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice edit_accepted", "operationId": "webhook_document_customer_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_customer_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice editing_accepted", "operationId": "webhook_document_customer_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice end_editing", "operationId": "webhook_document_customer_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice freeze", "operationId": "webhook_document_customer_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.invoice_payment_plan_true": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice invoice_payment_plan_true", "operationId": "webhook_document_customer_invoice_invoice_payment_plan_true", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice publish", "operationId": "webhook_document_customer_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice save_accepted", "operationId": "webhook_document_customer_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice save_during_edit", "operationId": "webhook_document_customer_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice ui_hint_create_shipment", "operationId": "webhook_document_customer_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_invoice unblock_predecessor", "operationId": "webhook_document_customer_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer accept", "operationId": "webhook_document_customer_offer_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer after_workflow_on_create", "operationId": "webhook_document_customer_offer_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer begin_editing", "operationId": "webhook_document_customer_offer_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer block_predecessor", "operationId": "webhook_document_customer_offer_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer cancel_accepted", "operationId": "webhook_document_customer_offer_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer cancel_editing", "operationId": "webhook_document_customer_offer_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer cancel_editing_accepted", "operationId": "webhook_document_customer_offer_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer copy", "operationId": "webhook_document_customer_offer_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer create", "operationId": "webhook_document_customer_offer_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.create_new_version": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer create_new_version", "operationId": "webhook_document_customer_offer_create_new_version", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer delete", "operationId": "webhook_document_customer_offer_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.dissolve": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer dissolve", "operationId": "webhook_document_customer_offer_dissolve", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer edit_accepted", "operationId": "webhook_document_customer_offer_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer edit_accepted_without_follow_up", "operationId": "webhook_document_customer_offer_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer editing_accepted", "operationId": "webhook_document_customer_offer_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer end_editing", "operationId": "webhook_document_customer_offer_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer freeze", "operationId": "webhook_document_customer_offer_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.offer_to_offer": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer offer_to_offer", "operationId": "webhook_document_customer_offer_offer_to_offer", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer publish", "operationId": "webhook_document_customer_offer_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer save_accepted", "operationId": "webhook_document_customer_offer_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer save_during_edit", "operationId": "webhook_document_customer_offer_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_offer_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer ui_hint_create_shipment", "operationId": "webhook_document_customer_offer_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_offer.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_offer unblock_predecessor", "operationId": "webhook_document_customer_offer_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order accept", "operationId": "webhook_document_customer_order_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order after_workflow_on_create", "operationId": "webhook_document_customer_order_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order begin_editing", "operationId": "webhook_document_customer_order_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order block_predecessor", "operationId": "webhook_document_customer_order_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order cancel_accepted", "operationId": "webhook_document_customer_order_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order cancel_editing", "operationId": "webhook_document_customer_order_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order cancel_editing_accepted", "operationId": "webhook_document_customer_order_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order copy", "operationId": "webhook_document_customer_order_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order create", "operationId": "webhook_document_customer_order_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.create_new_version": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order create_new_version", "operationId": "webhook_document_customer_order_create_new_version", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.customer_subscription_contract_to_order": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order customer_subscription_contract_to_order", "operationId": "webhook_document_customer_order_customer_subscription_contract_to_order", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order delete", "operationId": "webhook_document_customer_order_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.dissolve": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order dissolve", "operationId": "webhook_document_customer_order_dissolve", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order edit_accepted", "operationId": "webhook_document_customer_order_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order edit_accepted_without_follow_up", "operationId": "webhook_document_customer_order_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order editing_accepted", "operationId": "webhook_document_customer_order_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order end_editing", "operationId": "webhook_document_customer_order_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order freeze", "operationId": "webhook_document_customer_order_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.goods_return_to_customer_order": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order goods_return_to_customer_order", "operationId": "webhook_document_customer_order_goods_return_to_customer_order", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.goods_return_to_shipping_order": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order goods_return_to_shipping_order", "operationId": "webhook_document_customer_order_goods_return_to_shipping_order", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.offer_to_order": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order offer_to_order", "operationId": "webhook_document_customer_order_offer_to_order", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.order_after_picking_delivered": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order order_after_picking_delivered", "operationId": "webhook_document_customer_order_order_after_picking_delivered", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.order_close_remaining": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order order_close_remaining", "operationId": "webhook_document_customer_order_order_close_remaining", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.order_delivery_approved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order order_delivery_approved", "operationId": "webhook_document_customer_order_order_delivery_approved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.order_delivery_unapproved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order order_delivery_unapproved", "operationId": "webhook_document_customer_order_order_delivery_unapproved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.order_in_picking": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order order_in_picking", "operationId": "webhook_document_customer_order_order_in_picking", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.order_in_picking_with_dialog": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order order_in_picking_with_dialog", "operationId": "webhook_document_customer_order_order_in_picking_with_dialog", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.order_picking_finished": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order order_picking_finished", "operationId": "webhook_document_customer_order_order_picking_finished", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.order_reopen": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order order_reopen", "operationId": "webhook_document_customer_order_order_reopen", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.order_reset_from_picking": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order order_reset_from_picking", "operationId": "webhook_document_customer_order_order_reset_from_picking", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order publish", "operationId": "webhook_document_customer_order_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.return_announcement_to_customer_order": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order return_announcement_to_customer_order", "operationId": "webhook_document_customer_order_return_announcement_to_customer_order", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.return_announcement_to_shipping_order": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order return_announcement_to_shipping_order", "operationId": "webhook_document_customer_order_return_announcement_to_shipping_order", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order save_accepted", "operationId": "webhook_document_customer_order_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order save_during_edit", "operationId": "webhook_document_customer_order_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_order_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order ui_hint_create_shipment", "operationId": "webhook_document_customer_order_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_order.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_order unblock_predecessor", "operationId": "webhook_document_customer_order_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice accept", "operationId": "webhook_document_customer_partial_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice after_workflow_on_create", "operationId": "webhook_document_customer_partial_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice begin_editing", "operationId": "webhook_document_customer_partial_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice block_predecessor", "operationId": "webhook_document_customer_partial_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice cancel_accepted", "operationId": "webhook_document_customer_partial_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice cancel_editing", "operationId": "webhook_document_customer_partial_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice cancel_editing_accepted", "operationId": "webhook_document_customer_partial_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice cancel_saved", "operationId": "webhook_document_customer_partial_invoice_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice copy", "operationId": "webhook_document_customer_partial_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice create", "operationId": "webhook_document_customer_partial_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice delete", "operationId": "webhook_document_customer_partial_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.delivery_to_partial_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice delivery_to_partial_invoice", "operationId": "webhook_document_customer_partial_invoice_delivery_to_partial_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice edit_accepted", "operationId": "webhook_document_customer_partial_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_customer_partial_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice editing_accepted", "operationId": "webhook_document_customer_partial_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice end_editing", "operationId": "webhook_document_customer_partial_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice freeze", "operationId": "webhook_document_customer_partial_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice publish", "operationId": "webhook_document_customer_partial_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice save_accepted", "operationId": "webhook_document_customer_partial_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice save_during_edit", "operationId": "webhook_document_customer_partial_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_partial_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice ui_hint_create_shipment", "operationId": "webhook_document_customer_partial_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_partial_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_partial_invoice unblock_predecessor", "operationId": "webhook_document_customer_partial_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice accept", "operationId": "webhook_document_customer_proforma_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice after_workflow_on_create", "operationId": "webhook_document_customer_proforma_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice begin_editing", "operationId": "webhook_document_customer_proforma_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice block_predecessor", "operationId": "webhook_document_customer_proforma_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice cancel_accepted", "operationId": "webhook_document_customer_proforma_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice cancel_editing", "operationId": "webhook_document_customer_proforma_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice cancel_editing_accepted", "operationId": "webhook_document_customer_proforma_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice copy", "operationId": "webhook_document_customer_proforma_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice create", "operationId": "webhook_document_customer_proforma_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.customer_delivery_to_proforma_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice customer_delivery_to_proforma_invoice", "operationId": "webhook_document_customer_proforma_invoice_customer_delivery_to_proforma_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.customer_order_to_proforma_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice customer_order_to_proforma_invoice", "operationId": "webhook_document_customer_proforma_invoice_customer_order_to_proforma_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice delete", "operationId": "webhook_document_customer_proforma_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.dissolve": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice dissolve", "operationId": "webhook_document_customer_proforma_invoice_dissolve", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice edit_accepted", "operationId": "webhook_document_customer_proforma_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_customer_proforma_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice editing_accepted", "operationId": "webhook_document_customer_proforma_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice end_editing", "operationId": "webhook_document_customer_proforma_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice freeze", "operationId": "webhook_document_customer_proforma_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice publish", "operationId": "webhook_document_customer_proforma_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice save_accepted", "operationId": "webhook_document_customer_proforma_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice save_during_edit", "operationId": "webhook_document_customer_proforma_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_proforma_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice ui_hint_create_shipment", "operationId": "webhook_document_customer_proforma_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_proforma_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_proforma_invoice unblock_predecessor", "operationId": "webhook_document_customer_proforma_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice accept", "operationId": "webhook_document_customer_progress_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice after_workflow_on_create", "operationId": "webhook_document_customer_progress_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice begin_editing", "operationId": "webhook_document_customer_progress_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice block_predecessor", "operationId": "webhook_document_customer_progress_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice cancel_accepted", "operationId": "webhook_document_customer_progress_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice cancel_editing", "operationId": "webhook_document_customer_progress_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice cancel_editing_accepted", "operationId": "webhook_document_customer_progress_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice cancel_saved", "operationId": "webhook_document_customer_progress_invoice_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice copy", "operationId": "webhook_document_customer_progress_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice create", "operationId": "webhook_document_customer_progress_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice delete", "operationId": "webhook_document_customer_progress_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice edit_accepted", "operationId": "webhook_document_customer_progress_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_customer_progress_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice editing_accepted", "operationId": "webhook_document_customer_progress_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice end_editing", "operationId": "webhook_document_customer_progress_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice freeze", "operationId": "webhook_document_customer_progress_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.order_to_progress_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice order_to_progress_invoice", "operationId": "webhook_document_customer_progress_invoice_order_to_progress_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice publish", "operationId": "webhook_document_customer_progress_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice save_accepted", "operationId": "webhook_document_customer_progress_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice save_during_edit", "operationId": "webhook_document_customer_progress_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_progress_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice ui_hint_create_shipment", "operationId": "webhook_document_customer_progress_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_progress_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_progress_invoice unblock_predecessor", "operationId": "webhook_document_customer_progress_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement accept", "operationId": "webhook_document_customer_return_announcement_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement after_workflow_on_create", "operationId": "webhook_document_customer_return_announcement_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement begin_editing", "operationId": "webhook_document_customer_return_announcement_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement block_predecessor", "operationId": "webhook_document_customer_return_announcement_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement cancel_accepted", "operationId": "webhook_document_customer_return_announcement_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement cancel_editing", "operationId": "webhook_document_customer_return_announcement_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement cancel_editing_accepted", "operationId": "webhook_document_customer_return_announcement_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement cancel_saved", "operationId": "webhook_document_customer_return_announcement_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement copy", "operationId": "webhook_document_customer_return_announcement_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement create", "operationId": "webhook_document_customer_return_announcement_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement delete", "operationId": "webhook_document_customer_return_announcement_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.delivery_to_return_announcement": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement delivery_to_return_announcement", "operationId": "webhook_document_customer_return_announcement_delivery_to_return_announcement", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.deliveryinvoice_to_return_announcement": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement deliveryinvoice_to_return_announcement", "operationId": "webhook_document_customer_return_announcement_deliveryinvoice_to_return_announcement", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement edit_accepted", "operationId": "webhook_document_customer_return_announcement_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement edit_accepted_without_follow_up", "operationId": "webhook_document_customer_return_announcement_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement editing_accepted", "operationId": "webhook_document_customer_return_announcement_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement end_editing", "operationId": "webhook_document_customer_return_announcement_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.final_invoice_to_return_announcement": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement final_invoice_to_return_announcement", "operationId": "webhook_document_customer_return_announcement_final_invoice_to_return_announcement", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.invoice_to_return_announcement": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement invoice_to_return_announcement", "operationId": "webhook_document_customer_return_announcement_invoice_to_return_announcement", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.partial_invoice_to_return_announcement": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement partial_invoice_to_return_announcement", "operationId": "webhook_document_customer_return_announcement_partial_invoice_to_return_announcement", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement publish", "operationId": "webhook_document_customer_return_announcement_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement save_accepted", "operationId": "webhook_document_customer_return_announcement_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement save_during_edit", "operationId": "webhook_document_customer_return_announcement_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_customer_return_announcement_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement ui_hint_create_shipment", "operationId": "webhook_document_customer_return_announcement_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.customer_return_announcement.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document customer_return_announcement unblock_predecessor", "operationId": "webhook_document_customer_return_announcement_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_closing.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_closing after_workflow_on_create", "operationId": "webhook_document_pos_cash_journal_closing_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_closing.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_closing begin_editing", "operationId": "webhook_document_pos_cash_journal_closing_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_closing.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_closing cancel_editing", "operationId": "webhook_document_pos_cash_journal_closing_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_closing.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_closing create", "operationId": "webhook_document_pos_cash_journal_closing_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_closing.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_closing delete", "operationId": "webhook_document_pos_cash_journal_closing_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_closing.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_closing end_editing", "operationId": "webhook_document_pos_cash_journal_closing_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_closing.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_closing publish", "operationId": "webhook_document_pos_cash_journal_closing_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_closing.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_closing save_during_edit", "operationId": "webhook_document_pos_cash_journal_closing_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_deposit.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_deposit after_workflow_on_create", "operationId": "webhook_document_pos_cash_journal_deposit_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_deposit.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_deposit begin_editing", "operationId": "webhook_document_pos_cash_journal_deposit_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_deposit.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_deposit cancel_editing", "operationId": "webhook_document_pos_cash_journal_deposit_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_deposit.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_deposit create", "operationId": "webhook_document_pos_cash_journal_deposit_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_deposit.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_deposit delete", "operationId": "webhook_document_pos_cash_journal_deposit_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_deposit.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_deposit end_editing", "operationId": "webhook_document_pos_cash_journal_deposit_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_deposit.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_deposit publish", "operationId": "webhook_document_pos_cash_journal_deposit_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_deposit.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_deposit save_during_edit", "operationId": "webhook_document_pos_cash_journal_deposit_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_expense.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_expense after_workflow_on_create", "operationId": "webhook_document_pos_cash_journal_expense_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_expense.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_expense begin_editing", "operationId": "webhook_document_pos_cash_journal_expense_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_expense.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_expense cancel_editing", "operationId": "webhook_document_pos_cash_journal_expense_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_expense.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_expense create", "operationId": "webhook_document_pos_cash_journal_expense_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_expense.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_expense delete", "operationId": "webhook_document_pos_cash_journal_expense_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_expense.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_expense end_editing", "operationId": "webhook_document_pos_cash_journal_expense_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_expense.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_expense publish", "operationId": "webhook_document_pos_cash_journal_expense_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_expense.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_expense save_during_edit", "operationId": "webhook_document_pos_cash_journal_expense_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_opening.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_opening after_workflow_on_create", "operationId": "webhook_document_pos_cash_journal_opening_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_opening.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_opening begin_editing", "operationId": "webhook_document_pos_cash_journal_opening_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_opening.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_opening cancel_editing", "operationId": "webhook_document_pos_cash_journal_opening_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_opening.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_opening create", "operationId": "webhook_document_pos_cash_journal_opening_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_opening.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_opening delete", "operationId": "webhook_document_pos_cash_journal_opening_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_opening.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_opening end_editing", "operationId": "webhook_document_pos_cash_journal_opening_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_opening.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_opening publish", "operationId": "webhook_document_pos_cash_journal_opening_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_opening.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_opening save_during_edit", "operationId": "webhook_document_pos_cash_journal_opening_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_withdrawal.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_withdrawal after_workflow_on_create", "operationId": "webhook_document_pos_cash_journal_withdrawal_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_withdrawal.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_withdrawal begin_editing", "operationId": "webhook_document_pos_cash_journal_withdrawal_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_withdrawal.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_withdrawal cancel_editing", "operationId": "webhook_document_pos_cash_journal_withdrawal_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_withdrawal.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_withdrawal create", "operationId": "webhook_document_pos_cash_journal_withdrawal_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_withdrawal.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_withdrawal delete", "operationId": "webhook_document_pos_cash_journal_withdrawal_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_withdrawal.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_withdrawal end_editing", "operationId": "webhook_document_pos_cash_journal_withdrawal_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_withdrawal.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_withdrawal publish", "operationId": "webhook_document_pos_cash_journal_withdrawal_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_journal_withdrawal.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_journal_withdrawal save_during_edit", "operationId": "webhook_document_pos_cash_journal_withdrawal_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt accept", "operationId": "webhook_document_pos_cash_receipt_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt after_workflow_on_create", "operationId": "webhook_document_pos_cash_receipt_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt begin_editing", "operationId": "webhook_document_pos_cash_receipt_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt cancel_editing", "operationId": "webhook_document_pos_cash_receipt_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.cancel_pos_receipt": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt cancel_pos_receipt", "operationId": "webhook_document_pos_cash_receipt_cancel_pos_receipt", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt cancel_saved", "operationId": "webhook_document_pos_cash_receipt_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt create", "operationId": "webhook_document_pos_cash_receipt_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt delete", "operationId": "webhook_document_pos_cash_receipt_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt end_editing", "operationId": "webhook_document_pos_cash_receipt_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt publish", "operationId": "webhook_document_pos_cash_receipt_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_cash_receipt.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_cash_receipt save_during_edit", "operationId": "webhook_document_pos_cash_receipt_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt after_workflow_on_create", "operationId": "webhook_document_pos_return_cash_receipt_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt begin_editing", "operationId": "webhook_document_pos_return_cash_receipt_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt cancel_editing", "operationId": "webhook_document_pos_return_cash_receipt_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.cancel_pos_receipt": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt cancel_pos_receipt", "operationId": "webhook_document_pos_return_cash_receipt_cancel_pos_receipt", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt create", "operationId": "webhook_document_pos_return_cash_receipt_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt delete", "operationId": "webhook_document_pos_return_cash_receipt_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt end_editing", "operationId": "webhook_document_pos_return_cash_receipt_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.pos_receipt_to_return": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt pos_receipt_to_return", "operationId": "webhook_document_pos_return_cash_receipt_pos_receipt_to_return", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt publish", "operationId": "webhook_document_pos_return_cash_receipt_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.pos_return_cash_receipt.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document pos_return_cash_receipt save_during_edit", "operationId": "webhook_document_pos_return_cash_receipt_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note after_workflow_on_create", "operationId": "webhook_document_supplier_commission_credit_note_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note begin_editing", "operationId": "webhook_document_supplier_commission_credit_note_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note block_predecessor", "operationId": "webhook_document_supplier_commission_credit_note_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note cancel_accepted", "operationId": "webhook_document_supplier_commission_credit_note_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note cancel_editing", "operationId": "webhook_document_supplier_commission_credit_note_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note cancel_editing_accepted", "operationId": "webhook_document_supplier_commission_credit_note_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.cancel_saved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note cancel_saved", "operationId": "webhook_document_supplier_commission_credit_note_cancel_saved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note copy", "operationId": "webhook_document_supplier_commission_credit_note_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note create", "operationId": "webhook_document_supplier_commission_credit_note_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note delete", "operationId": "webhook_document_supplier_commission_credit_note_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note edit_accepted", "operationId": "webhook_document_supplier_commission_credit_note_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_commission_credit_note_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note editing_accepted", "operationId": "webhook_document_supplier_commission_credit_note_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note end_editing", "operationId": "webhook_document_supplier_commission_credit_note_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note publish", "operationId": "webhook_document_supplier_commission_credit_note_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note save_accepted", "operationId": "webhook_document_supplier_commission_credit_note_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note save_during_edit", "operationId": "webhook_document_supplier_commission_credit_note_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_commission_credit_note_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note ui_hint_create_shipment", "operationId": "webhook_document_supplier_commission_credit_note_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_commission_credit_note.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_commission_credit_note unblock_predecessor", "operationId": "webhook_document_supplier_commission_credit_note_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock accept", "operationId": "webhook_document_supplier_credit_note_with_stock_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock after_workflow_on_create", "operationId": "webhook_document_supplier_credit_note_with_stock_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock begin_editing", "operationId": "webhook_document_supplier_credit_note_with_stock_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock block_predecessor", "operationId": "webhook_document_supplier_credit_note_with_stock_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock cancel_accepted", "operationId": "webhook_document_supplier_credit_note_with_stock_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock cancel_editing", "operationId": "webhook_document_supplier_credit_note_with_stock_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock cancel_editing_accepted", "operationId": "webhook_document_supplier_credit_note_with_stock_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock copy", "operationId": "webhook_document_supplier_credit_note_with_stock_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock create", "operationId": "webhook_document_supplier_credit_note_with_stock_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock delete", "operationId": "webhook_document_supplier_credit_note_with_stock_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.deliveryinvoice_to_creditnote_with_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock deliveryinvoice_to_creditnote_with_stock", "operationId": "webhook_document_supplier_credit_note_with_stock_deliveryinvoice_to_creditnote_with_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock edit_accepted", "operationId": "webhook_document_supplier_credit_note_with_stock_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_credit_note_with_stock_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock editing_accepted", "operationId": "webhook_document_supplier_credit_note_with_stock_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock end_editing", "operationId": "webhook_document_supplier_credit_note_with_stock_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock freeze", "operationId": "webhook_document_supplier_credit_note_with_stock_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.invoice_to_creditnote_with_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock invoice_to_creditnote_with_stock", "operationId": "webhook_document_supplier_credit_note_with_stock_invoice_to_creditnote_with_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock publish", "operationId": "webhook_document_supplier_credit_note_with_stock_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock save_accepted", "operationId": "webhook_document_supplier_credit_note_with_stock_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock save_during_edit", "operationId": "webhook_document_supplier_credit_note_with_stock_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_credit_note_with_stock_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock ui_hint_create_shipment", "operationId": "webhook_document_supplier_credit_note_with_stock_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_with_stock.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_with_stock unblock_predecessor", "operationId": "webhook_document_supplier_credit_note_with_stock_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock accept", "operationId": "webhook_document_supplier_credit_note_without_stock_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock after_workflow_on_create", "operationId": "webhook_document_supplier_credit_note_without_stock_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock begin_editing", "operationId": "webhook_document_supplier_credit_note_without_stock_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock block_predecessor", "operationId": "webhook_document_supplier_credit_note_without_stock_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock cancel_accepted", "operationId": "webhook_document_supplier_credit_note_without_stock_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock cancel_editing", "operationId": "webhook_document_supplier_credit_note_without_stock_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock cancel_editing_accepted", "operationId": "webhook_document_supplier_credit_note_without_stock_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock copy", "operationId": "webhook_document_supplier_credit_note_without_stock_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock create", "operationId": "webhook_document_supplier_credit_note_without_stock_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock delete", "operationId": "webhook_document_supplier_credit_note_without_stock_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.deliveryinvoice_to_creditnote_without_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock deliveryinvoice_to_creditnote_without_stock", "operationId": "webhook_document_supplier_credit_note_without_stock_deliveryinvoice_to_creditnote_without_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock edit_accepted", "operationId": "webhook_document_supplier_credit_note_without_stock_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_credit_note_without_stock_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock editing_accepted", "operationId": "webhook_document_supplier_credit_note_without_stock_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock end_editing", "operationId": "webhook_document_supplier_credit_note_without_stock_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock freeze", "operationId": "webhook_document_supplier_credit_note_without_stock_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.invoice_to_creditnote_without_stock": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock invoice_to_creditnote_without_stock", "operationId": "webhook_document_supplier_credit_note_without_stock_invoice_to_creditnote_without_stock", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock publish", "operationId": "webhook_document_supplier_credit_note_without_stock_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock save_accepted", "operationId": "webhook_document_supplier_credit_note_without_stock_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock save_during_edit", "operationId": "webhook_document_supplier_credit_note_without_stock_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_credit_note_without_stock_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock ui_hint_create_shipment", "operationId": "webhook_document_supplier_credit_note_without_stock_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_credit_note_without_stock.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_credit_note_without_stock unblock_predecessor", "operationId": "webhook_document_supplier_credit_note_without_stock_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document accept", "operationId": "webhook_document_supplier_delivery_document_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document after_workflow_on_create", "operationId": "webhook_document_supplier_delivery_document_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document begin_editing", "operationId": "webhook_document_supplier_delivery_document_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document block_predecessor", "operationId": "webhook_document_supplier_delivery_document_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document cancel_accepted", "operationId": "webhook_document_supplier_delivery_document_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document cancel_editing", "operationId": "webhook_document_supplier_delivery_document_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document cancel_editing_accepted", "operationId": "webhook_document_supplier_delivery_document_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document copy", "operationId": "webhook_document_supplier_delivery_document_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document create", "operationId": "webhook_document_supplier_delivery_document_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document delete", "operationId": "webhook_document_supplier_delivery_document_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document edit_accepted", "operationId": "webhook_document_supplier_delivery_document_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_delivery_document_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document editing_accepted", "operationId": "webhook_document_supplier_delivery_document_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document end_editing", "operationId": "webhook_document_supplier_delivery_document_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document freeze", "operationId": "webhook_document_supplier_delivery_document_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.order_to_delivery": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document order_to_delivery", "operationId": "webhook_document_supplier_delivery_document_order_to_delivery", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document publish", "operationId": "webhook_document_supplier_delivery_document_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document save_accepted", "operationId": "webhook_document_supplier_delivery_document_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document save_during_edit", "operationId": "webhook_document_supplier_delivery_document_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_delivery_document_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document ui_hint_create_shipment", "operationId": "webhook_document_supplier_delivery_document_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_document.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_document unblock_predecessor", "operationId": "webhook_document_supplier_delivery_document_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice accept", "operationId": "webhook_document_supplier_delivery_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice after_workflow_on_create", "operationId": "webhook_document_supplier_delivery_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.assign_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice assign_predecessor", "operationId": "webhook_document_supplier_delivery_invoice_assign_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice begin_editing", "operationId": "webhook_document_supplier_delivery_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice block_predecessor", "operationId": "webhook_document_supplier_delivery_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice cancel_accepted", "operationId": "webhook_document_supplier_delivery_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice cancel_editing", "operationId": "webhook_document_supplier_delivery_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice cancel_editing_accepted", "operationId": "webhook_document_supplier_delivery_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice copy", "operationId": "webhook_document_supplier_delivery_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice create", "operationId": "webhook_document_supplier_delivery_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.create_draft": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice create_draft", "operationId": "webhook_document_supplier_delivery_invoice_create_draft", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice delete", "operationId": "webhook_document_supplier_delivery_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.delete_draft": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice delete_draft", "operationId": "webhook_document_supplier_delivery_invoice_delete_draft", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice edit_accepted", "operationId": "webhook_document_supplier_delivery_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_delivery_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice editing_accepted", "operationId": "webhook_document_supplier_delivery_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.editing_draft": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice editing_draft", "operationId": "webhook_document_supplier_delivery_invoice_editing_draft", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice end_editing", "operationId": "webhook_document_supplier_delivery_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice freeze", "operationId": "webhook_document_supplier_delivery_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.invoice_payment_plan_true": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice invoice_payment_plan_true", "operationId": "webhook_document_supplier_delivery_invoice_invoice_payment_plan_true", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.order_to_deliveryinvoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice order_to_deliveryinvoice", "operationId": "webhook_document_supplier_delivery_invoice_order_to_deliveryinvoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice publish", "operationId": "webhook_document_supplier_delivery_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice save_accepted", "operationId": "webhook_document_supplier_delivery_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.save_draft": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice save_draft", "operationId": "webhook_document_supplier_delivery_invoice_save_draft", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice save_during_edit", "operationId": "webhook_document_supplier_delivery_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_delivery_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice ui_hint_create_shipment", "operationId": "webhook_document_supplier_delivery_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_delivery_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_delivery_invoice unblock_predecessor", "operationId": "webhook_document_supplier_delivery_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice accept", "operationId": "webhook_document_supplier_deposit_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice after_workflow_on_create", "operationId": "webhook_document_supplier_deposit_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice begin_editing", "operationId": "webhook_document_supplier_deposit_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice block_predecessor", "operationId": "webhook_document_supplier_deposit_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice cancel_accepted", "operationId": "webhook_document_supplier_deposit_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice cancel_editing", "operationId": "webhook_document_supplier_deposit_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice cancel_editing_accepted", "operationId": "webhook_document_supplier_deposit_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice copy", "operationId": "webhook_document_supplier_deposit_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice create", "operationId": "webhook_document_supplier_deposit_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice delete", "operationId": "webhook_document_supplier_deposit_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice edit_accepted", "operationId": "webhook_document_supplier_deposit_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_deposit_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice editing_accepted", "operationId": "webhook_document_supplier_deposit_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice end_editing", "operationId": "webhook_document_supplier_deposit_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice freeze", "operationId": "webhook_document_supplier_deposit_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.order_to_deposit_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice order_to_deposit_invoice", "operationId": "webhook_document_supplier_deposit_invoice_order_to_deposit_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice publish", "operationId": "webhook_document_supplier_deposit_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice save_accepted", "operationId": "webhook_document_supplier_deposit_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice save_during_edit", "operationId": "webhook_document_supplier_deposit_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_deposit_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice ui_hint_create_shipment", "operationId": "webhook_document_supplier_deposit_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_deposit_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_deposit_invoice unblock_predecessor", "operationId": "webhook_document_supplier_deposit_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice accept", "operationId": "webhook_document_supplier_final_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice after_workflow_on_create", "operationId": "webhook_document_supplier_final_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice begin_editing", "operationId": "webhook_document_supplier_final_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice block_predecessor", "operationId": "webhook_document_supplier_final_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice cancel_accepted", "operationId": "webhook_document_supplier_final_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice cancel_editing", "operationId": "webhook_document_supplier_final_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice cancel_editing_accepted", "operationId": "webhook_document_supplier_final_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice copy", "operationId": "webhook_document_supplier_final_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice create", "operationId": "webhook_document_supplier_final_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice delete", "operationId": "webhook_document_supplier_final_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice edit_accepted", "operationId": "webhook_document_supplier_final_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_final_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice editing_accepted", "operationId": "webhook_document_supplier_final_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice end_editing", "operationId": "webhook_document_supplier_final_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice freeze", "operationId": "webhook_document_supplier_final_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.order_to_final_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice order_to_final_invoice", "operationId": "webhook_document_supplier_final_invoice_order_to_final_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice publish", "operationId": "webhook_document_supplier_final_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice save_accepted", "operationId": "webhook_document_supplier_final_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice save_during_edit", "operationId": "webhook_document_supplier_final_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_final_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice ui_hint_create_shipment", "operationId": "webhook_document_supplier_final_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_final_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_final_invoice unblock_predecessor", "operationId": "webhook_document_supplier_final_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice accept", "operationId": "webhook_document_supplier_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice after_workflow_on_create", "operationId": "webhook_document_supplier_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.assign_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice assign_predecessor", "operationId": "webhook_document_supplier_invoice_assign_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice begin_editing", "operationId": "webhook_document_supplier_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice block_predecessor", "operationId": "webhook_document_supplier_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice cancel_accepted", "operationId": "webhook_document_supplier_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice cancel_editing", "operationId": "webhook_document_supplier_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice cancel_editing_accepted", "operationId": "webhook_document_supplier_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice copy", "operationId": "webhook_document_supplier_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice create", "operationId": "webhook_document_supplier_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.create_draft": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice create_draft", "operationId": "webhook_document_supplier_invoice_create_draft", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice delete", "operationId": "webhook_document_supplier_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.delete_draft": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice delete_draft", "operationId": "webhook_document_supplier_invoice_delete_draft", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.delivery_to_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice delivery_to_invoice", "operationId": "webhook_document_supplier_invoice_delivery_to_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice edit_accepted", "operationId": "webhook_document_supplier_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice editing_accepted", "operationId": "webhook_document_supplier_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.editing_draft": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice editing_draft", "operationId": "webhook_document_supplier_invoice_editing_draft", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice end_editing", "operationId": "webhook_document_supplier_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice freeze", "operationId": "webhook_document_supplier_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.invoice_payment_plan_true": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice invoice_payment_plan_true", "operationId": "webhook_document_supplier_invoice_invoice_payment_plan_true", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice publish", "operationId": "webhook_document_supplier_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice save_accepted", "operationId": "webhook_document_supplier_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.save_draft": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice save_draft", "operationId": "webhook_document_supplier_invoice_save_draft", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice save_during_edit", "operationId": "webhook_document_supplier_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice ui_hint_create_shipment", "operationId": "webhook_document_supplier_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_invoice unblock_predecessor", "operationId": "webhook_document_supplier_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order accept", "operationId": "webhook_document_supplier_order_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order after_workflow_on_create", "operationId": "webhook_document_supplier_order_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order begin_editing", "operationId": "webhook_document_supplier_order_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order block_predecessor", "operationId": "webhook_document_supplier_order_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order cancel_accepted", "operationId": "webhook_document_supplier_order_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order cancel_editing", "operationId": "webhook_document_supplier_order_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order cancel_editing_accepted", "operationId": "webhook_document_supplier_order_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order copy", "operationId": "webhook_document_supplier_order_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order create", "operationId": "webhook_document_supplier_order_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.create_new_version": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order create_new_version", "operationId": "webhook_document_supplier_order_create_new_version", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.customer_order_to_supplier_order": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order customer_order_to_supplier_order", "operationId": "webhook_document_supplier_order_customer_order_to_supplier_order", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order delete", "operationId": "webhook_document_supplier_order_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.dissolve": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order dissolve", "operationId": "webhook_document_supplier_order_dissolve", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order edit_accepted", "operationId": "webhook_document_supplier_order_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_order_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order editing_accepted", "operationId": "webhook_document_supplier_order_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order end_editing", "operationId": "webhook_document_supplier_order_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.order_close_remaining": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order order_close_remaining", "operationId": "webhook_document_supplier_order_order_close_remaining", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.order_delivery_approved": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order order_delivery_approved", "operationId": "webhook_document_supplier_order_order_delivery_approved", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.order_reopen": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order order_reopen", "operationId": "webhook_document_supplier_order_order_reopen", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order publish", "operationId": "webhook_document_supplier_order_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.request_to_order": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order request_to_order", "operationId": "webhook_document_supplier_order_request_to_order", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order save_accepted", "operationId": "webhook_document_supplier_order_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order save_during_edit", "operationId": "webhook_document_supplier_order_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_order_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order ui_hint_create_shipment", "operationId": "webhook_document_supplier_order_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_order.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_order unblock_predecessor", "operationId": "webhook_document_supplier_order_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice accept", "operationId": "webhook_document_supplier_partial_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice after_workflow_on_create", "operationId": "webhook_document_supplier_partial_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice begin_editing", "operationId": "webhook_document_supplier_partial_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice block_predecessor", "operationId": "webhook_document_supplier_partial_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice cancel_accepted", "operationId": "webhook_document_supplier_partial_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice cancel_editing", "operationId": "webhook_document_supplier_partial_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice cancel_editing_accepted", "operationId": "webhook_document_supplier_partial_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice copy", "operationId": "webhook_document_supplier_partial_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice create", "operationId": "webhook_document_supplier_partial_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice delete", "operationId": "webhook_document_supplier_partial_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.delivery_to_partial_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice delivery_to_partial_invoice", "operationId": "webhook_document_supplier_partial_invoice_delivery_to_partial_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice edit_accepted", "operationId": "webhook_document_supplier_partial_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_partial_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice editing_accepted", "operationId": "webhook_document_supplier_partial_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice end_editing", "operationId": "webhook_document_supplier_partial_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice freeze", "operationId": "webhook_document_supplier_partial_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice publish", "operationId": "webhook_document_supplier_partial_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice save_accepted", "operationId": "webhook_document_supplier_partial_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice save_during_edit", "operationId": "webhook_document_supplier_partial_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_partial_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice ui_hint_create_shipment", "operationId": "webhook_document_supplier_partial_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_partial_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_partial_invoice unblock_predecessor", "operationId": "webhook_document_supplier_partial_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request accept", "operationId": "webhook_document_supplier_price_request_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request after_workflow_on_create", "operationId": "webhook_document_supplier_price_request_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request begin_editing", "operationId": "webhook_document_supplier_price_request_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request block_predecessor", "operationId": "webhook_document_supplier_price_request_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request cancel_accepted", "operationId": "webhook_document_supplier_price_request_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request cancel_editing", "operationId": "webhook_document_supplier_price_request_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request cancel_editing_accepted", "operationId": "webhook_document_supplier_price_request_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request copy", "operationId": "webhook_document_supplier_price_request_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request create", "operationId": "webhook_document_supplier_price_request_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.create_new_version": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request create_new_version", "operationId": "webhook_document_supplier_price_request_create_new_version", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request delete", "operationId": "webhook_document_supplier_price_request_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.dissolve": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request dissolve", "operationId": "webhook_document_supplier_price_request_dissolve", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request edit_accepted", "operationId": "webhook_document_supplier_price_request_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_price_request_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request editing_accepted", "operationId": "webhook_document_supplier_price_request_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request end_editing", "operationId": "webhook_document_supplier_price_request_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request publish", "operationId": "webhook_document_supplier_price_request_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request save_accepted", "operationId": "webhook_document_supplier_price_request_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request save_during_edit", "operationId": "webhook_document_supplier_price_request_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_price_request_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request ui_hint_create_shipment", "operationId": "webhook_document_supplier_price_request_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_price_request.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_price_request unblock_predecessor", "operationId": "webhook_document_supplier_price_request_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.accept": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice accept", "operationId": "webhook_document_supplier_progress_invoice_accept", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.after_workflow_on_create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice after_workflow_on_create", "operationId": "webhook_document_supplier_progress_invoice_after_workflow_on_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.begin_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice begin_editing", "operationId": "webhook_document_supplier_progress_invoice_begin_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.block_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice block_predecessor", "operationId": "webhook_document_supplier_progress_invoice_block_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.cancel_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice cancel_accepted", "operationId": "webhook_document_supplier_progress_invoice_cancel_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.cancel_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice cancel_editing", "operationId": "webhook_document_supplier_progress_invoice_cancel_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.cancel_editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice cancel_editing_accepted", "operationId": "webhook_document_supplier_progress_invoice_cancel_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.copy": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice copy", "operationId": "webhook_document_supplier_progress_invoice_copy", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.create": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice create", "operationId": "webhook_document_supplier_progress_invoice_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.delete": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice delete", "operationId": "webhook_document_supplier_progress_invoice_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.edit_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice edit_accepted", "operationId": "webhook_document_supplier_progress_invoice_edit_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.edit_accepted_without_follow_up": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice edit_accepted_without_follow_up", "operationId": "webhook_document_supplier_progress_invoice_edit_accepted_without_follow_up", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.editing_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice editing_accepted", "operationId": "webhook_document_supplier_progress_invoice_editing_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.end_editing": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice end_editing", "operationId": "webhook_document_supplier_progress_invoice_end_editing", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.freeze": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice freeze", "operationId": "webhook_document_supplier_progress_invoice_freeze", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.order_to_progress_invoice": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice order_to_progress_invoice", "operationId": "webhook_document_supplier_progress_invoice_order_to_progress_invoice", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.publish": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice publish", "operationId": "webhook_document_supplier_progress_invoice_publish", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.save_accepted": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice save_accepted", "operationId": "webhook_document_supplier_progress_invoice_save_accepted", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.save_during_edit": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice save_during_edit", "operationId": "webhook_document_supplier_progress_invoice_save_during_edit", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.ui_hint_create_and_print_shipment_label": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice ui_hint_create_and_print_shipment_label", "operationId": "webhook_document_supplier_progress_invoice_ui_hint_create_and_print_shipment_label", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.ui_hint_create_shipment": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice ui_hint_create_shipment", "operationId": "webhook_document_supplier_progress_invoice_ui_hint_create_shipment", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "document.supplier_progress_invoice.unblock_predecessor": { "post": { "tags": [ "webhook:document" ], "summary": "Triggered on document supplier_progress_invoice unblock_predecessor", "operationId": "webhook_document_supplier_progress_invoice_unblock_predecessor", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "listing.category-added": { "post": { "tags": [ "webhook:listing" ], "summary": "listing.category-added", "operationId": "webhook_listing_category_added", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "listing.category-removed": { "post": { "tags": [ "webhook:listing" ], "summary": "listing.category-removed", "operationId": "webhook_listing_category_removed", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "open_item(sales-channel-id=%s).update": { "post": { "tags": [ "webhook:open_item(sales-channel-id=%s)" ], "summary": "Triggered when an open item related to the sales channel is changed", "operationId": "webhook_open_item(sales_channel_id=%s)_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-product-ArticleAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "output.consumer.new-queue-entry": { "post": { "tags": [ "webhook:output" ], "summary": "Triggered when a new entry is added to an output consumer queue", "operationId": "webhook_output_consumer_new_queue_entry", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputWebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "output.consumer.refresh-requested": { "post": { "tags": [ "webhook:output" ], "summary": "Triggered when an output consumer refresh is requested", "operationId": "webhook_output_consumer_refresh_requested", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-output-OutputWebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "pos.payment.consumer.refresh-requested": { "post": { "tags": [ "webhook:pos" ], "summary": "Triggered when a POS payment consumer refresh is requested", "operationId": "webhook_pos_payment_consumer_refresh_requested", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "pos.payment.new-order": { "post": { "tags": [ "webhook:pos" ], "summary": "Triggered when a new POS payment order is created", "operationId": "webhook_pos_payment_new_order", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/erp-pos-PosPaymentOrderEvent" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "sales_channel.create": { "post": { "tags": [ "webhook:sales_channel" ], "summary": "Triggered when a new sales channel is created", "operationId": "webhook_sales_channel_create", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "sales_channel.delete": { "post": { "tags": [ "webhook:sales_channel" ], "summary": "Triggered when a sales channel is deleted", "operationId": "webhook_sales_channel_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "sales_channel.stockChange": { "post": { "tags": [ "webhook:sales_channel" ], "summary": "Triggered when stock changes for a sales channel", "operationId": "webhook_sales_channel_stockChange", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "sales_channel.update": { "post": { "tags": [ "webhook:sales_channel" ], "summary": "Triggered when a sales channel is updated", "operationId": "webhook_sales_channel_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "shelf-document.delete": { "post": { "tags": [ "webhook:shelf-document" ], "summary": "Triggered when a shelf document is deleted", "operationId": "webhook_shelf_document_delete", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentWebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "shelf-document.update": { "post": { "tags": [ "webhook:shelf-document" ], "summary": "Triggered when a shelf document is updated", "operationId": "webhook_shelf_document_update", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dms-shelf-ShelfDocumentWebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "shipment.parcel.completed": { "post": { "tags": [ "webhook:shipment" ], "summary": "Triggered when a shipment parcel is completed", "operationId": "webhook_shipment_parcel_completed", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vds-shipment-ShipmentAppMessagePayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "tenant.offline": { "post": { "tags": [ "webhook:tenant" ], "summary": "Triggered when a tenant goes offline", "operationId": "webhook_tenant_offline", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } }, "tenant.online": { "post": { "tags": [ "webhook:tenant" ], "summary": "Triggered when a tenant comes online", "operationId": "webhook_tenant_online", "requestBody": { "description": "Webhook payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common-system-WebhookEntityPayload" } } } }, "responses": { "200": { "description": "Webhook received" } } } } }, "x-hideTryItPanel": true }