OpenAPI Spec

Die OpenAPI-Datei ist für Integratoren gedacht, die die REST API direkt in API-Tools oder SDK-Generatoren verwenden möchten.

• JSON: /openapi.json

Wofür diese Datei gedacht ist

• Import in Tools wie Postman, Insomnia oder Scalar
• Basis für interne API-Clients und automatisierte Tests
• Schnellüberblick über verfügbare öffentliche Endpunkte

Für eine lesbare, thematisch strukturierte Referenz mit Scope-Anforderungen pro Endpunkt nutze:

• /reference/rest-endpoints

Scope-Modell

Alle Endpunkte verwenden das Format modul:aktion. Die acht Module sind:

ModulScopes

journaljournal:read · journal:write · journal:review

bankbank:read · bank:write · bank:review

debitorendebitoren:read · debitoren:write · debitoren:review

kreditorenkreditoren:read · kreditoren:write · kreditoren:review

anlagenanlagen:read · anlagen:write · anlagen:review

periodenperioden:read · perioden:write

auswertungenauswertungen:read · auswertungen:write

configconfig:read · config:write

adminGlobaler Scope — umfasst alle Modul-/Aktionskombinationen.

Detaillierte Scope-Dokumentation: /start/auth-scopes