Virtual Marketer ERP
Inhalt der Dokumentation

Freigaben

Regeln, Anfragen und Entscheidungen nach dem Vier-Augen-Prinzip.

7 Funktionen. Aufruf unter /api/method/<Pfad>, Anmeldung und Fehlerformat stehen unter Authentifizierung und Fehlermodell.

vm_erp.vm_erp.freigabe.api.anfrage_stellen

  • POST
  • Schreibend, rollengeschützt
  • Fehlernummer bei unerwarteten Fehlern

Der Beleg bleibt unveraendert.

Rollen: Buchhaltung (Leitung), Buchhaltung, Einkauf (Leitung), Vertrieb (Leitung), Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

ParameterTypPflichtBeschreibung
belegartstringja
belegstringja

Felder der Antwort (message): anfrage, text

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"belegart": "<BELEGART>", "beleg": "<BELEG>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.freigabe.api.anfrage_stellen"
{"message": ...}

vm_erp.vm_erp.freigabe.api.entscheiden

  • POST
  • Schreibend, rollengeschützt
  • Fehlernummer bei unerwarteten Fehlern

Freigeben oder ablehnen. Grund ist Pflicht. Eigene Anfragen kann niemand entscheiden.

Rollen: Buchhaltung (Leitung), Buchhaltung, Einkauf (Leitung), Vertrieb (Leitung), Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

ParameterTypPflichtBeschreibung
anfragestringja
okstringja
grundstringja

Felder der Antwort (message): anfrage, status

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"anfrage": "<ANFRAGE>", "ok": "<OK>", "grund": "<GRUND>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.freigabe.api.entscheiden"
{"message": ...}

vm_erp.vm_erp.freigabe.api.get_aufgaben

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Reine Aufgabenliste fuer die Arbeitsliste: [{titel, beleg, prioritaet}] fuer die angemeldete Person.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

Parameter: keine.

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.freigabe.api.get_aufgaben"
{"message": ...}

vm_erp.vm_erp.freigabe.api.get_beispiel

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

Parameter: keine.

Felder der Antwort (message): beispiel, offene, regeln, trockentest

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.freigabe.api.get_beispiel"
{"message": ...}

vm_erp.vm_erp.freigabe.api.get_offene

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Offene Anfragen, die die angemeldete Person entscheiden darf, und alle offenen zur Uebersicht.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

Parameter: keine.

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.freigabe.api.get_offene"
{"message": ...}

vm_erp.vm_erp.freigabe.api.get_regeln

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.

Parameter: keine.

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.freigabe.api.get_regeln"
{"message": ...}

vm_erp.vm_erp.freigabe.api.regel_pruefen

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Trockentest: wen haette die Regel in den letzten 30 Tagen getroffen? Liest Belege, schreibt nichts.

Rollen: (Buchhaltung (Leitung), Systemverwalter) oder (Buchhaltung (Leitung), Buchhaltung, Einkauf (Leitung), Vertrieb (Leitung), Systemverwalter).

ParameterTypPflichtBeschreibung
regel_namestringja
curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "regel_name=<REGEL_NAME>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.freigabe.api.regel_pruefen"
{"message": ...}