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.
- parallellauf_csv
- parallellauf_vergleich
- plan
- suche
- freifelder_anlegen
- freifelder_fuellen
- freifelder_vorschau
- freifelder_zaehlpruefung
- nummernkreise_kontinuitaet
- nummernkreise_setzen
- nummernkreise_vorschau
- probelauf_bericht
- probelauf_csv
- probelauf_laeufe
- probelauf_rueckgaengig
- probelauf_schreiben
- probelauf_trockenlauf
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
stichtag | string | ja | |
schwelle | string | nein | |
quelle_csv | string | nein, 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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
stichtag | string | ja | |
schwelle | string | nein | |
quelle_csv | string | nein, 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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
start | string | ja | |
fenster | string | ja | |
kanaele | string | ja |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
eingabe | string | ja |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
bereich | string | nein | |
felder | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
bereich | string | nein | |
quelle_csv | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
bereich | string | nein, 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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
bereich | string | nein | |
quelle_csv | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
alt_letzte | string | nein | |
neu_erste | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
kreis | string | nein | |
letzte | string | nein | |
praefix | string | nein | |
bestaetigt | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
quelle | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
lauf_id | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
lauf_id | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
lauf_id | string | nein | |
bestaetigt | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
stichtag | string | nein | |
kunden | string | nein | |
artikel | string | nein | |
offene_posten | string | nein | |
bestand | string | nein | |
umsatz | string | nein | |
bestaetigt | string | nein |
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.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
stichtag | string | nein | |
kunden | string | nein | |
artikel | string | nein | |
offene_posten | string | nein | |
bestand | string | nein | |
umsatz | string | nein |
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": ...}