Virtual Marketer ERP
Inhalt der Dokumentation

Umzug und Parallellauf

Nummern-Alias, Umzugsplan und Vergleich mit dem Altsystem.

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

vm_erp.vm_erp.migration.api.parallellauf_csv

  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Wie parallellauf_vergleich, liefert die Abweichungsliste als CSV-Text (jede Zelle durch csv_zelle).

Rollen: Buchhaltung (Leitung), Systemverwalter.

ParameterTypPflichtBeschreibung
stichtagstringja
schwellestringnein
quelle_csvstringnein, Standard ''

Felder der Antwort (message): csv, dateiname

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"stichtag": "<STICHTAG>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.api.parallellauf_csv"
{"message": ...}

vm_erp.vm_erp.migration.api.parallellauf_vergleich

  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Vergleicht den hochgeladenen Altsystem-Stand (CSV-Text) mit VM ERP. Nur lesend; POST nur wegen der Dateigroesse (bis 5 MB).

Rollen: Buchhaltung (Leitung), Systemverwalter.

ParameterTypPflichtBeschreibung
stichtagstringja
schwellestringnein
quelle_csvstringnein, Standard ''
curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"stichtag": "<STICHTAG>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.api.parallellauf_vergleich"
{"message": ...}

vm_erp.vm_erp.migration.api.plan

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

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

ParameterTypPflichtBeschreibung
startstringja
fensterstringja
kanaelestringja
curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "start=<START>" \
  --data-urlencode "fenster=<FENSTER>" \
  --data-urlencode "kanaele=<KANAELE>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.api.plan"
{"message": ...}

vm_erp.vm_erp.migration.api.suche

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Findet den neuen Beleg zu einer alten Altsystem-Nummer (nur Belege mit Leserecht).

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

ParameterTypPflichtBeschreibung
eingabestringja

Felder der Antwort (message): art, eindeutig, treffer

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "eingabe=<EINGABE>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.api.suche"
{"message": ...}

vm_erp.vm_erp.migration.freifelder_api.freifelder_anlegen

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

Legt die Freifelder eines Bereichs (artikel, adresse, alle) als Custom Fields an; felder (Liste von Feldnamen) schraenkt ein.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

ParameterTypPflichtBeschreibung
bereichstringnein
felderstringnein

Felder der Antwort (message): angelegt, vorhanden

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.freifelder_api.freifelder_anlegen"
{"message": ...}

vm_erp.vm_erp.migration.freifelder_api.freifelder_fuellen

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

Schreibt die Werte aus dem Export in die Freifelder. Erst wird alles geprueft (Felder angelegt, Schluessel vorhanden), dann geschrieben.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

ParameterTypPflichtBeschreibung
bereichstringnein
quelle_csvstringnein

Felder der Antwort (message): befunde, felder, geschrieben, nicht_gefunden

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.freifelder_api.freifelder_fuellen"
{"message": ...}

vm_erp.vm_erp.migration.freifelder_api.freifelder_vorschau

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Zeigt je Freifeld Zielfeld, Typ, Spalte, Reihenfolge und ob es schon angelegt ist. Liest nur.

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

ParameterTypPflichtBeschreibung
bereichstringnein, Standard 'alle'
curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.freifelder_api.freifelder_vorschau"
{"message": ...}

vm_erp.vm_erp.migration.freifelder_api.freifelder_zaehlpruefung

  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Zaehlt je Freifeld die nicht leeren Werte im Export und in VM ERP und listet jede Abweichung als Befund. Liest nur.

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

ParameterTypPflichtBeschreibung
bereichstringnein
quelle_csvstringnein
curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.freifelder_api.freifelder_zaehlpruefung"
{"message": ...}

vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_kontinuitaet

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Prueft Luecke, Dublette und Praefixwechsel zwischen letzter alter und erster neuer Nummer. Liest nichts aus der Datenbank.

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

ParameterTypPflichtBeschreibung
alt_letztestringnein
neu_erstestringnein
curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_kontinuitaet"
{"message": ...}

vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_setzen

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

Setzt die Serie eines Kreises so, dass die naechste Nummer auf die letzte Altsystem-Nummer folgt.

Ohne 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.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

ParameterTypPflichtBeschreibung
kreisstringnein
letztestringnein
praefixstringnein
bestaetigtstringnein

Felder der Antwort (message): geaendert, geschrieben, hinweis, vorschau, zaehler

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_setzen"
{"message": ...}

vm_erp.vm_erp.migration.nummernkreise_api.nummernkreise_vorschau

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Vorschau je Kreis: letzte alte Nummer, neue erste Nummer, Zustand der Serie. Liest nur.

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

ParameterTypPflichtBeschreibung
quellestringnein

Felder der Antwort (message): kreise

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

vm_erp.vm_erp.migration.probelauf_api.probelauf_bericht

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Befunde und Abgleich eines gespeicherten Laufs. Nur lesend.

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

ParameterTypPflichtBeschreibung
lauf_idstringnein

Felder der Antwort (message): abgleich, angelegt, befunde, lauf_id, status, stichtag

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

vm_erp.vm_erp.migration.probelauf_api.probelauf_csv

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Abweichungen eines Laufs als CSV-Text (jede Zelle durch csv_zelle). Nur lesend.

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

ParameterTypPflichtBeschreibung
lauf_idstringnein

Felder der Antwort (message): csv, dateiname

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

vm_erp.vm_erp.migration.probelauf_api.probelauf_laeufe

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Die letzten 50 Laeufe. Nur lesend.

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.migration.probelauf_api.probelauf_laeufe"
{"message": ...}

vm_erp.vm_erp.migration.probelauf_api.probelauf_rueckgaengig

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

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.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

ParameterTypPflichtBeschreibung
lauf_idstringnein
bestaetigtstringnein

Felder der Antwort (message): entfernt, fremd, geaendert, lauf_id, nicht_entfernt, status, wuerde_entfernen

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.probelauf_api.probelauf_rueckgaengig"
{"message": ...}

vm_erp.vm_erp.migration.probelauf_api.probelauf_schreiben

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

Legt die neuen Kunden und Artikel an, jeden mit der Lauf-ID. Nur auf einer Demo-Site. Ohne bestaetigt kommt nur die Vorschau.

Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.

ParameterTypPflichtBeschreibung
stichtagstringnein
kundenstringnein
artikelstringnein
offene_postenstringnein
bestandstringnein
umsatzstringnein
bestaetigtstringnein

Felder der Antwort (message): angelegt, geschrieben, lauf_id

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.probelauf_api.probelauf_schreiben"
{"message": ...}

vm_erp.vm_erp.migration.probelauf_api.probelauf_trockenlauf

  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Liest die fuenf Dateien und zeigt, was ein Lauf anlegen wuerde und wo es Abweichungen gibt. Schreibt nichts (POST nur wegen der Dateigroesse).

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

ParameterTypPflichtBeschreibung
stichtagstringnein
kundenstringnein
artikelstringnein
offene_postenstringnein
bestandstringnein
umsatzstringnein

Felder der Antwort (message): geschrieben

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.migration.probelauf_api.probelauf_trockenlauf"
{"message": ...}