Virtual Marketer ERP
Inhalt der Dokumentation

Mahnwesen

Mahnlauf mit Vorschau, Entwürfen und Mahnsperre.

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

vm_erp.vm_erp.mahnwesen.api.mahnbeleg_pdf

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

PDF eines Mahnbeleg-ENTWURFS mit dem Standarddruckformat, als private Datei am Beleg. Nur auf Anforderung, nie automatisch.

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

ParameterTypPflichtBeschreibung
namestringja

Felder der Antwort (message): datei, hinweis, name

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

vm_erp.vm_erp.mahnwesen.api.mahnlauf_verwerfen

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

Loescht Entwuerfe EINES Laufs, die der Aufrufer selbst angelegt hat. Eingereichte oder stornierte Belege bleiben unberuehrt.

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

ParameterTypPflichtBeschreibung
lauf_kennungstringja
namenstringja

Felder der Antwort (message): geblieben, verworfen

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"lauf_kennung": "<LAUF_KENNUNG>", "namen": "<NAMEN>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.mahnwesen.api.mahnlauf_verwerfen"
{"message": ...}

vm_erp.vm_erp.mahnwesen.api.mahnlauf_vorbereiten

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

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.

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

ParameterTypPflichtBeschreibung
stichtagstringja
kundenstringja
curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"stichtag": "<STICHTAG>", "kunden": "<KUNDEN>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.mahnwesen.api.mahnlauf_vorbereiten"
{"message": ...}

vm_erp.vm_erp.mahnwesen.api.mahntext

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

Draft text for one candidate of the current preview. kunde is the customer id.

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

ParameterTypPflichtBeschreibung
kundestringja
stufestringja
stichtagstringnein
curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "kunde=<KUNDE>" \
  --data-urlencode "stufe=<STUFE>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.mahnwesen.api.mahntext"
{"message": ...}

vm_erp.vm_erp.mahnwesen.api.sperre_aufheben

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

Hebt eine Sperre auf, indem das Ablaufdatum auf gestern gesetzt wird. Die Standard-Versionierung haelt Wer und Wann fest.

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

ParameterTypPflichtBeschreibung
namestringja

Felder der Antwort (message): gueltig_bis, name

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

vm_erp.vm_erp.mahnwesen.api.sperre_setzen

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

Manuelle Mahnsperre mit Pflichtgrund und Ablaufdatum. Sie gilt bis einschliesslich gueltig_bis und wird danach ignoriert.

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

ParameterTypPflichtBeschreibung
kundestringja
grundstringja
gueltig_bisstringja

Felder der Antwort (message): gueltig_bis, kunde, name

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"kunde": "<KUNDE>", "grund": "<GRUND>", "gueltig_bis": "<GUELTIG_BIS>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.mahnwesen.api.sperre_setzen"
{"message": ...}

vm_erp.vm_erp.mahnwesen.api.vorschau

  • GET
  • POST
  • Lesend
  • Fehlernummer bei unerwarteten Fehlern

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

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