Inhalt der Dokumentation
Zahlungsvorschlag
Zahlungsvorschlag mit Vier-Augen-Freigabe und SEPA-Datei.
4 Funktionen. Aufruf unter /api/method/<Pfad>, Anmeldung und Fehlerformat stehen unter Authentifizierung und Fehlermodell.
vm_erp.vm_erp.zahlung.api.datei_erzeugen
- POST
- Schreibend, rollengeschützt
- Fehlernummer bei unerwarteten Fehlern
Erzeugt die pain.001-Datei, nur nach Freigabe. Private Datei am Vorschlag, wird nirgendwohin gesendet.
Rollen: Buchhaltung, Buchhaltung (Leitung), Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
name | string | ja | |
ausfuehrungsdatum | string | nein |
Felder der Antwort (message): anzahl, datei, hinweis, msg_id, summe
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.zahlung.api.datei_erzeugen"{"message": ...}vm_erp.vm_erp.zahlung.api.freigeben
- POST
- Schreibend, rollengeschützt
- Fehlernummer bei unerwarteten Fehlern
Gibt den Vorschlag frei. Der Ersteller darf es nicht selbst (Controller und diese Pruefung).
Rollen: Buchhaltung, Buchhaltung (Leitung), Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
name | string | ja |
Felder der Antwort (message): freigegeben_von, name, status
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.zahlung.api.freigeben"{"message": ...}vm_erp.vm_erp.zahlung.api.skonto_verlust
- GET
- POST
- Lesend
- Fehlernummer bei unerwarteten Fehlern
Kennzahl: verfallenes Skonto im Zeitraum. Lesend. Basis: bezahlte Lieferantenrechnungen mit Skontofrist.
Rollen: Jede angemeldete Person; der Zugriff richtet sich nach den Rechten am betroffenen Beleg.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
von | string | ja | |
bis | string | ja |
curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
--data-urlencode "von=<VON>" \
--data-urlencode "bis=<BIS>" \
"https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.zahlung.api.skonto_verlust"{"message": ...}vm_erp.vm_erp.zahlung.api.vorschlag_erstellen
- POST
- Schreibend, rollengeschützt
- Fehlernummer bei unerwarteten Fehlern
Legt einen Zahlungsvorschlag im Status Entwurf an. Zahlt nichts.
Rollen: Buchhaltung, Buchhaltung (Leitung), Systemverwalter. Der schreibgeschützte Demo-Zugang erhält eine Berechtigungsmeldung.
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
stichtag | string | nein | |
firma | string | nein | |
liquiditaetsgrenze | string | nein | |
vorlauf_tage | integer | nein, Standard 0 |
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.zahlung.api.vorschlag_erstellen"{"message": ...}