{ "components": { "responses": { "Eingabe_ungueltig": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fehler" } } }, "description": "Die Eingabe wurde abgelehnt. Die Meldung nennt Feld und Code." }, "Keine_Berechtigung": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fehler" } } }, "description": "Die Rolle oder das Dokumentrecht fehlt." }, "Nicht_angemeldet": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fehler" } } }, "description": "Nicht angemeldet." }, "Zu_viele_Anfragen": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fehler" } } }, "description": "Die Rate-Begrenzung greift." } }, "schemas": { "Fehler": { "properties": { "_server_messages": { "description": "JSON-Text mit einer Liste von Meldungen", "type": "string" }, "exc_type": { "type": "string" }, "fehlernummer": { "description": "Vier Zeichen, nur bei unerwarteten Fehlern", "type": "string" } }, "type": "object" } }, "securitySchemes": { "sessionAuth": { "description": "Sitzungs-Cookie nach der Anmeldung. Schreibende Aufrufe senden zusätzlich den Header X-Frappe-CSRF-Token.", "in": "cookie", "name": "sid", "type": "apiKey" }, "tokenAuth": { "description": "Wert: token :", "in": "header", "name": "Authorization", "type": "apiKey" } } }, "info": { "contact": { "email": "info@virtual-marketer.de", "name": "SGS Virtual Marketer GmbH" }, "description": "Funktionsaufrufe unter /api/method/ und Standard-Ressourcen unter /api/resource/. Erzeugt aus dem Quelltext.", "title": "Virtual Marketer ERP API", "version": "1" }, "openapi": "3.1.0", "paths": { "/api/method/vm_erp.vm_erp.adressen.api.check_duplicates": { "get": { "description": "Same name + postcode or same e-mail. Returns title and number only.", "operationId": "vm_erp.vm_erp.adressen.api.check_duplicates", "parameters": [ { "description": "", "in": "query", "name": "data", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Same name + postcode or same e-mail", "tags": [ "Adressen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Same name + postcode or same e-mail. Returns title and number only.", "operationId": "vm_erp.vm_erp.adressen.api.check_duplicates", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "description": "", "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Same name + postcode or same e-mail", "tags": [ "Adressen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.adressen.api.create_adresse": { "post": { "description": "Create the party/parties. Refuses when a duplicate exists unless force=1 (user confirmed).", "operationId": "vm_erp.vm_erp.adressen.api.create_adresse", "requestBody": { "content": { "application/json": { "schema": { "properties": { "data": { "description": "", "type": "string" }, "force": { "description": "", "type": "integer" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Create the party/parties", "tags": [ "Adressen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.ampel.get_lights": { "get": { "description": "Lights for a list of Sales Order names (list view, form). Permission checked.", "operationId": "vm_erp.vm_erp.ampel.get_lights", "parameters": [ { "description": "", "in": "query", "name": "orders", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Lights for a list of Sales Order names (list view, form)", "tags": [ "Auftragsampel" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Lights for a list of Sales Order names (list view, form). Permission checked.", "operationId": "vm_erp.vm_erp.ampel.get_lights", "requestBody": { "content": { "application/json": { "schema": { "properties": { "orders": { "description": "", "type": "string" } }, "required": [ "orders" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Lights for a list of Sales Order names (list view, form)", "tags": [ "Auftragsampel" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.assistent.api.ask": { "get": { "description": "Free question about the open document. Returns a proposal, nothing is executed.", "operationId": "vm_erp.vm_erp.assistent.api.ask", "parameters": [ { "description": "", "in": "query", "name": "doctype", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "question", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Free question about the open document", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Free question about the open document. Returns a proposal, nothing is executed.", "operationId": "vm_erp.vm_erp.assistent.api.ask", "requestBody": { "content": { "application/json": { "schema": { "properties": { "doctype": { "description": "", "type": "string" }, "name": { "description": "", "type": "string" }, "question": { "description": "", "type": "string" } }, "required": [ "doctype", "name", "question" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Free question about the open document", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.assistent.api.confirm_comment": { "get": { "description": "The only action with write effect: a comment on the document, only after a human confirmed it (the sidebar sends confirmed=1 on the button click).", "operationId": "vm_erp.vm_erp.assistent.api.confirm_comment", "parameters": [ { "description": "", "in": "query", "name": "doctype", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "text", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "confirmed", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "The only action with write effect: a comment on the document, only after a human confirmed it (the sidebar sends confirmed=1 on the button c", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "The only action with write effect: a comment on the document, only after a human confirmed it (the sidebar sends confirmed=1 on the button click).", "operationId": "vm_erp.vm_erp.assistent.api.confirm_comment", "requestBody": { "content": { "application/json": { "schema": { "properties": { "confirmed": { "description": "", "type": "integer" }, "doctype": { "description": "", "type": "string" }, "name": { "description": "", "type": "string" }, "text": { "description": "", "type": "string" } }, "required": [ "doctype", "name", "text" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "The only action with write effect: a comment on the document, only after a human confirmed it (the sidebar sends confirmed=1 on the button c", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.assistent.api.customer_summary": { "get": { "description": "", "operationId": "vm_erp.vm_erp.assistent.api.customer_summary", "parameters": [ { "description": "", "in": "query", "name": "customer", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "customer_summary", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.assistent.api.customer_summary", "requestBody": { "content": { "application/json": { "schema": { "properties": { "customer": { "description": "", "type": "string" } }, "required": [ "customer" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "customer_summary", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.assistent.api.explain_order": { "get": { "description": "", "operationId": "vm_erp.vm_erp.assistent.api.explain_order", "parameters": [ { "description": "", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "explain_order", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.assistent.api.explain_order", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "explain_order", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.assistent.api.get_context": { "get": { "description": "", "operationId": "vm_erp.vm_erp.assistent.api.get_context", "parameters": [ { "description": "", "in": "query", "name": "doctype", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_context", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.assistent.api.get_context", "requestBody": { "content": { "application/json": { "schema": { "properties": { "doctype": { "description": "", "type": "string" }, "name": { "description": "", "type": "string" } }, "required": [ "doctype", "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_context", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.assistent.api.quality_check": { "get": { "description": "", "operationId": "vm_erp.vm_erp.assistent.api.quality_check", "parameters": [ { "description": "", "in": "query", "name": "doctype", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "quality_check", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.assistent.api.quality_check", "requestBody": { "content": { "application/json": { "schema": { "properties": { "doctype": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "quality_check", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.assistent.vorschlaege_api.abweisen": { "get": { "description": "", "operationId": "vm_erp.vm_erp.assistent.vorschlaege_api.abweisen", "parameters": [ { "description": "", "in": "query", "name": "vorschlag_id", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "grund", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "abweisen", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.assistent.vorschlaege_api.abweisen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "grund": { "description": "", "type": "string" }, "vorschlag_id": { "description": "", "type": "string" } }, "required": [ "vorschlag_id", "grund" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "abweisen", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.assistent.vorschlaege_api.heute": { "get": { "description": "", "operationId": "vm_erp.vm_erp.assistent.vorschlaege_api.heute", "parameters": [ { "description": "", "in": "query", "name": "abgewiesen", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "heute", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.assistent.vorschlaege_api.heute", "requestBody": { "content": { "application/json": { "schema": { "properties": { "abgewiesen": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "heute", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.assistent.vorschlaege_api.rueckmeldung": { "get": { "description": "", "operationId": "vm_erp.vm_erp.assistent.vorschlaege_api.rueckmeldung", "parameters": [ { "description": "", "in": "query", "name": "vorschlag_id", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "bewertung", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "rueckmeldung", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.assistent.vorschlaege_api.rueckmeldung", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bewertung": { "description": "", "type": "string" }, "vorschlag_id": { "description": "", "type": "string" } }, "required": [ "vorschlag_id", "bewertung" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "rueckmeldung", "tags": [ "Assistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.bankabgleich.api.annehmen": { "post": { "description": "Liefert nur einen Buchungsentwurf (nichts gebucht) und merkt sich das gelernte Muster.", "operationId": "vm_erp.vm_erp.bankabgleich.api.annehmen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "option_id": { "description": "", "type": "string" }, "posten": { "description": "", "type": "string" }, "zeile": { "description": "", "type": "string" } }, "required": [ "zeile", "posten" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Liefert nur einen Buchungsentwurf (nichts gebucht) und merkt sich das gelernte Muster.", "tags": [ "Bankabgleich" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.bankabgleich.api.arbeitsliste": { "get": { "description": "Offene Bankzeilen mit Kandidaten und Tagesziel. `datei`: Inhalt eines MT940/CAMT-Auszugs, sonst Bank Transaction.", "operationId": "vm_erp.vm_erp.bankabgleich.api.arbeitsliste", "parameters": [ { "description": "", "in": "query", "name": "datei", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "format_name", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "erledigt", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Offene Bankzeilen mit Kandidaten und Tagesziel", "tags": [ "Bankabgleich" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Offene Bankzeilen mit Kandidaten und Tagesziel. `datei`: Inhalt eines MT940/CAMT-Auszugs, sonst Bank Transaction.", "operationId": "vm_erp.vm_erp.bankabgleich.api.arbeitsliste", "requestBody": { "content": { "application/json": { "schema": { "properties": { "datei": { "description": "", "type": "string" }, "erledigt": { "description": "", "type": "string" }, "format_name": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Offene Bankzeilen mit Kandidaten und Tagesziel", "tags": [ "Bankabgleich" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.beispieldaten.api.entfernen": { "post": { "description": "Entfernt alles, was dieser Lauf angelegt hat und noch den Marker traegt. Verlangt das Tippen des Profilnamens.", "operationId": "vm_erp.vm_erp.beispieldaten.api.entfernen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bestaetigung": { "description": "", "type": "string" }, "lauf": { "description": "", "type": "string" } }, "required": [ "lauf", "bestaetigung" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Entfernt alles, was dieser Lauf angelegt hat und noch den Marker traegt", "tags": [ "Beispieldaten" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.beispieldaten.api.laden": { "post": { "description": "Legt das Profil an (nur was fehlt). Bei einem Fehler wird abgebrochen; was bis dahin entstand, steht im Laufdatensatz und laesst sich mit `entfernen` zurueckbauen.", "operationId": "vm_erp.vm_erp.beispieldaten.api.laden", "requestBody": { "content": { "application/json": { "schema": { "properties": { "profil": { "description": "", "type": "string" } }, "required": [ "profil" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt das Profil an (nur was fehlt)", "tags": [ "Beispieldaten" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.beispieldaten.api.laeufe": { "get": { "description": "", "operationId": "vm_erp.vm_erp.beispieldaten.api.laeufe", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "laeufe", "tags": [ "Beispieldaten" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.beispieldaten.api.laeufe", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "laeufe", "tags": [ "Beispieldaten" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.beispieldaten.api.profile": { "get": { "description": "Die Profile mit Titel, Beschreibung und der Menge, die ein Laden anlegen wuerde.", "operationId": "vm_erp.vm_erp.beispieldaten.api.profile", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Die Profile mit Titel, Beschreibung und der Menge, die ein Laden anlegen wuerde.", "tags": [ "Beispieldaten" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Die Profile mit Titel, Beschreibung und der Menge, die ein Laden anlegen wuerde.", "operationId": "vm_erp.vm_erp.beispieldaten.api.profile", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Die Profile mit Titel, Beschreibung und der Menge, die ein Laden anlegen wuerde.", "tags": [ "Beispieldaten" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.beispieldaten.api.vorschau": { "get": { "description": "", "operationId": "vm_erp.vm_erp.beispieldaten.api.vorschau", "parameters": [ { "description": "", "in": "query", "name": "profil", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorschau", "tags": [ "Beispieldaten" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.beispieldaten.api.vorschau", "requestBody": { "content": { "application/json": { "schema": { "properties": { "profil": { "description": "", "type": "string" } }, "required": [ "profil" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorschau", "tags": [ "Beispieldaten" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.betrieb.api.status": { "get": { "description": "", "operationId": "vm_erp.vm_erp.betrieb.api.status", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "status", "tags": [ "Betrieb" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.betrieb.api.status", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "status", "tags": [ "Betrieb" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.api.apply_split": { "post": { "description": "Create the VM Box documents from the current preview. Needs confirm=1 (the page sets it after the user confirmed the preview) and refuses orders that already have boxes.", "operationId": "vm_erp.vm_erp.box.api.apply_split", "requestBody": { "content": { "application/json": { "schema": { "properties": { "confirm": { "description": "", "type": "integer" }, "sales_order": { "description": "", "type": "string" } }, "required": [ "sales_order" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Create the VM Box documents from the current preview", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ], [ "Stock Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.box.api.get_demo": { "get": { "description": "Invented example orders for demonstration, no database access.", "operationId": "vm_erp.vm_erp.box.api.get_demo", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Invented example orders for demonstration, no database access.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ], [ "Stock Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Invented example orders for demonstration, no database access.", "operationId": "vm_erp.vm_erp.box.api.get_demo", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Invented example orders for demonstration, no database access.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ], [ "Stock Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.api.get_overview": { "get": { "description": "Cards of orders that already have boxes. Partner events and freshness come from the example adapters until real adapters are wired (field `demo` says so).", "operationId": "vm_erp.vm_erp.box.api.get_overview", "parameters": [ { "description": "", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Cards of orders that already have boxes", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ], [ "Stock Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Cards of orders that already have boxes. Partner events and freshness come from the example adapters until real adapters are wired (field `demo` says so).", "operationId": "vm_erp.vm_erp.box.api.get_overview", "requestBody": { "content": { "application/json": { "schema": { "properties": { "limit": { "description": "", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Cards of orders that already have boxes", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ], [ "Stock Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.api.preview_split": { "get": { "description": "Preview of the split of one order. Writes nothing.", "operationId": "vm_erp.vm_erp.box.api.preview_split", "parameters": [ { "description": "", "in": "query", "name": "sales_order", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Preview of the split of one order", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ], [ "Stock Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Preview of the split of one order. Writes nothing.", "operationId": "vm_erp.vm_erp.box.api.preview_split", "requestBody": { "content": { "application/json": { "schema": { "properties": { "sales_order": { "description": "", "type": "string" } }, "required": [ "sales_order" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Preview of the split of one order", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ], [ "Stock Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.bahn_api.get_bahn": { "get": { "description": "Timeline for one order. Without a real order the example is shown.", "operationId": "vm_erp.vm_erp.box.bahn_api.get_bahn", "parameters": [ { "description": "", "in": "query", "name": "sales_order", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Timeline for one order", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Timeline for one order. Without a real order the example is shown.", "operationId": "vm_erp.vm_erp.box.bahn_api.get_bahn", "requestBody": { "content": { "application/json": { "schema": { "properties": { "sales_order": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Timeline for one order", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.bahn_api.get_dubletten": { "get": { "description": "", "operationId": "vm_erp.vm_erp.box.bahn_api.get_dubletten", "parameters": [ { "description": "", "in": "query", "name": "auftraege", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_dubletten", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.box.bahn_api.get_dubletten", "requestBody": { "content": { "application/json": { "schema": { "properties": { "auftraege": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_dubletten", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.bahn_api.get_partnerbericht": { "get": { "description": "", "operationId": "vm_erp.vm_erp.box.bahn_api.get_partnerbericht", "parameters": [ { "description": "", "in": "query", "name": "woche_start", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_partnerbericht", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.box.bahn_api.get_partnerbericht", "requestBody": { "content": { "application/json": { "schema": { "properties": { "woche_start": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_partnerbericht", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.bahn_api.teilstorno_plan": { "post": { "description": "Plan only. Writes nothing, sends nothing.", "operationId": "vm_erp.vm_erp.box.bahn_api.teilstorno_plan", "requestBody": { "content": { "application/json": { "schema": { "properties": { "box": { "description": "", "type": "string" }, "position": { "description": "", "type": "string" } }, "required": [ "box", "position" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Plan only", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.frische_api.auftrag_hinweis": { "get": { "description": "Freshness hint for one order from the partners of its boxes (used by the order form).", "operationId": "vm_erp.vm_erp.box.frische_api.auftrag_hinweis", "parameters": [ { "description": "", "in": "query", "name": "sales_order", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Freshness hint for one order from the partners of its boxes (used by the order form).", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Freshness hint for one order from the partners of its boxes (used by the order form).", "operationId": "vm_erp.vm_erp.box.frische_api.auftrag_hinweis", "requestBody": { "content": { "application/json": { "schema": { "properties": { "sales_order": { "description": "", "type": "string" } }, "required": [ "sales_order" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Freshness hint for one order from the partners of its boxes (used by the order form).", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.frische_api.entwurf_pruefen": { "get": { "description": "Assistant rule: a draft with a delivery promise is replaced when the partner source is red.", "operationId": "vm_erp.vm_erp.box.frische_api.entwurf_pruefen", "parameters": [ { "description": "", "in": "query", "name": "entwurf", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "partner", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Assistant rule: a draft with a delivery promise is replaced when the partner source is red.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Assistant rule: a draft with a delivery promise is replaced when the partner source is red.", "operationId": "vm_erp.vm_erp.box.frische_api.entwurf_pruefen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "entwurf": { "description": "", "type": "string" }, "partner": { "description": "", "type": "string" } }, "required": [ "entwurf", "partner" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Assistant rule: a draft with a delivery promise is replaced when the partner source is red.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.frische_api.get_frische": { "get": { "description": "Banner data, source map, 30 day time travel and problem list per partner.", "operationId": "vm_erp.vm_erp.box.frische_api.get_frische", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Banner data, source map, 30 day time travel and problem list per partner.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Banner data, source map, 30 day time travel and problem list per partner.", "operationId": "vm_erp.vm_erp.box.frische_api.get_frische", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Banner data, source map, 30 day time travel and problem list per partner.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.frische_api.get_rueckstand": { "get": { "description": "Backlog per customer with bundle mail drafts (preview only) and forecast.", "operationId": "vm_erp.vm_erp.box.frische_api.get_rueckstand", "parameters": [ { "description": "", "in": "query", "name": "ablauf_tage", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Backlog per customer with bundle mail drafts (preview only) and forecast.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Backlog per customer with bundle mail drafts (preview only) and forecast.", "operationId": "vm_erp.vm_erp.box.frische_api.get_rueckstand", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ablauf_tage": { "description": "", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Backlog per customer with bundle mail drafts (preview only) and forecast.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.regel_labor_api.regel_simulieren": { "get": { "description": "Simulation of a candidate rule over the open and delivered positions of the last days. Reads Sales Order Items, writes nothing.", "operationId": "vm_erp.vm_erp.box.regel_labor_api.regel_simulieren", "parameters": [ { "description": "", "in": "query", "name": "kandidat", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "tage", "required": false, "schema": { "type": "integer" } }, { "description": "", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Simulation of a candidate rule over the open and delivered positions of the last days", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Simulation of a candidate rule over the open and delivered positions of the last days. Reads Sales Order Items, writes nothing.", "operationId": "vm_erp.vm_erp.box.regel_labor_api.regel_simulieren", "requestBody": { "content": { "application/json": { "schema": { "properties": { "kandidat": { "description": "", "type": "string" }, "limit": { "description": "", "type": "integer" }, "tage": { "description": "", "type": "integer" } }, "required": [ "kandidat" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Simulation of a candidate rule over the open and delivered positions of the last days", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.regel_labor_api.regel_testen": { "get": { "description": "Which box would the rules choose for 'article X, quantity N' and why. Reads only.", "operationId": "vm_erp.vm_erp.box.regel_labor_api.regel_testen", "parameters": [ { "description": "", "in": "query", "name": "item_code", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "qty", "required": false, "schema": { "type": "integer" } }, { "description": "", "in": "query", "name": "kandidat", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Which box would the rules choose for 'article X, quantity N' and why", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Which box would the rules choose for 'article X, quantity N' and why. Reads only.", "operationId": "vm_erp.vm_erp.box.regel_labor_api.regel_testen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "item_code": { "description": "", "type": "string" }, "kandidat": { "description": "", "type": "string" }, "qty": { "description": "", "type": "integer" } }, "required": [ "item_code" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Which box would the rules choose for 'article X, quantity N' and why", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.box.regel_labor_api.regeln_pruefen": { "get": { "description": "Conflict check of the current rules (plus an optional candidate) against recent positions.", "operationId": "vm_erp.vm_erp.box.regel_labor_api.regeln_pruefen", "parameters": [ { "description": "", "in": "query", "name": "kandidat", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "tage", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Conflict check of the current rules (plus an optional candidate) against recent positions.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Conflict check of the current rules (plus an optional candidate) against recent positions.", "operationId": "vm_erp.vm_erp.box.regel_labor_api.regeln_pruefen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "kandidat": { "description": "", "type": "string" }, "tage": { "description": "", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Conflict check of the current rules (plus an optional candidate) against recent positions.", "tags": [ "Box und Streckengeschäft" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.chargen.api.get_aufgaben": { "get": { "description": "Arbeitsliste \"zuerst verkaufen\". Ohne echte Chargen leer, damit Beispiele die Liste nicht fuellen.", "operationId": "vm_erp.vm_erp.chargen.api.get_aufgaben", "parameters": [ { "description": "", "in": "query", "name": "tage", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Arbeitsliste \"zuerst verkaufen\"", "tags": [ "Chargen und Haltbarkeit" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Arbeitsliste \"zuerst verkaufen\". Ohne echte Chargen leer, damit Beispiele die Liste nicht fuellen.", "operationId": "vm_erp.vm_erp.chargen.api.get_aufgaben", "requestBody": { "content": { "application/json": { "schema": { "properties": { "tage": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Arbeitsliste \"zuerst verkaufen\"", "tags": [ "Chargen und Haltbarkeit" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.chargen.api.get_mhd_report": { "get": { "description": "Ablaufende und abgelaufene Chargen mit Wert.", "operationId": "vm_erp.vm_erp.chargen.api.get_mhd_report", "parameters": [ { "description": "", "in": "query", "name": "tage", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Ablaufende und abgelaufene Chargen mit Wert.", "tags": [ "Chargen und Haltbarkeit" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Ablaufende und abgelaufene Chargen mit Wert.", "operationId": "vm_erp.vm_erp.chargen.api.get_mhd_report", "requestBody": { "content": { "application/json": { "schema": { "properties": { "tage": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Ablaufende und abgelaufene Chargen mit Wert.", "tags": [ "Chargen und Haltbarkeit" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.dashboard_chart_source.vm_top_artikel_monat.vm_top_artikel_monat.get": { "get": { "description": "", "operationId": "vm_erp.vm_erp.dashboard_chart_source.vm_top_artikel_monat.vm_top_artikel_monat.get", "parameters": [ { "description": "", "in": "query", "name": "chart_name", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "chart", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "no_cache", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "filters", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "from_date", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "to_date", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "timespan", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "time_interval", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "heatmap_year", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get", "tags": [ "Diagrammquellen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.dashboard_chart_source.vm_top_artikel_monat.vm_top_artikel_monat.get", "requestBody": { "content": { "application/json": { "schema": { "properties": { "chart": { "description": "", "type": "string" }, "chart_name": { "description": "", "type": "string" }, "filters": { "description": "", "type": "string" }, "from_date": { "description": "", "type": "string" }, "heatmap_year": { "description": "", "type": "string" }, "no_cache": { "description": "", "type": "string" }, "time_interval": { "description": "", "type": "string" }, "timespan": { "description": "", "type": "string" }, "to_date": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get", "tags": [ "Diagrammquellen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.datev.api.get_stammdaten": { "get": { "description": "Debitoren und Kreditoren mit Kontonummern nach der Kontenlaenge aus dem Register. Die Nummern sind ein Vorschlag.", "operationId": "vm_erp.vm_erp.datev.api.get_stammdaten", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Debitoren und Kreditoren mit Kontonummern nach der Kontenlaenge aus dem Register", "tags": [ "DATEV" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Debitoren und Kreditoren mit Kontonummern nach der Kontenlaenge aus dem Register. Die Nummern sind ein Vorschlag.", "operationId": "vm_erp.vm_erp.datev.api.get_stammdaten", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Debitoren und Kreditoren mit Kontonummern nach der Kontenlaenge aus dem Register", "tags": [ "DATEV" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.datev.api.get_stapel_liste": { "get": { "description": "Stapelhistorie.", "operationId": "vm_erp.vm_erp.datev.api.get_stapel_liste", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Stapelhistorie.", "tags": [ "DATEV" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Stapelhistorie.", "operationId": "vm_erp.vm_erp.datev.api.get_stapel_liste", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Stapelhistorie.", "tags": [ "DATEV" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.datev.api.get_vorpruefung": { "get": { "description": "Befunde fuer den Zeitraum. Aendert nichts.", "operationId": "vm_erp.vm_erp.datev.api.get_vorpruefung", "parameters": [ { "description": "", "in": "query", "name": "company", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "von", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "bis", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Befunde fuer den Zeitraum", "tags": [ "DATEV" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Befunde fuer den Zeitraum. Aendert nichts.", "operationId": "vm_erp.vm_erp.datev.api.get_vorpruefung", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bis": { "description": "", "type": "string" }, "company": { "description": "", "type": "string" }, "von": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Befunde fuer den Zeitraum", "tags": [ "DATEV" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.datev.api.stapel_ablegen": { "post": { "description": "Legt den Export in die Historie, aber nur wenn kein Befund blockiert. Bucht nichts.", "operationId": "vm_erp.vm_erp.datev.api.stapel_ablegen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bis": { "description": "", "type": "string" }, "company": { "description": "", "type": "string" }, "von": { "description": "", "type": "string" } }, "required": [ "company", "von", "bis" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt den Export in die Historie, aber nur wenn kein Befund blockiert", "tags": [ "DATEV" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.einkauf.api.get_zulaufkalender": { "get": { "description": "Zulaufkalender aus offenen Einkaufsbestellungspositionen. Ohne Daten: Beispieldaten.", "operationId": "vm_erp.vm_erp.einkauf.api.get_zulaufkalender", "parameters": [ { "description": "", "in": "query", "name": "artikel", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Zulaufkalender aus offenen Einkaufsbestellungspositionen", "tags": [ "Einkauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Zulaufkalender aus offenen Einkaufsbestellungspositionen. Ohne Daten: Beispieldaten.", "operationId": "vm_erp.vm_erp.einkauf.api.get_zulaufkalender", "requestBody": { "content": { "application/json": { "schema": { "properties": { "artikel": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Zulaufkalender aus offenen Einkaufsbestellungspositionen", "tags": [ "Einkauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.einrichtung.api.get_stand": { "get": { "description": "Alle Schritte mit Feldern und Standardwerten plus Stand und Fortschritt.", "operationId": "vm_erp.vm_erp.einrichtung.api.get_stand", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Alle Schritte mit Feldern und Standardwerten plus Stand und Fortschritt.", "tags": [ "Einrichtungsassistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Alle Schritte mit Feldern und Standardwerten plus Stand und Fortschritt.", "operationId": "vm_erp.vm_erp.einrichtung.api.get_stand", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Alle Schritte mit Feldern und Standardwerten plus Stand und Fortschritt.", "tags": [ "Einrichtungsassistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.einrichtung.api.spaeter": { "get": { "description": "", "operationId": "vm_erp.vm_erp.einrichtung.api.spaeter", "parameters": [ { "description": "", "in": "query", "name": "schritt", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "spaeter", "tags": [ "Einrichtungsassistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.einrichtung.api.spaeter", "requestBody": { "content": { "application/json": { "schema": { "properties": { "schritt": { "description": "", "type": "string" } }, "required": [ "schritt" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "spaeter", "tags": [ "Einrichtungsassistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.einrichtung.api.speichern": { "get": { "description": "Ein Schritt einzeln. Bei Fehlern in der Eingabe wird nichts geschrieben und die Meldungen kommen zurueck.", "operationId": "vm_erp.vm_erp.einrichtung.api.speichern", "parameters": [ { "description": "", "in": "query", "name": "schritt", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "werte", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Ein Schritt einzeln", "tags": [ "Einrichtungsassistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "Ein Schritt einzeln. Bei Fehlern in der Eingabe wird nichts geschrieben und die Meldungen kommen zurueck.", "operationId": "vm_erp.vm_erp.einrichtung.api.speichern", "requestBody": { "content": { "application/json": { "schema": { "properties": { "schritt": { "description": "", "type": "string" }, "werte": { "description": "", "type": "string" } }, "required": [ "schritt" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Ein Schritt einzeln", "tags": [ "Einrichtungsassistent" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.einstellung.api.get_ampel": { "get": { "description": "", "operationId": "vm_erp.vm_erp.einstellung.api.get_ampel", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_ampel", "tags": [ "Einstellungsregister" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.einstellung.api.get_ampel", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_ampel", "tags": [ "Einstellungsregister" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.erechnung.ausgang_api.erzeugen": { "post": { "description": "XML erzeugen, pruefen, privat ablegen, Status festhalten. Die Rechnung bleibt unveraendert.", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.erzeugen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ausgangsrechnung": { "description": "", "type": "string" }, "format": { "description": "", "type": "string" } }, "required": [ "ausgangsrechnung" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "XML erzeugen, pruefen, privat ablegen, Status festhalten", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "Sales User", "System Manager" ], [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.erechnung.ausgang_api.get_beispiel": { "get": { "description": "Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.get_beispiel", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.get_beispiel", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.erechnung.ausgang_api.get_liste": { "get": { "description": "", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.get_liste", "parameters": [ { "description": "", "in": "query", "name": "status_filter", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_liste", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.get_liste", "requestBody": { "content": { "application/json": { "schema": { "properties": { "status_filter": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_liste", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.erechnung.ausgang_api.status_setzen": { "post": { "description": "Weiterschalten: versendet oder abgelehnt (mit Grund). Die Datei wird nicht verschickt, das macht die Person.", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.status_setzen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "eintrag": { "description": "", "type": "string" }, "grund": { "description": "", "type": "string" }, "nach": { "description": "", "type": "string" } }, "required": [ "eintrag", "nach" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Weiterschalten: versendet oder abgelehnt (mit Grund)", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "Sales User", "System Manager" ], [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.erechnung.ausgang_api.vorschau": { "get": { "description": "Prueft, was erzeugt wuerde. Schreibt nichts.", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.vorschau", "parameters": [ { "description": "", "in": "query", "name": "ausgangsrechnung", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "format", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft, was erzeugt wuerde", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Prueft, was erzeugt wuerde. Schreibt nichts.", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.vorschau", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ausgangsrechnung": { "description": "", "type": "string" }, "format": { "description": "", "type": "string" } }, "required": [ "ausgangsrechnung" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft, was erzeugt wuerde", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.erechnung.ausgang_api.z3_index_xml": { "get": { "description": "Verzeichnisdatei (index.xml) fuer die erzeugten E-Rechnungen im Zeitraum. Nur lesend.", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.z3_index_xml", "parameters": [ { "description": "", "in": "query", "name": "von", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "bis", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Verzeichnisdatei (index.xml) fuer die erzeugten E-Rechnungen im Zeitraum", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "Sales User", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Verzeichnisdatei (index.xml) fuer die erzeugten E-Rechnungen im Zeitraum. Nur lesend.", "operationId": "vm_erp.vm_erp.erechnung.ausgang_api.z3_index_xml", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bis": { "description": "", "type": "string" }, "von": { "description": "", "type": "string" } }, "required": [ "von", "bis" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Verzeichnisdatei (index.xml) fuer die erzeugten E-Rechnungen im Zeitraum", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "Sales User", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.erechnung.eingang_api.entwurf_anlegen": { "post": { "description": "Original privat ablegen, Datensatz anlegen, Eingangsrechnung als Entwurf. Bucht nichts.", "operationId": "vm_erp.vm_erp.erechnung.eingang_api.entwurf_anlegen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "dateiname": { "description": "", "type": "string" }, "daten_b64": { "description": "", "type": "string" }, "konto": { "description": "", "type": "string" }, "kostenstelle": { "description": "", "type": "string" } }, "required": [ "daten_b64" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Original privat ablegen, Datensatz anlegen, Eingangsrechnung als Entwurf", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "Purchase User", "System Manager" ], [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.erechnung.eingang_api.get_beispiel": { "get": { "description": "Beispieldaten fuer die Seite, nichts wird gelesen oder geschrieben.", "operationId": "vm_erp.vm_erp.erechnung.eingang_api.get_beispiel", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Beispieldaten fuer die Seite, nichts wird gelesen oder geschrieben.", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Beispieldaten fuer die Seite, nichts wird gelesen oder geschrieben.", "operationId": "vm_erp.vm_erp.erechnung.eingang_api.get_beispiel", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Beispieldaten fuer die Seite, nichts wird gelesen oder geschrieben.", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.erechnung.eingang_api.get_liste": { "get": { "description": "", "operationId": "vm_erp.vm_erp.erechnung.eingang_api.get_liste", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_liste", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.erechnung.eingang_api.get_liste", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_liste", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.erechnung.eingang_api.lese_datei": { "get": { "description": "Datei (Base64) lesen und pruefen. Schreibt nichts.", "operationId": "vm_erp.vm_erp.erechnung.eingang_api.lese_datei", "parameters": [ { "description": "", "in": "query", "name": "daten_b64", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "dateiname", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Datei (Base64) lesen und pruefen", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "Purchase User", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Datei (Base64) lesen und pruefen. Schreibt nichts.", "operationId": "vm_erp.vm_erp.erechnung.eingang_api.lese_datei", "requestBody": { "content": { "application/json": { "schema": { "properties": { "dateiname": { "description": "", "type": "string" }, "daten_b64": { "description": "", "type": "string" } }, "required": [ "daten_b64" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Datei (Base64) lesen und pruefen", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "Purchase User", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.erechnung.eingang_api.z3_index_xml": { "get": { "description": "Verzeichnisdatei (index.xml) fuer die abgelegten E-Rechnungen im Zeitraum, ueber gobd/z3_index. Nur lesend.", "operationId": "vm_erp.vm_erp.erechnung.eingang_api.z3_index_xml", "parameters": [ { "description": "", "in": "query", "name": "von", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "bis", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Verzeichnisdatei (index.xml) fuer die abgelegten E-Rechnungen im Zeitraum, ueber gobd/z3_index", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "Purchase User", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Verzeichnisdatei (index.xml) fuer die abgelegten E-Rechnungen im Zeitraum, ueber gobd/z3_index. Nur lesend.", "operationId": "vm_erp.vm_erp.erechnung.eingang_api.z3_index_xml", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bis": { "description": "", "type": "string" }, "von": { "description": "", "type": "string" } }, "required": [ "von", "bis" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Verzeichnisdatei (index.xml) fuer die abgelegten E-Rechnungen im Zeitraum, ueber gobd/z3_index", "tags": [ "E-Rechnung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "Purchase User", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.export.api.austritt_herunterladen": { "post": { "description": "Gibt die private Datei-URL des fertigen Archivs zurueck und vermerkt den Abruf im Protokoll.", "operationId": "vm_erp.vm_erp.export.api.austritt_herunterladen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "job_id": { "description": "", "type": "string" } }, "required": [ "job_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Gibt die private Datei-URL des fertigen Archivs zurueck und vermerkt den Abruf im Protokoll.", "tags": [ "Austrittspaket" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.export.api.austritt_starten": { "post": { "description": "Startet den Export im Hintergrund (queue long). Gibt {job_id} zurueck.", "operationId": "vm_erp.vm_erp.export.api.austritt_starten", "requestBody": { "content": { "application/json": { "schema": { "properties": { "company": { "description": "", "type": "string" }, "date_from": { "description": "", "type": "string" }, "date_to": { "description": "", "type": "string" } }, "required": [ "company", "date_from", "date_to" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Startet den Export im Hintergrund (queue long)", "tags": [ "Austrittspaket" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.export.api.austritt_status": { "get": { "description": "Fortschritt eines Exports. Nur lesend; nur der Nutzer, der ihn gestartet hat (und nur als System Manager).", "operationId": "vm_erp.vm_erp.export.api.austritt_status", "parameters": [ { "description": "", "in": "query", "name": "job_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Fortschritt eines Exports", "tags": [ "Austrittspaket" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Fortschritt eines Exports. Nur lesend; nur der Nutzer, der ihn gestartet hat (und nur als System Manager).", "operationId": "vm_erp.vm_erp.export.api.austritt_status", "requestBody": { "content": { "application/json": { "schema": { "properties": { "job_id": { "description": "", "type": "string" } }, "required": [ "job_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Fortschritt eines Exports", "tags": [ "Austrittspaket" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.forderungen.api.alterung": { "get": { "description": "Staffeln je Kunde und gesamt. Lesend.", "operationId": "vm_erp.vm_erp.forderungen.api.alterung", "parameters": [ { "description": "", "in": "query", "name": "stichtag", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "firma", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "kunde", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Staffeln je Kunde und gesamt", "tags": [ "Forderungen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Staffeln je Kunde und gesamt. Lesend.", "operationId": "vm_erp.vm_erp.forderungen.api.alterung", "requestBody": { "content": { "application/json": { "schema": { "properties": { "firma": { "description": "", "type": "string" }, "kunde": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Staffeln je Kunde und gesamt", "tags": [ "Forderungen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.forderungen.api.csv_export": { "get": { "description": "Alterung als CSV (Semikolon). Jede Zelle geht durch csv_zelle (Formelschutz). Betraege bleiben Zahlen.", "operationId": "vm_erp.vm_erp.forderungen.api.csv_export", "parameters": [ { "description": "", "in": "query", "name": "stichtag", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "firma", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Alterung als CSV (Semikolon)", "tags": [ "Forderungen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Alterung als CSV (Semikolon). Jede Zelle geht durch csv_zelle (Formelschutz). Betraege bleiben Zahlen.", "operationId": "vm_erp.vm_erp.forderungen.api.csv_export", "requestBody": { "content": { "application/json": { "schema": { "properties": { "firma": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Alterung als CSV (Semikolon)", "tags": [ "Forderungen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.forderungen.api.kontoauszug_entwurf": { "post": { "description": "Legt den Kontoauszug als private PDF-Datei am Kunden ab. Versendet nichts.", "operationId": "vm_erp.vm_erp.forderungen.api.kontoauszug_entwurf", "requestBody": { "content": { "application/json": { "schema": { "properties": { "kunde": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" } }, "required": [ "kunde" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt den Kontoauszug als private PDF-Datei am Kunden ab", "tags": [ "Forderungen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.freigabe.api.anfrage_stellen": { "post": { "description": "Der Beleg bleibt unveraendert.", "operationId": "vm_erp.vm_erp.freigabe.api.anfrage_stellen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "beleg": { "description": "", "type": "string" }, "belegart": { "description": "", "type": "string" } }, "required": [ "belegart", "beleg" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Der Beleg bleibt unveraendert.", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts Manager", "Accounts User", "Purchase Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.freigabe.api.entscheiden": { "post": { "description": "Freigeben oder ablehnen. Grund ist Pflicht. Eigene Anfragen kann niemand entscheiden.", "operationId": "vm_erp.vm_erp.freigabe.api.entscheiden", "requestBody": { "content": { "application/json": { "schema": { "properties": { "anfrage": { "description": "", "type": "string" }, "grund": { "description": "", "type": "string" }, "ok": { "description": "", "type": "string" } }, "required": [ "anfrage", "ok", "grund" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Freigeben oder ablehnen", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts Manager", "Accounts User", "Purchase Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.freigabe.api.get_aufgaben": { "get": { "description": "Reine Aufgabenliste fuer die Arbeitsliste: [{titel, beleg, prioritaet}] fuer die angemeldete Person.", "operationId": "vm_erp.vm_erp.freigabe.api.get_aufgaben", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Reine Aufgabenliste fuer die Arbeitsliste: [{titel, beleg, prioritaet}] fuer die angemeldete Person.", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Reine Aufgabenliste fuer die Arbeitsliste: [{titel, beleg, prioritaet}] fuer die angemeldete Person.", "operationId": "vm_erp.vm_erp.freigabe.api.get_aufgaben", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Reine Aufgabenliste fuer die Arbeitsliste: [{titel, beleg, prioritaet}] fuer die angemeldete Person.", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.freigabe.api.get_beispiel": { "get": { "description": "Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.", "operationId": "vm_erp.vm_erp.freigabe.api.get_beispiel", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.", "operationId": "vm_erp.vm_erp.freigabe.api.get_beispiel", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.freigabe.api.get_offene": { "get": { "description": "Offene Anfragen, die die angemeldete Person entscheiden darf, und alle offenen zur Uebersicht.", "operationId": "vm_erp.vm_erp.freigabe.api.get_offene", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Offene Anfragen, die die angemeldete Person entscheiden darf, und alle offenen zur Uebersicht.", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Offene Anfragen, die die angemeldete Person entscheiden darf, und alle offenen zur Uebersicht.", "operationId": "vm_erp.vm_erp.freigabe.api.get_offene", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Offene Anfragen, die die angemeldete Person entscheiden darf, und alle offenen zur Uebersicht.", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.freigabe.api.get_regeln": { "get": { "description": "", "operationId": "vm_erp.vm_erp.freigabe.api.get_regeln", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_regeln", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.freigabe.api.get_regeln", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_regeln", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.freigabe.api.regel_pruefen": { "get": { "description": "Trockentest: wen haette die Regel in den letzten 30 Tagen getroffen? Liest Belege, schreibt nichts.", "operationId": "vm_erp.vm_erp.freigabe.api.regel_pruefen", "parameters": [ { "description": "", "in": "query", "name": "regel_name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Trockentest: wen haette die Regel in den letzten 30 Tagen getroffen? Liest Belege, schreibt nichts.", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts Manager", "System Manager" ], [ "Accounts Manager", "Accounts User", "Purchase Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Trockentest: wen haette die Regel in den letzten 30 Tagen getroffen? Liest Belege, schreibt nichts.", "operationId": "vm_erp.vm_erp.freigabe.api.regel_pruefen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "regel_name": { "description": "", "type": "string" } }, "required": [ "regel_name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Trockentest: wen haette die Regel in den letzten 30 Tagen getroffen? Liest Belege, schreibt nichts.", "tags": [ "Freigaben" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts Manager", "System Manager" ], [ "Accounts Manager", "Accounts User", "Purchase Manager", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.gobd.z3.start_export": { "post": { "description": "Queue the export (long queue, own timeout). Only Accounts Manager and System Manager.", "operationId": "vm_erp.vm_erp.gobd.z3.start_export", "requestBody": { "content": { "application/json": { "schema": { "properties": { "company": { "description": "", "type": "string" }, "date_from": { "description": "", "type": "string" }, "date_to": { "description": "", "type": "string" } }, "required": [ "company", "date_from", "date_to" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Queue the export (long queue, own timeout)", "tags": [ "GoBD-Export" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Rollengeschützt, Gast gesperrt" } }, "/api/method/vm_erp.vm_erp.golive.api.demo_anmelden": { "post": { "description": "Meldet den festen Demo-Leser an. Kein Parameter; der Benutzer kommt nie aus der Anfrage.\n\nNur mit beiden Flags (vm_demo_modus und vm_demo_login_offen), nur als POST von der eigenen Seite, mit Rollenpruefung des Kontos und Ratenbegrenzung je Client und global. Ohne Freigabe antwortet die Funktion generisch 'Nicht verfügbar'.", "operationId": "vm_erp.vm_erp.golive.api.demo_anmelden", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ {} ], "summary": "Meldet den festen Demo-Leser an", "tags": [ "Demo und Erster Blick" ], "x-vm-gast": true, "x-vm-rollen": [], "x-vm-zugriff": "Öffentlich (ohne Anmeldung)" } }, "/api/method/vm_erp.vm_erp.golive.api.demo_einladung_anmelden": { "post": { "description": "Meldet mit einem gueltigen Einladungslink den festen Demo-Leser an (POST von der eigenen Seite).\n\nGleiche Schutzschichten wie demo_anmelden: Herkunftspruefung, exakte Rollenpruefung des Kontos, Ratenbegrenzung, 60-Minuten-Sitzung (fail closed). Das Flag vm_demo_login_offen ist nicht noetig, der signierte Link ist die Berechtigung.", "operationId": "vm_erp.vm_erp.golive.api.demo_einladung_anmelden", "requestBody": { "content": { "application/json": { "schema": { "properties": { "t": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ {} ], "summary": "Meldet mit einem gueltigen Einladungslink den festen Demo-Leser an (POST von der eigenen Seite).", "tags": [ "Demo und Erster Blick" ], "x-vm-gast": true, "x-vm-rollen": [], "x-vm-zugriff": "Öffentlich (ohne Anmeldung)" } }, "/api/method/vm_erp.vm_erp.golive.api.demo_einladung_seite": { "get": { "description": "Landeseite des Einladungslinks (GET). Meldet NIE an: Mailscanner und Linkvorschauen koennen nichts ausloesen.\n\nZeigt bei gueltigem Token einen Knopf 'Demo oeffnen', der per POST anmeldet. Ohne Demo-Modus und Geheimnis (auch auf Produktion) antwortet sie generisch 'Nicht verfuegbar'. Das Token steht nirgends im Protokoll.", "operationId": "vm_erp.vm_erp.golive.api.demo_einladung_seite", "parameters": [ { "description": "", "in": "query", "name": "t", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ {} ], "summary": "Landeseite des Einladungslinks (GET)", "tags": [ "Demo und Erster Blick" ], "x-vm-gast": true, "x-vm-rollen": [], "x-vm-zugriff": "Öffentlich (ohne Anmeldung)" } }, "/api/method/vm_erp.vm_erp.golive.api.demo_status": { "get": { "description": "Gast, nur lesend: darf die Anmeldeseite den Knopf 'Als Demo ansehen' zeigen? Verraet sonst nichts.", "operationId": "vm_erp.vm_erp.golive.api.demo_status", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ {} ], "summary": "Gast, nur lesend: darf die Anmeldeseite den Knopf 'Als Demo ansehen' zeigen? Verraet sonst nichts.", "tags": [ "Demo und Erster Blick" ], "x-vm-gast": true, "x-vm-rollen": [], "x-vm-zugriff": "Öffentlich (ohne Anmeldung)" } }, "/api/method/vm_erp.vm_erp.golive.api.erster_blick": { "get": { "description": "Daten fuer die Seite 'Erster Blick': ein Auftrag mit seinen vier Ampeln.", "operationId": "vm_erp.vm_erp.golive.api.erster_blick", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Daten fuer die Seite 'Erster Blick': ein Auftrag mit seinen vier Ampeln.", "tags": [ "Demo und Erster Blick" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Daten fuer die Seite 'Erster Blick': ein Auftrag mit seinen vier Ampeln.", "operationId": "vm_erp.vm_erp.golive.api.erster_blick", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Daten fuer die Seite 'Erster Blick': ein Auftrag mit seinen vier Ampeln.", "tags": [ "Demo und Erster Blick" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.import_assistent.api.importieren": { "get": { "description": "Importiert nur, wenn der Probelauf ohne Fehler ist. Zeilen mit vorhandenem Schluessel werden uebersprungen.", "operationId": "vm_erp.vm_erp.import_assistent.api.importieren", "parameters": [ { "description": "", "in": "query", "name": "ziel", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "inhalt", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "zuordnung", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Importiert nur, wenn der Probelauf ohne Fehler ist", "tags": [ "Datenimport" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "Importiert nur, wenn der Probelauf ohne Fehler ist. Zeilen mit vorhandenem Schluessel werden uebersprungen.", "operationId": "vm_erp.vm_erp.import_assistent.api.importieren", "requestBody": { "content": { "application/json": { "schema": { "properties": { "inhalt": { "description": "", "type": "string" }, "ziel": { "description": "", "type": "string" }, "zuordnung": { "description": "", "type": "string" } }, "required": [ "ziel", "inhalt" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Importiert nur, wenn der Probelauf ohne Fehler ist", "tags": [ "Datenimport" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.import_assistent.api.vorschau": { "get": { "description": "Liest die Datei, schlaegt die Zuordnung vor und macht den Probelauf. Legt nichts an.", "operationId": "vm_erp.vm_erp.import_assistent.api.vorschau", "parameters": [ { "description": "", "in": "query", "name": "ziel", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "inhalt", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "zuordnung", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Liest die Datei, schlaegt die Zuordnung vor und macht den Probelauf", "tags": [ "Datenimport" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Liest die Datei, schlaegt die Zuordnung vor und macht den Probelauf. Legt nichts an.", "operationId": "vm_erp.vm_erp.import_assistent.api.vorschau", "requestBody": { "content": { "application/json": { "schema": { "properties": { "inhalt": { "description": "", "type": "string" }, "ziel": { "description": "", "type": "string" }, "zuordnung": { "description": "", "type": "string" } }, "required": [ "ziel", "inhalt" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Liest die Datei, schlaegt die Zuordnung vor und macht den Probelauf", "tags": [ "Datenimport" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.import_assistent.api.ziele": { "get": { "description": "Importtypen mit ihren Feldern, fuer die Auswahl der Spalten.", "operationId": "vm_erp.vm_erp.import_assistent.api.ziele", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Importtypen mit ihren Feldern, fuer die Auswahl der Spalten.", "tags": [ "Datenimport" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Importtypen mit ihren Feldern, fuer die Auswahl der Spalten.", "operationId": "vm_erp.vm_erp.import_assistent.api.ziele", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Importtypen mit ihren Feldern, fuer die Auswahl der Spalten.", "tags": [ "Datenimport" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.inventur.api.get_bewertung": { "get": { "description": "Lagerwert je Lager aus den aktuellen Bestaenden (Bewertungspreis aus dem Bin).", "operationId": "vm_erp.vm_erp.inventur.api.get_bewertung", "parameters": [ { "description": "", "in": "query", "name": "als_csv", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Lagerwert je Lager aus den aktuellen Bestaenden (Bewertungspreis aus dem Bin).", "tags": [ "Inventur" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Lagerwert je Lager aus den aktuellen Bestaenden (Bewertungspreis aus dem Bin).", "operationId": "vm_erp.vm_erp.inventur.api.get_bewertung", "requestBody": { "content": { "application/json": { "schema": { "properties": { "als_csv": { "description": "", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Lagerwert je Lager aus den aktuellen Bestaenden (Bewertungspreis aus dem Bin).", "tags": [ "Inventur" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.inventur.api.get_zaehlplan": { "get": { "description": "Heute faellige Artikel aus VM Zaehlplan.", "operationId": "vm_erp.vm_erp.inventur.api.get_zaehlplan", "parameters": [ { "description": "", "in": "query", "name": "tageslimit", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Heute faellige Artikel aus VM Zaehlplan.", "tags": [ "Inventur" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Heute faellige Artikel aus VM Zaehlplan.", "operationId": "vm_erp.vm_erp.inventur.api.get_zaehlplan", "requestBody": { "content": { "application/json": { "schema": { "properties": { "tageslimit": { "description": "", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Heute faellige Artikel aus VM Zaehlplan.", "tags": [ "Inventur" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.check_tracked": { "get": { "description": "Prueft Zeilen mit Charge/Seriennummer (Buchungsplan), ohne etwas anzulegen. art: wareneingang | auslagerung | umlagerung.", "operationId": "vm_erp.vm_erp.lager.api.check_tracked", "parameters": [ { "description": "", "in": "query", "name": "art", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "warehouse", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "lines", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft Zeilen mit Charge/Seriennummer (Buchungsplan), ohne etwas anzulegen", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Prueft Zeilen mit Charge/Seriennummer (Buchungsplan), ohne etwas anzulegen. art: wareneingang | auslagerung | umlagerung.", "operationId": "vm_erp.vm_erp.lager.api.check_tracked", "requestBody": { "content": { "application/json": { "schema": { "properties": { "art": { "description": "", "type": "string" }, "lines": { "description": "", "type": "string" }, "warehouse": { "description": "", "type": "string" } }, "required": [ "art", "warehouse", "lines" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft Zeilen mit Charge/Seriennummer (Buchungsplan), ohne etwas anzulegen", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.check_transfer": { "get": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.check_transfer", "parameters": [ { "description": "", "in": "query", "name": "from_warehouse", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "to_warehouse", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "lines", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "check_transfer", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.check_transfer", "requestBody": { "content": { "application/json": { "schema": { "properties": { "from_warehouse": { "description": "", "type": "string" }, "lines": { "description": "", "type": "string" }, "to_warehouse": { "description": "", "type": "string" } }, "required": [ "from_warehouse", "to_warehouse", "lines" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "check_transfer", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.create_issue": { "get": { "description": "Entwurf Stock Entry (Material Issue) fuer die Auslagerung. Nicht gebucht.", "operationId": "vm_erp.vm_erp.lager.api.create_issue", "parameters": [ { "description": "", "in": "query", "name": "warehouse", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "lines", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Entwurf Stock Entry (Material Issue) fuer die Auslagerung", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "Entwurf Stock Entry (Material Issue) fuer die Auslagerung. Nicht gebucht.", "operationId": "vm_erp.vm_erp.lager.api.create_issue", "requestBody": { "content": { "application/json": { "schema": { "properties": { "lines": { "description": "", "type": "string" }, "warehouse": { "description": "", "type": "string" } }, "required": [ "warehouse", "lines" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Entwurf Stock Entry (Material Issue) fuer die Auslagerung", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.lager.api.create_receipt": { "get": { "description": "Draft Purchase Receipt from scanned quantities {item_code: qty}. Not submitted. `chargen`: {item_code: {charge, verfall, serien}} fuer Artikel mit Charge oder Seriennummer.", "operationId": "vm_erp.vm_erp.lager.api.create_receipt", "parameters": [ { "description": "", "in": "query", "name": "po", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "scanned", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "warehouse", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "allow_over", "required": false, "schema": { "type": "integer" } }, { "description": "", "in": "query", "name": "chargen", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Draft Purchase Receipt from scanned quantities {item_code: qty}", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "Draft Purchase Receipt from scanned quantities {item_code: qty}. Not submitted. `chargen`: {item_code: {charge, verfall, serien}} fuer Artikel mit Charge oder Seriennummer.", "operationId": "vm_erp.vm_erp.lager.api.create_receipt", "requestBody": { "content": { "application/json": { "schema": { "properties": { "allow_over": { "description": "", "type": "integer" }, "chargen": { "description": "", "type": "string" }, "po": { "description": "", "type": "string" }, "scanned": { "description": "", "type": "string" }, "warehouse": { "description": "", "type": "string" } }, "required": [ "po", "scanned" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Draft Purchase Receipt from scanned quantities {item_code: qty}", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.lager.api.create_reconciliation": { "get": { "description": "Draft Stock Reconciliation from counted quantities. Not submitted.", "operationId": "vm_erp.vm_erp.lager.api.create_reconciliation", "parameters": [ { "description": "", "in": "query", "name": "warehouse", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "counts", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Draft Stock Reconciliation from counted quantities", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "Draft Stock Reconciliation from counted quantities. Not submitted.", "operationId": "vm_erp.vm_erp.lager.api.create_reconciliation", "requestBody": { "content": { "application/json": { "schema": { "properties": { "counts": { "description": "", "type": "string" }, "warehouse": { "description": "", "type": "string" } }, "required": [ "warehouse", "counts" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Draft Stock Reconciliation from counted quantities", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.lager.api.create_transfer": { "get": { "description": "Draft Stock Entry (Material Transfer). Not submitted.", "operationId": "vm_erp.vm_erp.lager.api.create_transfer", "parameters": [ { "description": "", "in": "query", "name": "from_warehouse", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "to_warehouse", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "lines", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Draft Stock Entry (Material Transfer)", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "Draft Stock Entry (Material Transfer). Not submitted.", "operationId": "vm_erp.vm_erp.lager.api.create_transfer", "requestBody": { "content": { "application/json": { "schema": { "properties": { "from_warehouse": { "description": "", "type": "string" }, "lines": { "description": "", "type": "string" }, "to_warehouse": { "description": "", "type": "string" } }, "required": [ "from_warehouse", "to_warehouse", "lines" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Draft Stock Entry (Material Transfer)", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.lager.api.get_count_list": { "get": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.get_count_list", "parameters": [ { "description": "", "in": "query", "name": "warehouse", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_count_list", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.get_count_list", "requestBody": { "content": { "application/json": { "schema": { "properties": { "warehouse": { "description": "", "type": "string" } }, "required": [ "warehouse" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_count_list", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.get_open_orders": { "get": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.get_open_orders", "parameters": [ { "description": "", "in": "query", "name": "supplier", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_open_orders", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.get_open_orders", "requestBody": { "content": { "application/json": { "schema": { "properties": { "supplier": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_open_orders", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.get_receipt_data": { "get": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.get_receipt_data", "parameters": [ { "description": "", "in": "query", "name": "po", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_receipt_data", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.get_receipt_data", "requestBody": { "content": { "application/json": { "schema": { "properties": { "po": { "description": "", "type": "string" } }, "required": [ "po" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_receipt_data", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.get_tracked_info": { "get": { "description": "Welche der Artikel brauchen Charge oder Seriennummer.", "operationId": "vm_erp.vm_erp.lager.api.get_tracked_info", "parameters": [ { "description": "", "in": "query", "name": "item_codes", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Welche der Artikel brauchen Charge oder Seriennummer.", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Welche der Artikel brauchen Charge oder Seriennummer.", "operationId": "vm_erp.vm_erp.lager.api.get_tracked_info", "requestBody": { "content": { "application/json": { "schema": { "properties": { "item_codes": { "description": "", "type": "string" } }, "required": [ "item_codes" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Welche der Artikel brauchen Charge oder Seriennummer.", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.get_warehouses": { "get": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.get_warehouses", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_warehouses", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.get_warehouses", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_warehouses", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.lookup_item": { "get": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.lookup_item", "parameters": [ { "description": "", "in": "query", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "lookup_item", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.lager.api.lookup_item", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "", "type": "string" } }, "required": [ "code" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "lookup_item", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.preview_count": { "get": { "description": "Difference preview for {item_code: counted_qty}. Writes nothing.", "operationId": "vm_erp.vm_erp.lager.api.preview_count", "parameters": [ { "description": "", "in": "query", "name": "warehouse", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "counts", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Difference preview for {item_code: counted_qty}", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Difference preview for {item_code: counted_qty}. Writes nothing.", "operationId": "vm_erp.vm_erp.lager.api.preview_count", "requestBody": { "content": { "application/json": { "schema": { "properties": { "counts": { "description": "", "type": "string" }, "warehouse": { "description": "", "type": "string" } }, "required": [ "warehouse", "counts" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Difference preview for {item_code: counted_qty}", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.scan": { "get": { "description": "Resolve one scan to an item (barcode > item code > supplier part number).", "operationId": "vm_erp.vm_erp.lager.api.scan", "parameters": [ { "description": "", "in": "query", "name": "code", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "supplier", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Resolve one scan to an item (barcode > item code > supplier part number).", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Resolve one scan to an item (barcode > item code > supplier part number).", "operationId": "vm_erp.vm_erp.lager.api.scan", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "", "type": "string" }, "supplier": { "description": "", "type": "string" } }, "required": [ "code" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Resolve one scan to an item (barcode > item code > supplier part number).", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lager.api.scan_charge": { "get": { "description": "Felder aus einem GS1-Scan: Charge, Verfall, Seriennummer, GTIN. Bucht nichts.", "operationId": "vm_erp.vm_erp.lager.api.scan_charge", "parameters": [ { "description": "", "in": "query", "name": "code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Felder aus einem GS1-Scan: Charge, Verfall, Seriennummer, GTIN", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Felder aus einem GS1-Scan: Charge, Verfall, Seriennummer, GTIN. Bucht nichts.", "operationId": "vm_erp.vm_erp.lager.api.scan_charge", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "", "type": "string" } }, "required": [ "code" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Felder aus einem GS1-Scan: Charge, Verfall, Seriennummer, GTIN", "tags": [ "Lager mobil" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lieferantenrueckgabe.api.get_aufgaben": { "get": { "description": "Reine Funktion fuer die Arbeitsliste: nur die Zeilen \"Gutschrift fehlt\".", "operationId": "vm_erp.vm_erp.lieferantenrueckgabe.api.get_aufgaben", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Reine Funktion fuer die Arbeitsliste: nur die Zeilen \"Gutschrift fehlt\".", "tags": [ "Lieferantenrückgabe" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Reine Funktion fuer die Arbeitsliste: nur die Zeilen \"Gutschrift fehlt\".", "operationId": "vm_erp.vm_erp.lieferantenrueckgabe.api.get_aufgaben", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Reine Funktion fuer die Arbeitsliste: nur die Zeilen \"Gutschrift fehlt\".", "tags": [ "Lieferantenrückgabe" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lieferantenrueckgabe.api.get_uebersicht": { "get": { "description": "Liste mit Gutschriftsstatus (Ampel) und die Aufgaben \"Gutschrift fehlt\".", "operationId": "vm_erp.vm_erp.lieferantenrueckgabe.api.get_uebersicht", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Liste mit Gutschriftsstatus (Ampel) und die Aufgaben \"Gutschrift fehlt\".", "tags": [ "Lieferantenrückgabe" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Liste mit Gutschriftsstatus (Ampel) und die Aufgaben \"Gutschrift fehlt\".", "operationId": "vm_erp.vm_erp.lieferantenrueckgabe.api.get_uebersicht", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Liste mit Gutschriftsstatus (Ampel) und die Aufgaben \"Gutschrift fehlt\".", "tags": [ "Lieferantenrückgabe" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.lieferantenrueckgabe.api.neu": { "post": { "description": "Entwurf aus einem Wareneingang. positionen: JSON [{\"artikel\",\"menge\"}].", "operationId": "vm_erp.vm_erp.lieferantenrueckgabe.api.neu", "requestBody": { "content": { "application/json": { "schema": { "properties": { "grund": { "description": "", "type": "string" }, "positionen": { "description": "", "type": "string" }, "wareneingang": { "description": "", "type": "string" } }, "required": [ "wareneingang", "positionen", "grund" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Entwurf aus einem Wareneingang", "tags": [ "Lieferantenrückgabe" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Purchase User", "Purchase Manager", "Stock User", "Stock Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.mahnwesen.api.mahnbeleg_pdf": { "post": { "description": "PDF eines Mahnbeleg-ENTWURFS mit dem Standarddruckformat, als private Datei am Beleg. Nur auf Anforderung, nie automatisch.", "operationId": "vm_erp.vm_erp.mahnwesen.api.mahnbeleg_pdf", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "PDF eines Mahnbeleg-ENTWURFS mit dem Standarddruckformat, als private Datei am Beleg", "tags": [ "Mahnwesen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.mahnwesen.api.mahnlauf_verwerfen": { "post": { "description": "Loescht Entwuerfe EINES Laufs, die der Aufrufer selbst angelegt hat. Eingereichte oder stornierte Belege bleiben unberuehrt.", "operationId": "vm_erp.vm_erp.mahnwesen.api.mahnlauf_verwerfen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "lauf_kennung": { "description": "", "type": "string" }, "namen": { "description": "", "type": "string" } }, "required": [ "lauf_kennung", "namen" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Loescht Entwuerfe EINES Laufs, die der Aufrufer selbst angelegt hat", "tags": [ "Mahnwesen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.mahnwesen.api.mahnlauf_vorbereiten": { "post": { "description": "Legt je ausgewaehltem Kunden einen Mahnbeleg (Dunning) als ENTWURF an, docstatus bleibt 0. Reicht nichts ein, versendet nichts. Zweiter Lauf legt nichts doppelt an (Schluessel Rechnung plus Stufe). Gibt Laufkennung, angelegte Namen und das Abbruchprotokoll zurueck.", "operationId": "vm_erp.vm_erp.mahnwesen.api.mahnlauf_vorbereiten", "requestBody": { "content": { "application/json": { "schema": { "properties": { "kunden": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" } }, "required": [ "stichtag", "kunden" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt je ausgewaehltem Kunden einen Mahnbeleg (Dunning) als ENTWURF an, docstatus bleibt 0", "tags": [ "Mahnwesen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.mahnwesen.api.mahntext": { "get": { "description": "Draft text for one candidate of the current preview. `kunde` is the customer id.", "operationId": "vm_erp.vm_erp.mahnwesen.api.mahntext", "parameters": [ { "description": "", "in": "query", "name": "kunde", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "stufe", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "stichtag", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Draft text for one candidate of the current preview", "tags": [ "Mahnwesen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Draft text for one candidate of the current preview. `kunde` is the customer id.", "operationId": "vm_erp.vm_erp.mahnwesen.api.mahntext", "requestBody": { "content": { "application/json": { "schema": { "properties": { "kunde": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" }, "stufe": { "description": "", "type": "string" } }, "required": [ "kunde", "stufe" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Draft text for one candidate of the current preview", "tags": [ "Mahnwesen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.mahnwesen.api.sperre_aufheben": { "post": { "description": "Hebt eine Sperre auf, indem das Ablaufdatum auf gestern gesetzt wird. Die Standard-Versionierung haelt Wer und Wann fest.", "operationId": "vm_erp.vm_erp.mahnwesen.api.sperre_aufheben", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Hebt eine Sperre auf, indem das Ablaufdatum auf gestern gesetzt wird", "tags": [ "Mahnwesen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.mahnwesen.api.sperre_setzen": { "post": { "description": "Manuelle Mahnsperre mit Pflichtgrund und Ablaufdatum. Sie gilt bis einschliesslich `gueltig_bis` und wird danach ignoriert.", "operationId": "vm_erp.vm_erp.mahnwesen.api.sperre_setzen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "grund": { "description": "", "type": "string" }, "gueltig_bis": { "description": "", "type": "string" }, "kunde": { "description": "", "type": "string" } }, "required": [ "kunde", "grund", "gueltig_bis" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Manuelle Mahnsperre mit Pflichtgrund und Ablaufdatum", "tags": [ "Mahnwesen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.mahnwesen.api.vorschau": { "get": { "description": "", "operationId": "vm_erp.vm_erp.mahnwesen.api.vorschau", "parameters": [ { "description": "", "in": "query", "name": "stichtag", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorschau", "tags": [ "Mahnwesen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.mahnwesen.api.vorschau", "requestBody": { "content": { "application/json": { "schema": { "properties": { "stichtag": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorschau", "tags": [ "Mahnwesen" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.api.confirm_import": { "post": { "description": "Writes draft Sales Orders for ready, new orders. Only after the user confirmed the preview.", "operationId": "vm_erp.vm_erp.marktplatz.api.confirm_import", "requestBody": { "content": { "application/json": { "schema": { "properties": { "channel": { "description": "", "type": "string" }, "payload": { "description": "", "type": "string" } }, "required": [ "channel", "payload" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Writes draft Sales Orders for ready, new orders", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.marktplatz.api.deadline_card": { "get": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.api.deadline_card", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "deadline_card", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.api.deadline_card", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "deadline_card", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.api.import_settlement": { "post": { "description": "Stores the payout with differences and booking SUGGESTIONS. Books nothing.", "operationId": "vm_erp.vm_erp.marktplatz.api.import_settlement", "requestBody": { "content": { "application/json": { "schema": { "properties": { "channel": { "description": "", "type": "string" }, "text": { "description": "", "type": "string" } }, "required": [ "channel", "text" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Stores the payout with differences and booking SUGGESTIONS", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.marktplatz.api.journal_entries": { "get": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.api.journal_entries", "parameters": [ { "description": "", "in": "query", "name": "channel", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "journal_entries", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.api.journal_entries", "requestBody": { "content": { "application/json": { "schema": { "properties": { "channel": { "description": "", "type": "string" }, "limit": { "description": "", "type": "integer" }, "status": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "journal_entries", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.api.journal_retry": { "post": { "description": "Manual retry of one entry. Idempotent: an already delivered key is never sent again.", "operationId": "vm_erp.vm_erp.marktplatz.api.journal_retry", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Manual retry of one entry", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.marktplatz.api.preview_import": { "post": { "description": "Dry run: new, skipped and unmatched lines. Writes nothing.", "operationId": "vm_erp.vm_erp.marktplatz.api.preview_import", "requestBody": { "content": { "application/json": { "schema": { "properties": { "channel": { "description": "", "type": "string" }, "payload": { "description": "", "type": "string" } }, "required": [ "channel", "payload" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Dry run: new, skipped and unmatched lines", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.kanalbilanz_api.get_kanalbilanz": { "get": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.kanalbilanz_api.get_kanalbilanz", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_kanalbilanz", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.kanalbilanz_api.get_kanalbilanz", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_kanalbilanz", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.auszahlungen": { "get": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.auszahlungen", "parameters": [ { "description": "", "in": "query", "name": "kanal", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "auszahlungen", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.auszahlungen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "kanal": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "auszahlungen", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.differenz_ursachen": { "get": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.differenz_ursachen", "parameters": [ { "description": "", "in": "query", "name": "payout_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "differenz_ursachen", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.differenz_ursachen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "payout_id": { "description": "", "type": "string" } }, "required": [ "payout_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "differenz_ursachen", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.fehlergruppen": { "get": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.fehlergruppen", "parameters": [ { "description": "", "in": "query", "name": "ursache", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "fehlergruppen", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.fehlergruppen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ursache": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "fehlergruppen", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.journal_suchen": { "get": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.journal_suchen", "parameters": [ { "description": "", "in": "query", "name": "abfrage", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "kanal", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "journal_suchen", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.journal_suchen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "abfrage": { "description": "", "type": "string" }, "kanal": { "description": "", "type": "string" } }, "required": [ "abfrage" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "journal_suchen", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.mapping_vorschlag": { "post": { "description": "Nur ein Datensatz-Vorschlag. Gespeichert wird erst im Formular, nach Bestätigung.", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.mapping_vorschlag", "requestBody": { "content": { "application/json": { "schema": { "properties": { "channel_sku": { "description": "", "type": "string" }, "item_code": { "description": "", "type": "string" }, "kanal": { "description": "", "type": "string" } }, "required": [ "kanal", "channel_sku", "item_code" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Nur ein Datensatz-Vorschlag", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.probelauf": { "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.probelauf", "requestBody": { "content": { "application/json": { "schema": { "properties": { "kanal": { "description": "", "type": "string" }, "rohdaten": { "description": "", "type": "string" } }, "required": [ "kanal", "rohdaten" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "probelauf", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.wiederholen": { "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.wiederholen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ursache": { "description": "", "type": "string" } }, "required": [ "ursache" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "wiederholen", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.woche": { "get": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.woche", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "woche", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.woche", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "woche", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.marktplatz.vorschau_api.zuordnen_liste": { "post": { "description": "", "operationId": "vm_erp.vm_erp.marktplatz.vorschau_api.zuordnen_liste", "requestBody": { "content": { "application/json": { "schema": { "properties": { "kanal": { "description": "", "type": "string" }, "rohdaten": { "description": "", "type": "string" } }, "required": [ "kanal", "rohdaten" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "zuordnen_liste", "tags": [ "Marktplätze" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock User", "Stock Manager", "Accounts User", "Accounts Manager", "System Manager" ], [ "Sales Manager", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.api.parallellauf_csv": { "post": { "description": "Wie parallellauf_vergleich, liefert die Abweichungsliste als CSV-Text (jede Zelle durch csv_zelle).", "operationId": "vm_erp.vm_erp.migration.api.parallellauf_csv", "requestBody": { "content": { "application/json": { "schema": { "properties": { "quelle_csv": { "description": "", "type": "string" }, "schwelle": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" } }, "required": [ "stichtag" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Wie parallellauf_vergleich, liefert die Abweichungsliste als CSV-Text (jede Zelle durch csv_zelle).", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.api.parallellauf_vergleich": { "post": { "description": "Vergleicht den hochgeladenen Altsystem-Stand (CSV-Text) mit VM ERP. Nur lesend; POST nur wegen der Dateigroesse (bis 5 MB).", "operationId": "vm_erp.vm_erp.migration.api.parallellauf_vergleich", "requestBody": { "content": { "application/json": { "schema": { "properties": { "quelle_csv": { "description": "", "type": "string" }, "schwelle": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" } }, "required": [ "stichtag" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Vergleicht den hochgeladenen Altsystem-Stand (CSV-Text) mit VM ERP", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.api.plan": { "get": { "description": "", "operationId": "vm_erp.vm_erp.migration.api.plan", "parameters": [ { "description": "", "in": "query", "name": "start", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "fenster", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "kanaele", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "plan", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.migration.api.plan", "requestBody": { "content": { "application/json": { "schema": { "properties": { "fenster": { "description": "", "type": "string" }, "kanaele": { "description": "", "type": "string" }, "start": { "description": "", "type": "string" } }, "required": [ "start", "fenster", "kanaele" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "plan", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.api.suche": { "get": { "description": "Findet den neuen Beleg zu einer alten Altsystem-Nummer (nur Belege mit Leserecht).", "operationId": "vm_erp.vm_erp.migration.api.suche", "parameters": [ { "description": "", "in": "query", "name": "eingabe", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Findet den neuen Beleg zu einer alten Altsystem-Nummer (nur Belege mit Leserecht).", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Findet den neuen Beleg zu einer alten Altsystem-Nummer (nur Belege mit Leserecht).", "operationId": "vm_erp.vm_erp.migration.api.suche", "requestBody": { "content": { "application/json": { "schema": { "properties": { "eingabe": { "description": "", "type": "string" } }, "required": [ "eingabe" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Findet den neuen Beleg zu einer alten Altsystem-Nummer (nur Belege mit Leserecht).", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.freifelder_api.freifelder_anlegen": { "post": { "description": "Legt die Freifelder eines Bereichs (artikel, adresse, alle) als Custom Fields an; `felder` (Liste von Feldnamen) schraenkt ein.", "operationId": "vm_erp.vm_erp.migration.freifelder_api.freifelder_anlegen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bereich": { "description": "", "type": "string" }, "felder": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt die Freifelder eines Bereichs (artikel, adresse, alle) als Custom Fields an; `felder` (Liste von Feldnamen) schraenkt ein.", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.migration.freifelder_api.freifelder_fuellen": { "post": { "description": "Schreibt die Werte aus dem Export in die Freifelder. Erst wird alles geprueft (Felder angelegt, Schluessel vorhanden), dann geschrieben.", "operationId": "vm_erp.vm_erp.migration.freifelder_api.freifelder_fuellen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bereich": { "description": "", "type": "string" }, "quelle_csv": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Schreibt die Werte aus dem Export in die Freifelder", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.migration.freifelder_api.freifelder_vorschau": { "get": { "description": "Zeigt je Freifeld Zielfeld, Typ, Spalte, Reihenfolge und ob es schon angelegt ist. Liest nur.", "operationId": "vm_erp.vm_erp.migration.freifelder_api.freifelder_vorschau", "parameters": [ { "description": "", "in": "query", "name": "bereich", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Zeigt je Freifeld Zielfeld, Typ, Spalte, Reihenfolge und ob es schon angelegt ist", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Zeigt je Freifeld Zielfeld, Typ, Spalte, Reihenfolge und ob es schon angelegt ist. Liest nur.", "operationId": "vm_erp.vm_erp.migration.freifelder_api.freifelder_vorschau", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bereich": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Zeigt je Freifeld Zielfeld, Typ, Spalte, Reihenfolge und ob es schon angelegt ist", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.freifelder_api.freifelder_zaehlpruefung": { "post": { "description": "Zaehlt je Freifeld die nicht leeren Werte im Export und in VM ERP und listet jede Abweichung als Befund. Liest nur.", "operationId": "vm_erp.vm_erp.migration.freifelder_api.freifelder_zaehlpruefung", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bereich": { "description": "", "type": "string" }, "quelle_csv": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Zaehlt je Freifeld die nicht leeren Werte im Export und in VM ERP und listet jede Abweichung als Befund", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_kontinuitaet": { "get": { "description": "Prueft Luecke, Dublette und Praefixwechsel zwischen letzter alter und erster neuer Nummer. Liest nichts aus der Datenbank.", "operationId": "vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_kontinuitaet", "parameters": [ { "description": "", "in": "query", "name": "alt_letzte", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "neu_erste", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft Luecke, Dublette und Praefixwechsel zwischen letzter alter und erster neuer Nummer", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Prueft Luecke, Dublette und Praefixwechsel zwischen letzter alter und erster neuer Nummer. Liest nichts aus der Datenbank.", "operationId": "vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_kontinuitaet", "requestBody": { "content": { "application/json": { "schema": { "properties": { "alt_letzte": { "description": "", "type": "string" }, "neu_erste": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft Luecke, Dublette und Praefixwechsel zwischen letzter alter und erster neuer Nummer", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_setzen": { "post": { "description": "Setzt die Serie eines Kreises so, dass die naechste Nummer auf die letzte Altsystem-Nummer folgt.\n\nOhne `bestaetigt` wird nur die Vorschau geliefert (Pflichtschritt davor). Startwert unter der hoechsten vorhandenen Nummer wird abgelehnt. `letzte` ist optional (Vorgabe: Inventurwert), bei Kreisen ohne Voreinstellung ist `praefix` Pflicht.", "operationId": "vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_setzen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bestaetigt": { "description": "", "type": "string" }, "kreis": { "description": "", "type": "string" }, "letzte": { "description": "", "type": "string" }, "praefix": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Setzt die Serie eines Kreises so, dass die naechste Nummer auf die letzte Altsystem-Nummer folgt.", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_vorschau": { "get": { "description": "Vorschau je Kreis: letzte alte Nummer, neue erste Nummer, Zustand der Serie. Liest nur.", "operationId": "vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_vorschau", "parameters": [ { "description": "", "in": "query", "name": "quelle", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Vorschau je Kreis: letzte alte Nummer, neue erste Nummer, Zustand der Serie", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Vorschau je Kreis: letzte alte Nummer, neue erste Nummer, Zustand der Serie. Liest nur.", "operationId": "vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_vorschau", "requestBody": { "content": { "application/json": { "schema": { "properties": { "quelle": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Vorschau je Kreis: letzte alte Nummer, neue erste Nummer, Zustand der Serie", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.probelauf_api.probelauf_bericht": { "get": { "description": "Befunde und Abgleich eines gespeicherten Laufs. Nur lesend.", "operationId": "vm_erp.vm_erp.migration.probelauf_api.probelauf_bericht", "parameters": [ { "description": "", "in": "query", "name": "lauf_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Befunde und Abgleich eines gespeicherten Laufs", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Befunde und Abgleich eines gespeicherten Laufs. Nur lesend.", "operationId": "vm_erp.vm_erp.migration.probelauf_api.probelauf_bericht", "requestBody": { "content": { "application/json": { "schema": { "properties": { "lauf_id": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Befunde und Abgleich eines gespeicherten Laufs", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.probelauf_api.probelauf_csv": { "get": { "description": "Abweichungen eines Laufs als CSV-Text (jede Zelle durch csv_zelle). Nur lesend.", "operationId": "vm_erp.vm_erp.migration.probelauf_api.probelauf_csv", "parameters": [ { "description": "", "in": "query", "name": "lauf_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Abweichungen eines Laufs als CSV-Text (jede Zelle durch csv_zelle)", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Abweichungen eines Laufs als CSV-Text (jede Zelle durch csv_zelle). Nur lesend.", "operationId": "vm_erp.vm_erp.migration.probelauf_api.probelauf_csv", "requestBody": { "content": { "application/json": { "schema": { "properties": { "lauf_id": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Abweichungen eines Laufs als CSV-Text (jede Zelle durch csv_zelle)", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.probelauf_api.probelauf_laeufe": { "get": { "description": "Die letzten 50 Laeufe. Nur lesend.", "operationId": "vm_erp.vm_erp.migration.probelauf_api.probelauf_laeufe", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Die letzten 50 Laeufe", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Die letzten 50 Laeufe. Nur lesend.", "operationId": "vm_erp.vm_erp.migration.probelauf_api.probelauf_laeufe", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Die letzten 50 Laeufe", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.migration.probelauf_api.probelauf_rueckgaengig": { "post": { "description": "Entfernt genau die Zeilen dieses Laufs: nur Dokumente aus der Liste des Laufs, deren Markierung die Lauf-ID traegt. Nur auf einer Demo-Site, idempotent.", "operationId": "vm_erp.vm_erp.migration.probelauf_api.probelauf_rueckgaengig", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bestaetigt": { "description": "", "type": "string" }, "lauf_id": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Entfernt genau die Zeilen dieses Laufs: nur Dokumente aus der Liste des Laufs, deren Markierung die Lauf-ID traegt", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.migration.probelauf_api.probelauf_schreiben": { "post": { "description": "Legt die neuen Kunden und Artikel an, jeden mit der Lauf-ID. Nur auf einer Demo-Site. Ohne `bestaetigt` kommt nur die Vorschau.", "operationId": "vm_erp.vm_erp.migration.probelauf_api.probelauf_schreiben", "requestBody": { "content": { "application/json": { "schema": { "properties": { "artikel": { "description": "", "type": "string" }, "bestaetigt": { "description": "", "type": "string" }, "bestand": { "description": "", "type": "string" }, "kunden": { "description": "", "type": "string" }, "offene_posten": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" }, "umsatz": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt die neuen Kunden und Artikel an, jeden mit der Lauf-ID", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.migration.probelauf_api.probelauf_trockenlauf": { "post": { "description": "Liest die fuenf Dateien und zeigt, was ein Lauf anlegen wuerde und wo es Abweichungen gibt. Schreibt nichts (POST nur wegen der Dateigroesse).", "operationId": "vm_erp.vm_erp.migration.probelauf_api.probelauf_trockenlauf", "requestBody": { "content": { "application/json": { "schema": { "properties": { "artikel": { "description": "", "type": "string" }, "bestand": { "description": "", "type": "string" }, "kunden": { "description": "", "type": "string" }, "offene_posten": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" }, "umsatz": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Liest die fuenf Dateien und zeigt, was ein Lauf anlegen wuerde und wo es Abweichungen gibt", "tags": [ "Umzug und Parallellauf" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.nachweis.api.get_aenderungen": { "get": { "description": "Aenderungsprotokoll eines Belegs. Ohne Angabe: Beispieldaten.", "operationId": "vm_erp.vm_erp.nachweis.api.get_aenderungen", "parameters": [ { "description": "", "in": "query", "name": "doctype", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "name", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "als_csv", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Aenderungsprotokoll eines Belegs", "tags": [ "Prüfer-Nachweis" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Aenderungsprotokoll eines Belegs. Ohne Angabe: Beispieldaten.", "operationId": "vm_erp.vm_erp.nachweis.api.get_aenderungen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "als_csv": { "description": "", "type": "integer" }, "doctype": { "description": "", "type": "string" }, "name": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Aenderungsprotokoll eines Belegs", "tags": [ "Prüfer-Nachweis" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.nachweis.api.get_archivpruefung": { "get": { "description": "Prueft die Hashes jetzt (nur Lesen).", "operationId": "vm_erp.vm_erp.nachweis.api.get_archivpruefung", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft die Hashes jetzt (nur Lesen).", "tags": [ "Prüfer-Nachweis" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Prueft die Hashes jetzt (nur Lesen).", "operationId": "vm_erp.vm_erp.nachweis.api.get_archivpruefung", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft die Hashes jetzt (nur Lesen).", "tags": [ "Prüfer-Nachweis" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.nachweis.api.get_audit": { "get": { "description": "Anmeldungen (Activity Log) und Rechteaenderungen (Versionen von User / Has Role) im Zeitraum. Rolle: Auditor, Accounts Manager, System Manager; IP-Adressen nur fuer System Manager (SEC-12).", "operationId": "vm_erp.vm_erp.nachweis.api.get_audit", "parameters": [ { "description": "", "in": "query", "name": "von", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "bis", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "als_csv", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Anmeldungen (Activity Log) und Rechteaenderungen (Versionen von User / Has Role) im Zeitraum", "tags": [ "Prüfer-Nachweis" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Auditor", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Anmeldungen (Activity Log) und Rechteaenderungen (Versionen von User / Has Role) im Zeitraum. Rolle: Auditor, Accounts Manager, System Manager; IP-Adressen nur fuer System Manager (SEC-12).", "operationId": "vm_erp.vm_erp.nachweis.api.get_audit", "requestBody": { "content": { "application/json": { "schema": { "properties": { "als_csv": { "description": "", "type": "integer" }, "bis": { "description": "", "type": "string" }, "von": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Anmeldungen (Activity Log) und Rechteaenderungen (Versionen von User / Has Role) im Zeitraum", "tags": [ "Prüfer-Nachweis" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Auditor", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.nachweis.api.get_vier_augen_regeln": { "get": { "description": "", "operationId": "vm_erp.vm_erp.nachweis.api.get_vier_augen_regeln", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_vier_augen_regeln", "tags": [ "Prüfer-Nachweis" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.nachweis.api.get_vier_augen_regeln", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_vier_augen_regeln", "tags": [ "Prüfer-Nachweis" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.preise.api.get_staffelhinweis": { "get": { "description": "", "operationId": "vm_erp.vm_erp.preise.api.get_staffelhinweis", "parameters": [ { "description": "", "in": "query", "name": "menge", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "staffeln", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_staffelhinweis", "tags": [ "Preislisten" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.preise.api.get_staffelhinweis", "requestBody": { "content": { "application/json": { "schema": { "properties": { "menge": { "description": "", "type": "string" }, "staffeln": { "description": "", "type": "string" } }, "required": [ "menge", "staffeln" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_staffelhinweis", "tags": [ "Preislisten" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.preise.api.get_vergleich": { "get": { "description": "", "operationId": "vm_erp.vm_erp.preise.api.get_vergleich", "parameters": [ { "description": "", "in": "query", "name": "artikelgruppe", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_vergleich", "tags": [ "Preislisten" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.preise.api.get_vergleich", "requestBody": { "content": { "application/json": { "schema": { "properties": { "artikelgruppe": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_vergleich", "tags": [ "Preislisten" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.preise.api.import_vorschau": { "post": { "description": "Preview only. Nothing is saved.", "operationId": "vm_erp.vm_erp.preise.api.import_vorschau", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bestand": { "description": "", "type": "string" }, "standard_ab": { "description": "", "type": "string" }, "zeilen": { "description": "", "type": "string" } }, "required": [ "bestand", "zeilen" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Preview only", "tags": [ "Preislisten" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales User", "Sales Manager", "Stock Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.qualitaet.api.run_check": { "get": { "description": "Report \"Datenqualitaet\". Read-only; merging proposals are previews.", "operationId": "vm_erp.vm_erp.qualitaet.api.run_check", "parameters": [ { "description": "", "in": "query", "name": "doctype", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Report \"Datenqualitaet\"", "tags": [ "Datenqualität" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock Manager", "Sales Manager", "Accounts Manager", "System Manager", "Demo Leser" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Report \"Datenqualitaet\". Read-only; merging proposals are previews.", "operationId": "vm_erp.vm_erp.qualitaet.api.run_check", "requestBody": { "content": { "application/json": { "schema": { "properties": { "doctype": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Report \"Datenqualitaet\"", "tags": [ "Datenqualität" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock Manager", "Sales Manager", "Accounts Manager", "System Manager", "Demo Leser" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.rahmen.api.get_rahmen": { "get": { "description": "Rahmenauftraege mit Restmenge, Restlaufzeit und Warnung kurz vor Ablauf.", "operationId": "vm_erp.vm_erp.rahmen.api.get_rahmen", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Rahmenauftraege mit Restmenge, Restlaufzeit und Warnung kurz vor Ablauf.", "tags": [ "Rahmenaufträge" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Rahmenauftraege mit Restmenge, Restlaufzeit und Warnung kurz vor Ablauf.", "operationId": "vm_erp.vm_erp.rahmen.api.get_rahmen", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Rahmenauftraege mit Restmenge, Restlaufzeit und Warnung kurz vor Ablauf.", "tags": [ "Rahmenaufträge" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.rahmen.api.pruefe_abruf": { "get": { "description": "Prueft nur, bucht nichts.", "operationId": "vm_erp.vm_erp.rahmen.api.pruefe_abruf", "parameters": [ { "description": "", "in": "query", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "artikel", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "menge", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft nur, bucht nichts.", "tags": [ "Rahmenaufträge" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Prueft nur, bucht nichts.", "operationId": "vm_erp.vm_erp.rahmen.api.pruefe_abruf", "requestBody": { "content": { "application/json": { "schema": { "properties": { "artikel": { "description": "", "type": "string" }, "menge": { "description": "", "type": "string" }, "name": { "description": "", "type": "string" } }, "required": [ "name", "artikel", "menge" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Prueft nur, bucht nichts.", "tags": [ "Rahmenaufträge" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.retouren.api.book_receipt": { "post": { "description": "Book the goods receipt: received_qty and condition per line, status Eingegangen.", "operationId": "vm_erp.vm_erp.retouren.api.book_receipt", "requestBody": { "content": { "application/json": { "schema": { "properties": { "conditions": { "description": "", "type": "string" }, "received": { "description": "", "type": "string" }, "retoure": { "description": "", "type": "string" } }, "required": [ "retoure", "received" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Book the goods receipt: received_qty and condition per line, status Eingegangen.", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.retouren.api.close_retoure": { "get": { "description": "", "operationId": "vm_erp.vm_erp.retouren.api.close_retoure", "parameters": [ { "description": "", "in": "query", "name": "retoure", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "close_retoure", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.retouren.api.close_retoure", "requestBody": { "content": { "application/json": { "schema": { "properties": { "retoure": { "description": "", "type": "string" } }, "required": [ "retoure" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "close_retoure", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.retouren.api.find_retoure": { "get": { "description": "Resolve a scanned reference (RET-00001) to an open Retoure.", "operationId": "vm_erp.vm_erp.retouren.api.find_retoure", "parameters": [ { "description": "", "in": "query", "name": "scan", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Resolve a scanned reference (RET-00001) to an open Retoure.", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Resolve a scanned reference (RET-00001) to an open Retoure.", "operationId": "vm_erp.vm_erp.retouren.api.find_retoure", "requestBody": { "content": { "application/json": { "schema": { "properties": { "scan": { "description": "", "type": "string" } }, "required": [ "scan" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Resolve a scanned reference (RET-00001) to an open Retoure.", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.retouren.api.get_receipt_data": { "get": { "description": "Header and lines for the Wareneingang. Only a draft in status Angemeldet or Eingegangen.", "operationId": "vm_erp.vm_erp.retouren.api.get_receipt_data", "parameters": [ { "description": "", "in": "query", "name": "retoure", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Header and lines for the Wareneingang", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "Header and lines for the Wareneingang. Only a draft in status Angemeldet or Eingegangen.", "operationId": "vm_erp.vm_erp.retouren.api.get_receipt_data", "requestBody": { "content": { "application/json": { "schema": { "properties": { "retoure": { "description": "", "type": "string" } }, "required": [ "retoure" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Header and lines for the Wareneingang", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.retouren.api.make_credit_note": { "get": { "description": "", "operationId": "vm_erp.vm_erp.retouren.api.make_credit_note", "parameters": [ { "description": "", "in": "query", "name": "retoure", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "make_credit_note", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.retouren.api.make_credit_note", "requestBody": { "content": { "application/json": { "schema": { "properties": { "retoure": { "description": "", "type": "string" } }, "required": [ "retoure" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "make_credit_note", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.retouren.api.make_return_delivery_note": { "get": { "description": "", "operationId": "vm_erp.vm_erp.retouren.api.make_return_delivery_note", "parameters": [ { "description": "", "in": "query", "name": "retoure", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "make_return_delivery_note", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.retouren.api.make_return_delivery_note", "requestBody": { "content": { "application/json": { "schema": { "properties": { "retoure": { "description": "", "type": "string" } }, "required": [ "retoure" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "make_return_delivery_note", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.retouren.api.mark_checked": { "post": { "description": "Eingegangen -> Geprüft once every line has condition and decision.", "operationId": "vm_erp.vm_erp.retouren.api.mark_checked", "requestBody": { "content": { "application/json": { "schema": { "properties": { "retoure": { "description": "", "type": "string" } }, "required": [ "retoure" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Eingegangen -> Geprüft once every line has condition and decision.", "tags": [ "Retouren" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.retouren.portal.lookup": { "post": { "description": "Verify the caller and list what may be returned (item, name, quantity). Nothing else.", "operationId": "vm_erp.vm_erp.retouren.portal.lookup", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "description": "", "type": "string" }, "order_no": { "description": "", "type": "string" }, "postcode": { "description": "", "type": "string" } }, "required": [ "order_no", "email", "postcode" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ {} ], "summary": "Verify the caller and list what may be returned (item, name, quantity)", "tags": [ "Retouren" ], "x-vm-gast": true, "x-vm-rollen": [], "x-vm-zugriff": "Öffentlich (ohne Anmeldung)" } }, "/api/method/vm_erp.vm_erp.retouren.portal.submit": { "post": { "description": "Create the Retoure (draft, status Angemeldet) and return its reference number.", "operationId": "vm_erp.vm_erp.retouren.portal.submit", "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "description": "", "type": "string" }, "lines": { "description": "", "type": "string" }, "note": { "description": "", "type": "string" }, "order_no": { "description": "", "type": "string" }, "postcode": { "description": "", "type": "string" } }, "required": [ "order_no", "email", "postcode", "lines" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ {} ], "summary": "Create the Retoure (draft, status Angemeldet) and return its reference number.", "tags": [ "Retouren" ], "x-vm-gast": true, "x-vm-rollen": [], "x-vm-zugriff": "Öffentlich (ohne Anmeldung)" } }, "/api/method/vm_erp.vm_erp.rueckverfolgung.api.csv_export": { "get": { "description": "CSV der Treffer. richtung: vorwaerts | rueckwaerts.", "operationId": "vm_erp.vm_erp.rueckverfolgung.api.csv_export", "parameters": [ { "description": "", "in": "query", "name": "richtung", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "beleg", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "charge", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "serie", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "item_code", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "CSV der Treffer", "tags": [ "Rückverfolgung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Rollengeschützt, Gast gesperrt" }, "post": { "description": "CSV der Treffer. richtung: vorwaerts | rueckwaerts.", "operationId": "vm_erp.vm_erp.rueckverfolgung.api.csv_export", "requestBody": { "content": { "application/json": { "schema": { "properties": { "beleg": { "description": "", "type": "string" }, "charge": { "description": "", "type": "string" }, "item_code": { "description": "", "type": "string" }, "richtung": { "description": "", "type": "string" }, "serie": { "description": "", "type": "string" } }, "required": [ "richtung" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "CSV der Treffer", "tags": [ "Rückverfolgung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Purchase User", "Purchase Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Rollengeschützt, Gast gesperrt" } }, "/api/method/vm_erp.vm_erp.rueckverfolgung.api.rueckwaerts": { "get": { "description": "", "operationId": "vm_erp.vm_erp.rueckverfolgung.api.rueckwaerts", "parameters": [ { "description": "", "in": "query", "name": "beleg", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "charge", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "serie", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "item_code", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "rueckwaerts", "tags": [ "Rückverfolgung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.rueckverfolgung.api.rueckwaerts", "requestBody": { "content": { "application/json": { "schema": { "properties": { "beleg": { "description": "", "type": "string" }, "charge": { "description": "", "type": "string" }, "item_code": { "description": "", "type": "string" }, "serie": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "rueckwaerts", "tags": [ "Rückverfolgung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.rueckverfolgung.api.vorwaerts": { "get": { "description": "", "operationId": "vm_erp.vm_erp.rueckverfolgung.api.vorwaerts", "parameters": [ { "description": "", "in": "query", "name": "charge", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "serie", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "item_code", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorwaerts", "tags": [ "Rückverfolgung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.rueckverfolgung.api.vorwaerts", "requestBody": { "content": { "application/json": { "schema": { "properties": { "charge": { "description": "", "type": "string" }, "item_code": { "description": "", "type": "string" }, "serie": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorwaerts", "tags": [ "Rückverfolgung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.selbstpruefung.api.status": { "get": { "description": "", "operationId": "vm_erp.vm_erp.selbstpruefung.api.status", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "status", "tags": [ "Selbstprüfung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.selbstpruefung.api.status", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "status", "tags": [ "Selbstprüfung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.sets.api.get_baubar": { "get": { "description": "Hinweis 'baubar: 12 (begrenzt durch GX41798)' fuer eine Artikel- oder Auftragszeile.", "operationId": "vm_erp.vm_erp.sets.api.get_baubar", "parameters": [ { "description": "", "in": "query", "name": "set_artikel", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "gewuenscht", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Hinweis 'baubar: 12 (begrenzt durch GX41798)' fuer eine Artikel- oder Auftragszeile.", "tags": [ "Set-Artikel" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Hinweis 'baubar: 12 (begrenzt durch GX41798)' fuer eine Artikel- oder Auftragszeile.", "operationId": "vm_erp.vm_erp.sets.api.get_baubar", "requestBody": { "content": { "application/json": { "schema": { "properties": { "gewuenscht": { "description": "", "type": "string" }, "set_artikel": { "description": "", "type": "string" } }, "required": [ "set_artikel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Hinweis 'baubar: 12 (begrenzt durch GX41798)' fuer eine Artikel- oder Auftragszeile.", "tags": [ "Set-Artikel" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.sets.api.neue_montage": { "post": { "description": "Legt einen Montage-Entwurf mit den Teilen an. Bucht nichts.", "operationId": "vm_erp.vm_erp.sets.api.neue_montage", "requestBody": { "content": { "application/json": { "schema": { "properties": { "menge": { "description": "", "type": "integer" }, "set_artikel": { "description": "", "type": "string" } }, "required": [ "set_artikel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt einen Montage-Entwurf mit den Teilen an", "tags": [ "Set-Artikel" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.sets.api.scanne": { "post": { "description": "Verbucht einen Scan auf die Teileliste (nur im Montage-Entwurf).", "operationId": "vm_erp.vm_erp.sets.api.scanne", "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "", "type": "string" }, "montage": { "description": "", "type": "string" } }, "required": [ "montage", "code" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Verbucht einen Scan auf die Teileliste (nur im Montage-Entwurf).", "tags": [ "Set-Artikel" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.shipping.api.create_shipment": { "post": { "description": "Create the Delivery Note (submitted) for the confirmed quantities and the Sendung record.\n\nOne request = one transaction: if any step fails nothing is kept.", "operationId": "vm_erp.vm_erp.shipping.api.create_shipment", "requestBody": { "content": { "application/json": { "schema": { "properties": { "carrier": { "description": "", "type": "string" }, "order": { "description": "", "type": "string" }, "packed": { "description": "", "type": "string" }, "parcels": { "description": "", "type": "integer" }, "tracking_number": { "description": "", "type": "string" }, "versandart": { "description": "", "type": "string" }, "weight_kg": { "description": "", "type": "integer" } }, "required": [ "order", "packed" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Create the Delivery Note (submitted) for the confirmed quantities and the Sendung record.", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Sales User", "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.shipping.api.find_order": { "get": { "description": "Resolve a scan (order name, or a Delivery Note's order reference) to a Sales Order name.", "operationId": "vm_erp.vm_erp.shipping.api.find_order", "parameters": [ { "description": "", "in": "query", "name": "scan", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Resolve a scan (order name, or a Delivery Note's order reference) to a Sales Order name.", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Resolve a scan (order name, or a Delivery Note's order reference) to a Sales Order name.", "operationId": "vm_erp.vm_erp.shipping.api.find_order", "requestBody": { "content": { "application/json": { "schema": { "properties": { "scan": { "description": "", "type": "string" } }, "required": [ "scan" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Resolve a scan (order name, or a Delivery Note's order reference) to a Sales Order name.", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.shipping.api.get_pack_data": { "get": { "description": "Header and packable lines of one order. Refuses orders that are not shippable.", "operationId": "vm_erp.vm_erp.shipping.api.get_pack_data", "parameters": [ { "description": "", "in": "query", "name": "order", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Header and packable lines of one order", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Header and packable lines of one order. Refuses orders that are not shippable.", "operationId": "vm_erp.vm_erp.shipping.api.get_pack_data", "requestBody": { "content": { "application/json": { "schema": { "properties": { "order": { "description": "", "type": "string" } }, "required": [ "order" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Header and packable lines of one order", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.shipping.api.get_ready_orders": { "get": { "description": "Orders that may ship now (Versand light green; yellow too with include_partial).", "operationId": "vm_erp.vm_erp.shipping.api.get_ready_orders", "parameters": [ { "description": "", "in": "query", "name": "include_partial", "required": false, "schema": { "type": "integer" } }, { "description": "", "in": "query", "name": "company", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Orders that may ship now (Versand light green; yellow too with include_partial).", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Orders that may ship now (Versand light green; yellow too with include_partial).", "operationId": "vm_erp.vm_erp.shipping.api.get_ready_orders", "requestBody": { "content": { "application/json": { "schema": { "properties": { "company": { "description": "", "type": "string" }, "include_partial": { "description": "", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Orders that may ship now (Versand light green; yellow too with include_partial).", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.shipping.api.get_shipping_methods": { "get": { "description": "", "operationId": "vm_erp.vm_erp.shipping.api.get_shipping_methods", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_shipping_methods", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.shipping.api.get_shipping_methods", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "get_shipping_methods", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.shipping.api.kosten_ausnahme": { "post": { "description": "Versandkosten-Ausnahme am Auftrag protokollieren (Kommentar). Nur mit Grund (mindestens 10 Zeichen), nur Sales Manager oder hoeher.\n\nDie Funktion aendert keine Preise im Auftrag; sie haelt fest, wer welchen Betrag aus welchem Grund freigegeben hat.", "operationId": "vm_erp.vm_erp.shipping.api.kosten_ausnahme", "requestBody": { "content": { "application/json": { "schema": { "properties": { "auftrag": { "description": "", "type": "string" }, "betrag": { "description": "", "type": "string" }, "grund": { "description": "", "type": "string" } }, "required": [ "auftrag", "betrag", "grund" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Versandkosten-Ausnahme am Auftrag protokollieren (Kommentar)", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Sales Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.shipping.api.kosten_vorschau": { "get": { "description": "Vorschau der Versandkosten (netto) am Auftrag. Schreibt nichts. Gewicht aus den Artikeln, Zone aus der Lieferadresse.\n\nOhne Gewicht oder ohne passende Regel kommt ein klarer Hinweis statt einer geratenen Zahl.", "operationId": "vm_erp.vm_erp.shipping.api.kosten_vorschau", "parameters": [ { "description": "", "in": "query", "name": "auftrag", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "versandart", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Vorschau der Versandkosten (netto) am Auftrag", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Vorschau der Versandkosten (netto) am Auftrag. Schreibt nichts. Gewicht aus den Artikeln, Zone aus der Lieferadresse.\n\nOhne Gewicht oder ohne passende Regel kommt ein klarer Hinweis statt einer geratenen Zahl.", "operationId": "vm_erp.vm_erp.shipping.api.kosten_vorschau", "requestBody": { "content": { "application/json": { "schema": { "properties": { "auftrag": { "description": "", "type": "string" }, "versandart": { "description": "", "type": "string" } }, "required": [ "auftrag" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Vorschau der Versandkosten (netto) am Auftrag", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.shipping.api.tracking_aktualisieren": { "post": { "description": "Fragt den Status der genannten Sendungen ab und schreibt Status und Pruefzeit in VM Sendung (höchstens 200 je Aufruf).\n\nEin 404 beim Dienstleister heisst \"unbekannt\", ein Netzfehler \"fehler\"; beides aendert einen bekannten Status nicht.", "operationId": "vm_erp.vm_erp.shipping.api.tracking_aktualisieren", "requestBody": { "content": { "application/json": { "schema": { "properties": { "sendungen": { "description": "", "type": "string" } }, "required": [ "sendungen" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Fragt den Status der genannten Sendungen ab und schreibt Status und Pruefzeit in VM Sendung (höchstens 200 je Aufruf).", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.shipping.api.zustellausnahmen": { "get": { "description": "Liste der Zustellausnahmen mit Zaehlung je Grund und Textentwurf je Zeile (wird nirgends gesendet).", "operationId": "vm_erp.vm_erp.shipping.api.zustellausnahmen", "parameters": [ { "description": "", "in": "query", "name": "grund", "required": false, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "carrier", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Liste der Zustellausnahmen mit Zaehlung je Grund und Textentwurf je Zeile (wird nirgends gesendet).", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Liste der Zustellausnahmen mit Zaehlung je Grund und Textentwurf je Zeile (wird nirgends gesendet).", "operationId": "vm_erp.vm_erp.shipping.api.zustellausnahmen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "carrier": { "description": "", "type": "string" }, "grund": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Liste der Zustellausnahmen mit Zaehlung je Grund und Textentwurf je Zeile (wird nirgends gesendet).", "tags": [ "Versand" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.startseite.api.rueckstaende": { "get": { "description": "", "operationId": "vm_erp.vm_erp.startseite.api.rueckstaende", "parameters": [ { "description": "", "in": "query", "name": "filters", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "rueckstaende", "tags": [ "Startseite" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.startseite.api.rueckstaende", "requestBody": { "content": { "application/json": { "schema": { "properties": { "filters": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "rueckstaende", "tags": [ "Startseite" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.startseite.api.startseite_daten": { "get": { "description": "Vorschlagsleiste und Erste-Schritte-Karte fuer die Startseite. Ohne Recht auf die Vorschlaege bleibt die Leiste leer. Die Karte verschwindet bei 100 Prozent.", "operationId": "vm_erp.vm_erp.startseite.api.startseite_daten", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Vorschlagsleiste und Erste-Schritte-Karte fuer die Startseite", "tags": [ "Startseite" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Vorschlagsleiste und Erste-Schritte-Karte fuer die Startseite. Ohne Recht auf die Vorschlaege bleibt die Leiste leer. Die Karte verschwindet bei 100 Prozent.", "operationId": "vm_erp.vm_erp.startseite.api.startseite_daten", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Vorschlagsleiste und Erste-Schritte-Karte fuer die Startseite", "tags": [ "Startseite" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.startseite.api.versandbereit": { "get": { "description": "", "operationId": "vm_erp.vm_erp.startseite.api.versandbereit", "parameters": [ { "description": "", "in": "query", "name": "filters", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "versandbereit", "tags": [ "Startseite" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.startseite.api.versandbereit", "requestBody": { "content": { "application/json": { "schema": { "properties": { "filters": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "versandbereit", "tags": [ "Startseite" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.stueckliste.api.get_bedarf": { "get": { "description": "Fehlende Komponenten fuer offene Kundenauftraege mit Stueckliste.", "operationId": "vm_erp.vm_erp.stueckliste.api.get_bedarf", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Fehlende Komponenten fuer offene Kundenauftraege mit Stueckliste.", "tags": [ "Stücklisten und Fertigung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Fehlende Komponenten fuer offene Kundenauftraege mit Stueckliste.", "operationId": "vm_erp.vm_erp.stueckliste.api.get_bedarf", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Fehlende Komponenten fuer offene Kundenauftraege mit Stueckliste.", "tags": [ "Stücklisten und Fertigung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.stueckliste.api.get_werkzeug": { "get": { "description": "Baum, Kostenrollup und Verwendungsnachweis fuer einen Artikel.", "operationId": "vm_erp.vm_erp.stueckliste.api.get_werkzeug", "parameters": [ { "description": "", "in": "query", "name": "artikel", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Baum, Kostenrollup und Verwendungsnachweis fuer einen Artikel.", "tags": [ "Stücklisten und Fertigung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Baum, Kostenrollup und Verwendungsnachweis fuer einen Artikel.", "operationId": "vm_erp.vm_erp.stueckliste.api.get_werkzeug", "requestBody": { "content": { "application/json": { "schema": { "properties": { "artikel": { "description": "", "type": "string" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Baum, Kostenrollup und Verwendungsnachweis fuer einen Artikel.", "tags": [ "Stücklisten und Fertigung" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.stueckliste.api.melde_fertig": { "post": { "description": "Fertigmeldung: schreibt Gut-/Ausschussmenge und Bewegungsentwuerfe in den Datensatz.", "operationId": "vm_erp.vm_erp.stueckliste.api.melde_fertig", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ausschuss": { "description": "", "type": "integer" }, "gut": { "description": "", "type": "string" }, "name": { "description": "", "type": "string" } }, "required": [ "name", "gut" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Fertigmeldung: schreibt Gut-/Ausschussmenge und Bewegungsentwuerfe in den Datensatz.", "tags": [ "Stücklisten und Fertigung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Manufacturing User", "Manufacturing Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.stueckliste.api.plane": { "post": { "description": "Legt einen Fertigungsauftrag als Entwurf an (nur der Datensatz, keine Buchung).", "operationId": "vm_erp.vm_erp.stueckliste.api.plane", "requestBody": { "content": { "application/json": { "schema": { "properties": { "artikel": { "description": "", "type": "string" }, "menge": { "description": "", "type": "string" } }, "required": [ "artikel", "menge" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt einen Fertigungsauftrag als Entwurf an (nur der Datensatz, keine Buchung).", "tags": [ "Stücklisten und Fertigung" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Stock User", "Stock Manager", "Manufacturing User", "Manufacturing Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.vorlagen.api.anwenden": { "post": { "description": "Legt fehlende Artikelgruppen und Lager an und speichert den Rest im Stand. Vorhandenes bleibt, auch nach dem Anwenden.", "operationId": "vm_erp.vm_erp.vorlagen.api.anwenden", "requestBody": { "content": { "application/json": { "schema": { "properties": { "vorlage": { "description": "", "type": "string" } }, "required": [ "vorlage" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt fehlende Artikelgruppen und Lager an und speichert den Rest im Stand", "tags": [ "Branchenvorlagen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.vorlagen.api.vorlagen": { "get": { "description": "", "operationId": "vm_erp.vm_erp.vorlagen.api.vorlagen", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorlagen", "tags": [ "Branchenvorlagen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.vorlagen.api.vorlagen", "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorlagen", "tags": [ "Branchenvorlagen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.vorlagen.api.vorschau": { "get": { "description": "", "operationId": "vm_erp.vm_erp.vorlagen.api.vorschau", "parameters": [ { "description": "", "in": "query", "name": "vorlage", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorschau", "tags": [ "Branchenvorlagen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" }, "post": { "description": "", "operationId": "vm_erp.vm_erp.vorlagen.api.vorschau", "requestBody": { "content": { "application/json": { "schema": { "properties": { "vorlage": { "description": "", "type": "string" } }, "required": [ "vorlage" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "vorschau", "tags": [ "Branchenvorlagen" ], "x-vm-gast": false, "x-vm-rollen": [ [ "System Manager" ] ], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.zahlung.api.datei_erzeugen": { "post": { "description": "Erzeugt die pain.001-Datei, nur nach Freigabe. Private Datei am Vorschlag, wird nirgendwohin gesendet.", "operationId": "vm_erp.vm_erp.zahlung.api.datei_erzeugen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "ausfuehrungsdatum": { "description": "", "type": "string" }, "name": { "description": "", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Erzeugt die pain.001-Datei, nur nach Freigabe", "tags": [ "Zahlungsvorschlag" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.zahlung.api.freigeben": { "post": { "description": "Gibt den Vorschlag frei. Der Ersteller darf es nicht selbst (Controller und diese Pruefung).", "operationId": "vm_erp.vm_erp.zahlung.api.freigeben", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "", "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Gibt den Vorschlag frei", "tags": [ "Zahlungsvorschlag" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/method/vm_erp.vm_erp.zahlung.api.skonto_verlust": { "get": { "description": "Kennzahl: verfallenes Skonto im Zeitraum. Lesend. Basis: bezahlte Lieferantenrechnungen mit Skontofrist.", "operationId": "vm_erp.vm_erp.zahlung.api.skonto_verlust", "parameters": [ { "description": "", "in": "query", "name": "von", "required": true, "schema": { "type": "string" } }, { "description": "", "in": "query", "name": "bis", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Kennzahl: verfallenes Skonto im Zeitraum", "tags": [ "Zahlungsvorschlag" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" }, "post": { "description": "Kennzahl: verfallenes Skonto im Zeitraum. Lesend. Basis: bezahlte Lieferantenrechnungen mit Skontofrist.", "operationId": "vm_erp.vm_erp.zahlung.api.skonto_verlust", "requestBody": { "content": { "application/json": { "schema": { "properties": { "bis": { "description": "", "type": "string" }, "von": { "description": "", "type": "string" } }, "required": [ "von", "bis" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Kennzahl: verfallenes Skonto im Zeitraum", "tags": [ "Zahlungsvorschlag" ], "x-vm-gast": false, "x-vm-rollen": [], "x-vm-zugriff": "Lesend" } }, "/api/method/vm_erp.vm_erp.zahlung.api.vorschlag_erstellen": { "post": { "description": "Legt einen Zahlungsvorschlag im Status Entwurf an. Zahlt nichts.", "operationId": "vm_erp.vm_erp.zahlung.api.vorschlag_erstellen", "requestBody": { "content": { "application/json": { "schema": { "properties": { "firma": { "description": "", "type": "string" }, "liquiditaetsgrenze": { "description": "", "type": "string" }, "stichtag": { "description": "", "type": "string" }, "vorlauf_tage": { "description": "", "type": "integer" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "message": {} }, "type": "object" } } }, "description": "Erfolg. Der Rückgabewert steht im Feld message." }, "401": { "$ref": "#/components/responses/Nicht_angemeldet" }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" }, "429": { "$ref": "#/components/responses/Zu_viele_Anfragen" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Legt einen Zahlungsvorschlag im Status Entwurf an", "tags": [ "Zahlungsvorschlag" ], "x-vm-gast": false, "x-vm-rollen": [ [ "Accounts User", "Accounts Manager", "System Manager" ] ], "x-vm-zugriff": "Schreibend, rollengeschützt" } }, "/api/resource/{doctype}": { "get": { "operationId": "ressource_liste", "parameters": [ { "in": "path", "name": "doctype", "required": true, "schema": { "type": "string" } }, { "description": "JSON-Liste der Felder", "in": "query", "name": "fields", "schema": { "type": "string" } }, { "description": "JSON-Liste von [Feld, Operator, Wert]", "in": "query", "name": "filters", "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "schema": { "type": "string" } }, { "in": "query", "name": "limit_start", "schema": { "default": 0, "type": "integer" } }, { "in": "query", "name": "limit_page_length", "schema": { "default": 20, "type": "integer" } } ], "responses": { "200": { "description": "Die Liste steht in data." }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Liste eines Belegtyps", "tags": [ "Standard-Ressourcen" ] }, "post": { "operationId": "ressource_anlegen", "parameters": [ { "in": "path", "name": "doctype", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "Der angelegte Beleg steht in data." }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Beleg anlegen", "tags": [ "Standard-Ressourcen" ] } }, "/api/resource/{doctype}/{name}": { "delete": { "description": "Gebuchte und stornierte Belege können nicht gelöscht werden.", "operationId": "ressource_loeschen", "parameters": [ { "in": "path", "name": "doctype", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Gelöscht." }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Beleg löschen", "tags": [ "Standard-Ressourcen" ] }, "get": { "operationId": "ressource_lesen", "parameters": [ { "in": "path", "name": "doctype", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Der Beleg steht in data." }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "404": { "description": "Beleg nicht gefunden." } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Einen Beleg lesen", "tags": [ "Standard-Ressourcen" ] }, "put": { "operationId": "ressource_aendern", "parameters": [ { "in": "path", "name": "doctype", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "description": "Der geänderte Beleg steht in data." }, "403": { "$ref": "#/components/responses/Keine_Berechtigung" }, "417": { "$ref": "#/components/responses/Eingabe_ungueltig" } }, "security": [ { "tokenAuth": [] }, { "sessionAuth": [] } ], "summary": "Felder eines Belegs ändern", "tags": [ "Standard-Ressourcen" ] } } }, "servers": [ { "url": "https://{host}", "variables": { "host": { "default": "erp.example.com", "description": "Adresse Ihrer Instanz" } } } ], "tags": [ { "name": "Adressen" }, { "name": "Assistent" }, { "name": "Auftragsampel" }, { "name": "Austrittspaket" }, { "name": "Bankabgleich" }, { "name": "Beispieldaten" }, { "name": "Betrieb" }, { "name": "Box und Streckengeschäft" }, { "name": "Branchenvorlagen" }, { "name": "Chargen und Haltbarkeit" }, { "name": "DATEV" }, { "name": "Datenimport" }, { "name": "Datenqualität" }, { "name": "Demo und Erster Blick" }, { "name": "Diagrammquellen" }, { "name": "E-Rechnung" }, { "name": "Einkauf" }, { "name": "Einrichtungsassistent" }, { "name": "Einstellungsregister" }, { "name": "Forderungen" }, { "name": "Freigaben" }, { "name": "GoBD-Export" }, { "name": "Inventur" }, { "name": "Lager mobil" }, { "name": "Lieferantenrückgabe" }, { "name": "Mahnwesen" }, { "name": "Marktplätze" }, { "name": "Preislisten" }, { "name": "Prüfer-Nachweis" }, { "name": "Rahmenaufträge" }, { "name": "Retouren" }, { "name": "Rückverfolgung" }, { "name": "Selbstprüfung" }, { "name": "Set-Artikel" }, { "name": "Standard-Ressourcen" }, { "name": "Startseite" }, { "name": "Stücklisten und Fertigung" }, { "name": "Umzug und Parallellauf" }, { "name": "Versand" }, { "name": "Zahlungsvorschlag" } ] }