Inhalt der Dokumentation

Forderungen

Forderungsalterung, Kontoauszug und CSV-Export.

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

alterung
csv_export
kontoauszug_entwurf

`vm_erp.vm_erp.forderungen.api.alterung`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Staffeln je Kunde und gesamt. Lesend.

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

Parameter	Typ	Pflicht
`stichtag`	string	nein
`firma`	string	nein
`kunde`	string	nein

curl -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.forderungen.api.alterung"

{"message": ...}

`vm_erp.vm_erp.forderungen.api.csv_export`

GET
POST
Lesend
Fehlernummer bei unerwarteten Fehlern

Alterung als CSV (Semikolon). Jede Zelle geht durch csv_zelle (Formelschutz). Betraege bleiben Zahlen.

Rollen: Buchhaltung, Buchhaltung (Leitung), Systemverwalter.

Parameter	Typ	Pflicht	Beschreibung
`stichtag`	string	nein
`firma`	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.forderungen.api.csv_export"

{"message": ...}

`vm_erp.vm_erp.forderungen.api.kontoauszug_entwurf`

POST
Schreibend, rollengeschützt
Fehlernummer bei unerwarteten Fehlern

Legt den Kontoauszug als private PDF-Datei am Kunden ab. Versendet nichts.

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

Parameter	Typ	Pflicht	Beschreibung
`kunde`	string	ja
`stichtag`	string	nein

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

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"kunde": "<KUNDE>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.forderungen.api.kontoauszug_entwurf"

{"message": ...}