E-Rechnung

vm_erp.vm_erp.erechnung.ausgang_api.erzeugen

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

XML erzeugen, pruefen, privat ablegen, Status festhalten. Die Rechnung bleibt unveraendert.

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

Felder der Antwort (message): eintrag, pruefung, status, text

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"ausgangsrechnung": "<AUSGANGSRECHNUNG>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.erechnung.ausgang_api.erzeugen"

{"message": ...}

vm_erp.vm_erp.erechnung.ausgang_api.get_beispiel

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Beispieldaten fuer die Seite, nichts wird gelesen oder gespeichert.

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

Parameter: keine.

Felder der Antwort (message): beispiel, eintraege, pruefung, rechnung

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

{"message": ...}

vm_erp.vm_erp.erechnung.ausgang_api.get_liste

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

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

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

{"message": ...}

vm_erp.vm_erp.erechnung.ausgang_api.status_setzen

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

Weiterschalten: versendet oder abgelehnt (mit Grund). Die Datei wird nicht verschickt, das macht die Person.

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

Felder der Antwort (message): eintrag, status

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"eintrag": "<EINTRAG>", "nach": "<NACH>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.erechnung.ausgang_api.status_setzen"

{"message": ...}

vm_erp.vm_erp.erechnung.ausgang_api.vorschau

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Prueft, was erzeugt wuerde. Schreibt nichts.

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

Felder der Antwort (message): pruefung, rechnung

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "ausgangsrechnung=<AUSGANGSRECHNUNG>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.erechnung.ausgang_api.vorschau"

{"message": ...}

vm_erp.vm_erp.erechnung.ausgang_api.z3_index_xml

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Verzeichnisdatei (index.xml) fuer die erzeugten E-Rechnungen im Zeitraum. Nur lesend.

Rollen: Buchhaltung, Buchhaltung (Leitung), Vertrieb, Systemverwalter.

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.erechnung.ausgang_api.z3_index_xml"

{"message": ...}

vm_erp.vm_erp.erechnung.eingang_api.entwurf_anlegen

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

Original privat ablegen, Datensatz anlegen, Eingangsrechnung als Entwurf. Bucht nichts.

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

Felder der Antwort (message): eingangsrechnung, eintrag, status, text

curl -X POST -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  -H "Content-Type: application/json" \
  -d '{"daten_b64": "<DATEN_B64>"}' \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.erechnung.eingang_api.entwurf_anlegen"

{"message": ...}

vm_erp.vm_erp.erechnung.eingang_api.get_beispiel

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Beispieldaten fuer die Seite, nichts wird gelesen oder geschrieben.

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

Parameter: keine.

Felder der Antwort (message): abgleich, befunde, beispiel, doppelt, konto, rechnung

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

{"message": ...}

vm_erp.vm_erp.erechnung.eingang_api.get_liste

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

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.erechnung.eingang_api.get_liste"

{"message": ...}

vm_erp.vm_erp.erechnung.eingang_api.lese_datei

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Datei (Base64) lesen und pruefen. Schreibt nichts.

Rollen: Buchhaltung, Buchhaltung (Leitung), Einkauf, Systemverwalter.

Felder der Antwort (message): abgleich, ampel, befunde, beispiel, doppelt, hash, konto, quelle, rechnung

curl --get -H "Authorization: token $API_SCHLUESSEL:$API_GEHEIMNIS" \
  --data-urlencode "daten_b64=<DATEN_B64>" \
  "https://ihre-instanz.example.com/api/method/vm_erp.vm_erp.erechnung.eingang_api.lese_datei"

{"message": ...}

vm_erp.vm_erp.erechnung.eingang_api.z3_index_xml

• GET
• POST
• Lesend
• Fehlernummer bei unerwarteten Fehlern

Verzeichnisdatei (index.xml) fuer die abgelegten E-Rechnungen im Zeitraum, ueber gobd/z3_index. Nur lesend.

Rollen: Buchhaltung, Buchhaltung (Leitung), Einkauf, Systemverwalter.

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.erechnung.eingang_api.z3_index_xml"

{"message": ...}