Schnittstelle¶
Alles unter /api außer /api/auth, /api/status, /api/einladung/:token, /api/freigabe/:token und /api/geteilt/:token verlangt eine Sitzung (Cookie von
Better Auth). Das erste Konto (POST /api/auth/sign-up/email) ist der Inhaber und braucht den Einrichtungscode, den der
Server beim Start ins Log schreibt (Kopfzeile x-belegt-einrichtungscode). Jedes weitere Konto entsteht nur mit einer
Einladung (Kopfzeile x-belegt-einladung mit dem Token aus dem Link) und bekommt deren Rolle. Name, E-Mail und Rolle
lassen sich nicht über Better Auth ändern. Den zweiten Faktor richten die Plugins von Better Auth unter
/api/auth/two-factor/ und /api/auth/passkey/ ein (zugaenge.md); gilt die Pflicht und die
Sitzung hat keinen, antwortet alles außer /api/ich und /api/konto mit 403 und zweiFaktorEinrichten: true. Schreiben darf nur der Inhaber, Steuerberatung und Prüfer lesen (403 sonst); Notizen schreibt auch die Steuerberatung. Ein Prüfer liest nur Dokumente (mit Tags, Dokumenttypen und Feldern), Export und Prüfung, und nur in seinem Zeitraum (404 für ein Dokument außerhalb, pruefung.md). Ein Mitarbeiter erreicht nur Dokumente, Tags, Dokumenttypen, Korrespondenten, Felder, Startseite und eigene Ansichten, mit dem Recht bearbeiten auch Aufnehmen, Einordnen, Ordnung, Sammelbearbeitung und Notizen, und nur in seinem Sichtbereich (404 für ein Dokument außerhalb, 409 für eine Änderung, nach der das Dokument außerhalb läge, 403 für alles andere; zugaenge.md). Ein entzogener Zugang bekommt 401. Schreibt ein
Browser von einer anderen Adresse als BETTER_AUTH_URL (Origin, Sec-Fetch-Site), antwortet Belegt ebenfalls mit
403. Das Audit-Log nennt als Akteur nutzer:<E-Mail>.
Programme melden sich statt mit dem Cookie mit einem API-Token an: Authorization: Bearer belegt_…. Der Inhaber legt
Tokens unter „Quellen und Schnittstellen“ an; gespeichert ist nur der Hash. Ein Token mit dem Recht lesen liest
Dokumente (GET /api/dokumente, /:id, /:id/datei, /:id/mail, /:id/verlauf, /:id/vorschaubild, /:id/archivfassung, /:id/ableitungen, /:id/aehnliche, /:id/notizen) und Tags, Dokumenttypen und Felder,
mit schreiben nimmt es zusätzlich Dokumente und Mails auf, ordnet ein, setzt Tags, Dokumenttyp, Korrespondent und Feldwerte und schreibt Notizen; POST /api/mcp steht jedem Token offen, mit den Werkzeugen seines Rechts.
Alles andere antwortet 403, ein widerrufenes oder falsches Token 401. Im Audit-Log steht token:<Name>.
| Aufruf | Wirkung |
|---|---|
POST /api/auth/sign-up/email, POST /api/auth/sign-in/email, POST /api/auth/sign-out |
Einrichten, Anmelden, Abmelden (Better Auth) |
GET /api/status |
eingerichtet: true, sobald es einen Inhaber gibt; oidc (Name des Anbieters oder null), embedOrigin, version, oeffnenMit (Name der App oder null) und erechnungPruefung (ob E-Rechnungen geprüft werden); ohne Sitzung |
GET /api/ich |
der angemeldete Zugang mit Rolle; beim Prüfer zeitraum, beim Mitarbeiter recht und sichtbereich; zweiFaktorEinrichten: true, solange die Pflicht gilt und die Sitzung keinen zweiten Faktor hat |
POST /api/auth/two-factor/enable (password), …/verify-totp (code), …/verify-backup-code (code), …/disable, …/generate-backup-codes |
TOTP einrichten (Antwort totpURI und backupCodes, gilt erst nach dem ersten Code), zweiter Schritt der Anmeldung (nach sign-in/email mit twoFactorRedirect: true), entfernen, neue Backup-Codes (Better Auth) |
GET /api/auth/passkey/generate-register-options, POST …/verify-registration (response, name), GET …/generate-authenticate-options, POST …/verify-authentication (response), POST …/update-passkey (id, name), POST …/delete-passkey (id) |
Passkeys (Better Auth, WebAuthn) |
GET /api/konto, POST /api/konto/qr (text: otpauth://totp/…) |
eigener Stand: totp, passkeys (id, name, erstelltAm), passwort, pflicht, einrichten; QR-Code als SVG-Pfad (groesse, pfad); jede Rolle mit Sitzung, kein Token |
GET /api/zwei-faktor, PUT /api/zwei-faktor (rollen) |
Rollen mit Pflicht zum zweiten Faktor, nur für den Inhaber, im Audit-Log |
POST /api/zugaenge/:id/zwei-faktor-zuruecksetzen |
entfernt TOTP, Backup-Codes und Passkeys eines anderen Zugangs und beendet seine Sitzungen; nur für den Inhaber, nie für ihn selbst (400), im Audit-Log |
GET /api/zugaenge (je Zugang zweiFaktor: totp, passkeys), POST /api/einladungen (rolle: steuerberatung, pruefer mit zeitraum: {von, bis} oder mitarbeiter mit recht: lesen oder bearbeiten und sichtbereich: {tags, dokumenttypen, korrespondenten, ohneTags, ohneOrdnung}), POST /api/einladungen/:id/zurueckziehen |
Zugänge und Einladungen, nur für den Inhaber; die Antwort beim Einladen enthält den Link einmal, gespeichert ist nur der Hash des Tokens, gültig 72 Stunden |
PATCH /api/zugaenge/:id (recht, sichtbereich), POST /api/zugaenge/:id/entziehen |
Recht und Sichtbereich eines Mitarbeiters ändern (404 für andere Rollen); einen Zugang außer dem Inhaber entziehen, seine Sitzungen enden; nur für den Inhaber, beides im Audit-Log |
GET /api/tokens, POST /api/tokens (name, recht: lesen oder schreiben), POST /api/tokens/:id/widerrufen |
API-Tokens, nur für den Inhaber mit Sitzung; die Antwort beim Anlegen enthält den Klartext einmal (klartext) |
POST /api/mcp |
Model Context Protocol (JSON-RPC: initialize, ping, tools/list, tools/call) für KI-Assistenten, mit API-Token; GET antwortet 405 (schnittstelle.md) |
GET /api/openapi.json |
OpenAPI 3.1 für Programme; ohne Sitzung |
GET /api/webhooks, POST /api/webhooks (name, url, arten: dokument.aufgenommen, dokument.eingeordnet, dokument.geloescht, dokument.workflow), POST /api/webhooks/:id/aktivieren, …/deaktivieren |
Webhooks, nur für den Inhaber; das Geheimnis steht einmal in der Antwort (geheimnis); 503 ohne BELEGT_SCHLUESSEL (schnittstelle.md) |
GET /api/einladung/:token |
öffentlich: ob ein Link noch gilt und für welche Rolle |
POST /api/dokumente/:id/freigabe |
Link für „Öffnen mit …“ (schnittstelle.md): url (Adresse der App mit Link), gueltigBis; auch die Steuerberatung |
GET /api/freigabe/:token |
öffentlich, nur mit dem Link: das Original, zehn Minuten lang; 404 danach, 410 nach der Löschung |
POST /api/dokumente/:id/links |
Teilen per Link (teilen.md), nur der Inhaber mit Sitzung: {tage: 1 \| 7 \| 30}, Antwort id, url, gueltigBis; den Link gibt es nur hier |
GET /api/dokumente/:id/links |
die gültigen geteilten Links mit abrufe und letzterAbruf, nur der Inhaber |
POST /api/dokumente/:id/links/:link/widerrufen |
widerruft einen geteilten Link, nur der Inhaber |
GET /api/geteilt/:token |
öffentlich, nur mit dem geteilten Link: das Original als Download, jeder Abruf mit Zeitpunkt festgehalten; 404 nach Ablauf oder Widerruf, 410 nach der Löschung |
POST /api/dokumente (multipart, Feld datei, höchstens 100 MB) |
nimmt ein Original auf und antwortet mit 201 und dem Dokument; liegt dieselbe Datei (SHA-256) schon im Archiv und ist nicht gelöscht, 409 mit {fehler, vorhanden: {id, asn}} und nichts Neues (eingang.md); sieht ein Mitarbeiter das vorhandene Dokument nicht, sind id und asn null |
POST /api/dokumente?trennen=1 |
teilt ein PDF an Trennblättern (eingang.md) und antwortet mit {dokumente: [...], vorhanden: [...]}, ohne Trennblatt mit dem einen Dokument darin; vorhanden sind Teile, die schon im Archiv lagen. 409 wie oben, wenn der Stapel selbst oder jedes Teil schon da ist; 503 mit Retry-After, wenn schon zu viele Stapel geteilt werden |
GET /api/trennblatt.pdf |
ein Trennblatt zum Ausdrucken |
GET /api/dokumente?suche=…&seite=…&proSeite=…&sortierung=… |
Dokumente, neueste zuerst (sortierung: neu, alt, titel, entstanden oder frist), in Seiten: seite ab 1, proSeite 1 bis 200 (Vorgabe 50, limit geht auch); die Zahl aller Treffer steht in der Kopfzeile X-Gesamt; suche geht über den Volltext (deutsch, mit Anführungszeichen und Minus wie bei einer Suchmaschine) aus Dateiname, Einordnung und Mail, über Teile von Dateiname und Titel, über die Archivnummer (ASN 123 oder 123) und, außer für Prüfer, über Notizen |
GET /api/dokumente/:id |
ein Dokument; jedes Dokument hat das Feld asn, seine Archivnummer, dazu tags, dokumenttyp, korrespondent (id, name aus der Liste oder null) und felder (feldId, name, typ, wert) |
GET /api/dokumente?tag=…&dokumenttyp=…&feld.<id>=gesetzt |
Filter (ordnung.md): tag mehrfach (alle, mit tagModus=einer mindestens einer), dokumenttyp (ID oder ohne), korrespondent (ID oder ohne), je Feld feld.<id>=gesetzt, feld.<id>.enthaelt=… (Text, Auswahl, Link), feld.<id>.von=… und .bis=… (Betrag in Cent oder 1.234,56, Zahl, Datum); 400 bei unpassendem Filter. Jeder Eintrag hat tags, dokumenttyp und korrespondent |
GET /api/ansichten, POST /api/ansichten (name, parameter: Suchparameter des Archivs, fuerAlle), PATCH /api/ansichten/:id, DELETE /api/ansichten/:id, POST /api/ansichten/reihenfolge (ids) |
Gespeicherte Ansichten (ordnung.md), nur mit Sitzung: die eigenen und, außer für Prüfer, die für alle freigegebenen (eigene: false); ändern nur eigene, sonst 404; fuerAlle nur der Inhaber (403); 409 bei doppeltem Namen |
GET /api/start |
Zahlen der Startseite (eingang.md): eingang, gesamt, diesesJahr, außer für Prüfer und Mitarbeiter dazu fristen (anzahl, naechste), loeschantraege, sperren (aktiv, dokumente), quellen (postfaecher, ordner, paperless) und speicher (bytes, dateien); für Prüfer und Mitarbeiter nur in Zeitraum oder Sichtbereich; nur mit Sitzung |
GET /api/start/kacheln, PUT /api/start/kacheln (ansichten: bis zu 12 IDs) |
Kacheln der Startseite aus gespeicherten Ansichten, je Zugang in Reihenfolge; nur Ansichten, die der Zugang sieht (404 sonst) |
GET /api/tags, POST /api/tags (name, farbe), PATCH /api/tags/:id, DELETE /api/tags/:id |
Tags; farbe eine von grau, rot, orange, gelb, gruen, tuerkis, blau, violett, rosa; 409 bei doppeltem Namen; löschen entfernt die Zuordnungen |
GET /api/dokumenttypen, POST /api/dokumenttypen (name, vorgabeArt oder null), PATCH …/:id, DELETE …/:id |
Dokumenttypen |
GET /api/korrespondenten, POST /api/korrespondenten (name, bis 300 Zeichen), PATCH …/:id, DELETE …/:id |
Korrespondenten (ordnung.md) mit anzahl (ohne gelöschte Dokumente; ein Prüfer sieht nur die mit Dokumenten seines Zeitraums); 409 bei doppeltem Namen und beim Löschen, solange Dokumente ihn haben |
POST /api/korrespondenten/:id/zusammenfuehren (ziel) |
:id geht in ziel auf: Dokumente, Regeln und Workflows bekommen ziel, :id verschwindet; Antwort ziel; 409 bei ziel = :id |
Zuordnungsregel bei Tags, Dokumenttypen und Korrespondenten: abgleich (keiner, irgendein_wort, alle_woerter, exakt, regex, unscharf, automatisch), abgleichText (bis 500 Zeichen), grossKleinEgal |
in POST und PATCH, in GET immer dabei (ordnung.md); 400 bei einem regulären Ausdruck, der sich nicht übersetzen lässt |
GET /api/felder, POST /api/felder (name, typ: text, zahl, betrag, datum, ja_nein, auswahl, link, bei auswahl optionen), PATCH …/:id (name, optionen), DELETE …/:id |
Eigene Felder; der Typ ist fest |
POST /api/dokumente/:id/ordnung (tagsHinzu, tagsWeg, dokumenttyp (ID oder null), korrespondent (ID oder null), felder: [{feldId, wert}]) |
Tags, Dokumenttyp, Korrespondent und Feldwerte setzen; wert null entfernt, ein Betrag in Cent oder als 1.234,56; Antwort der neue Stand; 400 bei ungültigem Wert, 409 nach der Löschung |
POST /api/dokumente/sammeln (ids: 1 bis 500, dazu wie bei ordnung und optional einordnung: wie beim Einordnen, entstanden auch eingang, nurOffene (Vorgabe true)) |
Sammelbearbeitung in einer Transaktion; Antwort ok und ergebnisse je Dokument (ok, eingeordnet oder fehler); scheitert eines, 409 und nichts ist geändert |
GET /api/dokumente/zip?ids=… (1 bis 200 IDs, mit Komma getrennt) |
die Originale als ZIP unter lesbaren Namen (ordnung.md), in der Reihenfolge der IDs; nur sichtbare, unsichtbare fehlen ohne Hinweis; 404, wenn keines bleibt, 413 über 2 GB zusammen |
GET /api/dokumente/:id/datei |
das Original; 409, wenn die Datei fehlt oder ihr Hash nicht mehr stimmt |
GET /api/dokumente/:id/vorschaubild |
Vorschaubild der ersten Seite als JPEG, abgeleitet (dokument.md); 404 ohne, 410 nach der Löschung. In der Liste sagt vorschaubild, ob es eins gibt |
GET /api/dokumente/:id/seiten, GET /api/dokumente/:id/seiten/:nr |
Seitenzahl eines PDFs (anzahl) und eine Seite als JPEG, 200 px breit (höchstens 800 px hoch); nur mit Sitzung, nicht für Prüfer; 503 ohne pdftoppm oder, mit Retry-After, wenn schon vier Seiten gerendert werden und 32 warten |
POST /api/dokumente/:id/seiten (operation: drehen mit drehungen: [{seite, grad: 90 \| 180 \| 270}], entfernen mit seiten, teilen mit nach) |
legt aus einem PDF ein neues Dokument an, beim Teilen zwei (dokument.md); das Original bleibt. Antwort 201 mit {dokumente: [...]}; 400 bei Seiten, die es nicht gibt, oder keinem PDF, 410 nach der Löschung, 422 bei einem PDF, das sich nicht bearbeiten lässt. Nur der Inhaber mit Sitzung |
POST /api/dokumente/zusammenfuegen (ids: 2 bis 20 PDFs in der gewünschten Reihenfolge) |
fügt die PDFs zu einem neuen Dokument zusammen; Antwort 201 mit dem Dokument. Nur der Inhaber mit Sitzung |
GET /api/dokumente/:id/ableitungen |
aus (woraus das Dokument abgeleitet ist) und daraus (was daraus abgeleitet wurde), je mit dokumentId, asn, operation, parameter, position, akteur, erstelltAm; ein Prüfer sieht nur Dokumente seines Zeitraums |
GET /api/dokumente/:id/aehnliche |
bis zu fünf ähnliche Dokumente (dokument.md) mit id, asn, dateiname, titel, mimeType, vorschaubild; ohne gelöschte, ein Prüfer nur in seinem Zeitraum |
GET /api/dokumente/:id/notizen, POST /api/dokumente/:id/notizen (text: 1 bis 5000 Zeichen) |
Notizen (dokument.md), älteste zuerst, ohne zurückgezogene; je id, text, erstelltVon, erstelltAm. Inhaber und Steuerberatung, nicht Prüfer; 409 nach der Löschung |
POST /api/dokumente/:id/notizen/:notiz/zurueckziehen |
blendet eine Notiz aus; wer sie schrieb oder der Inhaber, sonst 404 |
GET /api/dokumente/:id/ansicht |
die Ansicht einer Office-Datei als PDF, abgeleitet; 404 ohne Ansicht (ansicht: false in GET /api/dokumente/:id) |
GET /api/dokumente/:id/archivfassung |
das durchsuchbare PDF eines Scans (PDF/A-2b, dokument.md), abgeleitet, als „… (durchsuchbar).pdf“; 404 ohne (archivfassung: false in GET /api/dokumente/:id), 410 nach der Löschung |
POST /api/dokumente/:id/einordnung (art, entstanden, optional freiwilligBis, titel, korrespondent) |
ordnet ein; die Frist rechnet Belegt nach § 147 AO. korrespondent ist ein Name: ein vorhandener Eintrag der Liste (ohne Groß- und Kleinschreibung) oder ein neuer; er wird dem Dokument zugeordnet |
GET /api/dokumente?gruppe=offen\|pflicht\|freiwillig\|frei\|loeschbar\|geloescht\|erechnung_ungueltig |
nur der Eingang, eine Art der Aufbewahrung, was gelöscht werden darf, die Löschnachweise oder E-Rechnungen, die der KoSIT-Validator abgelehnt hat; ohne gruppe keine gelöschten |
POST /api/mails (multipart, Feld datei: .eml, MBOX, PST oder OST) |
nimmt Mails samt Anhängen auf; Antwort neu und doppelt (Dokument-IDs), anhaengeVorhanden (Anhänge, die schon als Dokument im Archiv lagen; die Mail verweist darauf), bei PST/OST dazu pst (das Dokument der Datei) |
GET /api/dokumente/:id/mail |
Kopf, Text, Anhänge (je dokumentId, dateiname, mimeType, eingebettet und vorhanden: lag schon im Archiv) und Unterhaltung; für einen Anhang mit ausMail |
GET /api/dokumente/:id/vorschlag |
vorschlag: die erste passende aktive Regel oder null; erechnung: Kopfdaten einer erkannten E-Rechnung oder null; zuordnung: Vorschlag der Zuordnungsregeln (korrespondent, dokumenttyp, tags mit Namen, uebersprungen: Regeln über dem Zeitlimit) oder null; gelernt: gelernter Vorschlag (art, korrespondent, dokumenttyp, tags, je mit sicherheit, anzahl und woerter) ohne, was Regel und Zuordnungsregel schon vorschlagen, oder null; ki: Vorschlag des Sprachmodells oder null; Regel und ki mit ordnung (Tags, Dokumenttyp, Korrespondent, Feldwerte mit Namen) oder null; import: titel, korrespondent, entstanden und herkunft aus einem Import (umzug.md) oder null |
GET /api/dokumente/:id/inhalt |
Was der Worker gelesen hat: erechnung (Beträge in Cent), textLaenge, fehler, pruefung (Ergebnis des KoSIT-Validators: gueltig, szenario, fehler, warnungen, meldungen mit stufe, code, text, geprueftAm; null ohne, betrieb.md); null, solange nichts gelesen ist |
GET /api/regeln, POST /api/regeln (name, wenn, dann (Art oder null), optional ordnung: {tags, dokumenttyp, korrespondent, felder: [{feldId, wert}]}), POST /api/regeln/:id/aktivieren, …/deaktivieren |
Regeln; ohne dann braucht eine Regel mindestens einen Tag, Dokumenttyp, Korrespondenten oder Feldwert (400 sonst), ihr Vorschlag hat dann art: null; GET liefert ordnung mit Namen; 409 bei unbekanntem Tag, Typ oder Feld, 400 bei unpassendem Wert |
GET /api/workflows, POST /api/workflows (name, ausloeser: eingang oder eingeordnet, bedingungen, aktionen, anhalten), POST /api/workflows/:id/aktivieren, …/deaktivieren, DELETE /api/workflows/:id, POST /api/workflows/reihenfolge (ids) |
Workflows (workflows.md); lesen Inhaber und Steuerberatung, ändern nur der Inhaber mit Sitzung. bedingungen: quellen, dateinameEnthaelt, betreffEnthaelt, absender, domain, anhangTyp, textEnthaelt, mimeTyp, tags, dokumenttyp (ID oder ohne), korrespondent (ID oder ohne), postfach, unterordner. aktionen (1 bis 20) mit art: tagsHinzu/tagsWeg (tags), dokumenttyp, korrespondent, feld (feldId, wert), notiz (text), webhook, senden (url, dateifeld, optional kopfzeile: {name, wert} und felder: [{name, wert}] mit Platzhaltern; der Wert der Kopfzeile geht nur hinein, GET liefert gesetzt: true; 503 ohne BELEGT_SCHLUESSEL, workflows.md), einordnen (als, entstanden: eingang oder erechnung, optional freiwilligBis, titel, korrespondent, dazu ausdruecklich: true, sonst 400); 409 bei doppeltem Namen oder unbekanntem Tag, Typ, Korrespondenten oder Feld |
GET /api/dokumente/:id/weitergaben |
was die Aktion senden mit dem Dokument getan hat: je workflowName, ziel (Host), stand (offen, gesendet, fehlgeschlagen, entfallen), versuche, letzterVersuch, naechsterVersuch, httpStatus, fehler, gesendetAm; Inhaber und Steuerberatung |
GET /api/workflows/laeufe |
die letzten 50 Läufe, die etwas taten oder scheiterten (?alle=1 auch „trifft nicht“ und „angehalten“), mit workflowName, dokumentId, asn, ergebnis, aktionen, fehler, zeitpunkt |
GET /api/quellen, POST /api/quellen (name, host, port, tls, benutzer, passwort, ordner, art: imap oder jmap), POST /api/quellen/:id/abrufen, …/aktivieren, …/deaktivieren |
Postfächer; das Passwort geht nur hinein; 503 ohne BELEGT_SCHLUESSEL |
POST /api/quellen/:id/aktion (aktion: keine, gelesen, markieren, verschieben, loeschen; ziel, warteStunden, nachSperre, loeschenBestaetigt), GET /api/quellen/:id/ordner, GET /api/quellen/:id/aktionen |
Aktion nach dem Abholen (eingang.md); einstellen und Ordner nur der Inhaber mit Sitzung. ordner liefert je Ordner id und pfad; ziel ist die id (bei IMAP der Pfad, bei JMAP die Mailbox-ID). 400 bei verschieben in einen Ordner, den es nicht gibt, bei löschen oder verschieben in einen Papierkorb (papierkorb in ordner) ohne loeschenBestaetigt: true und bei nachSperre ohne S3; 502, wenn das Postfach nicht erreichbar ist. aktionen liefert stand (offen, erledigt, entfallen, fehlgeschlagen), die letzten 50 eintraege des Protokolls und objektsperre |
GET /api/paperless/quellen, POST /api/paperless/quellen (name, url, token), POST /api/paperless/quellen/:id/starten |
Umzug aus Paperless-ngx über die API (umzug.md), nur der Inhaber mit Sitzung; das Token geht nur hinein; starten antwortet 201 mit dem Lauf, 409, wenn für die Quelle schon einer läuft; 503 ohne BELEGT_SCHLUESSEL |
POST /api/paperless/export?name=… (Körper: das ZIP, höchstens IMPORT_MAX_GB) |
Export aus document_exporter --zip hochladen; 201 mit dem Lauf, 400 ohne ZIP, 413 zu groß, 503 ohne IMPORT_ORDNER |
GET /api/paperless/importe, GET /api/paperless/importe/:id/fehler, POST /api/paperless/importe/:id/abbrechen |
Läufe mit status (wartet, laeuft, fertig, abgebrochen, fehler), gesamt, uebernommen, doppelt, fehler, hinweise; Fehler je Paperless-ID mit Grund; abbrechen hält nach dem laufenden Dokument an |
GET /api/paperless/zuordnungen, POST /api/paperless/zuordnungen (art: dokumenttyp oder tag, name, zielArt), DELETE /api/paperless/zuordnungen/:id |
Zuordnung zur Art für den Import; 409 bei doppeltem Namen |
GET /api/oauth, GET /api/oauth/:anbieter/start?name=&ordner=, GET /api/oauth/rueckkehr |
Postfächer bei microsoft oder google per OAuth verbinden, nur der Inhaber; leitet zum Anbieter und zurück nach /quellen?oauth=… |
GET /api/sperren, POST /api/sperren (grund, von, bis), POST /api/sperren/:id/aufheben |
Sperren |
POST /api/dokumente/:id/loeschung |
beantragt die Löschung (sofort gelöscht nur, wenn das Dokument nie anders als frei eingeordnet war); 409 mit Grund, wenn die Frist läuft, eine Sperre greift oder nicht eingeordnet ist |
GET /api/loeschungen, POST /api/loeschungen/:id/bestaetigen, DELETE /api/loeschungen/:id |
Anträge, Bestätigung durch eine zweite Person (auch die Steuerberatung), Antrag zurückziehen; GET /api/dokumente/:id/datei antwortet danach mit 410 |
GET /api/fristen/uebersicht |
Zahlen für die Seite Fristen |
GET /api/dokumente/:id/verlauf |
Einträge des Audit-Logs zum Dokument (auch Tags, Dokumenttyp, Korrespondent und Feldwerte, mit detail: deren Name; Einordnungen mit detail: ihr Korrespondent, wie er beim Einordnen hieß; Ableitungen mit detail: Operation und richtung: aus oder daraus) und sein Siegel |
GET /api/einstellungen, POST /api/einstellungen (firma, rechtsform, anschrift, verantwortlich, aufbewahrungsort, serverbetrieb, datensicherung, schluesselablage, papierbelege, ergaenzungen, aufsicht) |
Angaben zum Betrieb; ändern nur der Inhaber |
GET /api/verfahrensdoku |
Verfahrensdokumentation mit titel, stand (datum, programm, version), Abschnitten mit ihren luecken, Zahl der luecken und vollstaendig (verfahrensdoku.md) |
GET /api/export?von=JJJJ-MM-TT&bis=JJJJ-MM-TT |
Datenträger (Z3) als ZIP, gestreamt; Inhalt in pruefung.md |
GET /api/zeitstempel, GET /api/zeitstempel/:id/token |
Zeitstempel nach RFC 3161 über die Kette und das Token zum Prüfen mit openssl (auch für Prüfer) |
GET /api/benachrichtigungen, PUT /api/benachrichtigungen (anlaesse: je backup, postfach mit an und tage, kette, loeschung, fristen, workflow mit an, eingang mit an und anzahl; anInhaber, weitereEmpfaenger), POST /api/benachrichtigungen/test |
Benachrichtigungen per Mail (betrieb.md), nur der Inhaber mit Sitzung: eingerichtet, absender, einstellungen und die letzten 50 gesendet (anlass, betreff, empfaenger, gesendetAm, ok, fehler); Testmail an die Empfänger, 503 ohne MAIL_SMTP_URL, 502 bei einem Fehler des SMTP-Servers |
GET /api/kette, POST /api/kette/pruefen |
der letzte gespeicherte Lauf der täglichen Prüfung (lauf: geprueftAm, ok, befunde, befundListe, eintraege, dauerMs, ausgeloestVon, vor dem ersten null) und der neueste Zeitstempel, auch für Prüfer; prüfen sofort (Antwort 201 mit dem Lauf, 409, solange schon ein Lauf prüft) nur der Inhaber mit Sitzung |
GET /api/pruefung |
Befunde zu Hash-Kette, Kopf und Siegeln, ok: true, wenn es keine gibt; mit ?dateien=1 auch jede Datei gegen ihren Hash; bericht mit Zeitpunkt, Prüfwert und Zahlen |
Ein Original liegt unter seinem SHA-256 im Speicher (DOCUMENTS_DIR); den Typ erkennt Belegt am Inhalt, nicht an der
Endung. Die Zeile in dokumente ist ab dem Einfügen versiegelt: Ändern, Löschen und TRUNCATE lehnt Postgres ab,
und die Prüfung findet eine Änderung an den Triggern vorbei.