SteuerMappePro API

Automatisierte Verarbeitung von Steuerunterlagen für Ihre Software-Plattform

API Version 1.0

Die SteuerMappePro API befindet sich aktuell in der Version 1.0. Diese Dokumentation beschreibt alle verfügbaren Endpunkte und Funktionen.

Asynchron & Skalierbar

Batch-basierte Verarbeitung für große Dokumentenmengen mit Echtzeit-Fortschritts-Tracking

DSGVO-konform

Minimale PII-Speicherung, EU-Datenresidenz und vollständige Datenlöschung auf Anfrage

Transparente Abrechnung

Deterministische Kostenberechnung mit Partner-Code-Rabatten und detaillierter Nutzungsübersicht

Entwicklerfreundlich

OpenAPI 3.1 Spezifikation, TypeScript/Python SDKs und umfassende Dokumentation

Kernkonzepte

Organisation & Projekte

Die API ist organisationszentriert. Jede Steuerberatungskanzlei ist eine Organization, die mehrere Projekte erstellen kann (z.B. "DATEV Integration", "Internes Tool"). Jedem Projekt kann ein Partner-Code zugewiesen werden, der automatische Rabatte ermöglicht.

Organization (Steuerberatung Schmidt GmbH)
↳ Project "DATEV 2024" → Partner-Code: ABC123 (15% Rabatt)
↳ API Client → OAuth2 Credentials
↳ Batch (automatischer Rabatt via Partner-Code)

Batch-Verarbeitung

Ein Batch repräsentiert einen Verarbeitungsauftrag mit mehreren Dokumenten. Die Verarbeitung erfolgt asynchron:

  1. 1. Batch erstellen - Uebergabe der Dokumente via kurzlebige Direkt-Download-URLs (vom Client bereitgestellt); die Zielablage wird serverseitig bestimmt
  2. 2. Verarbeitung läuft - Automatischer Start der KI-basierten Analyse
  3. 3. Fortschritt abrufen - Echtzeit-Updates zu Phasen und Dateien
  4. 4. Ergebnis herunterladen - ZIP-Archiv mit strukturierten Daten

Mandant (Optional)

Mandanten sind optionale Kategorisierungsmetadaten. Sie dienen der Organisation von Batches für Endkunden, sind aber nicht die Abrechnungseinheit. Die Abrechnung erfolgt immer auf Organisations-Ebene.

Wichtig: Abrechnungsmodell

Die Abrechnung erfolgt auf Organisations-/Projekt-Ebene, nicht pro Mandant. Alle über ein Projekt erstellten Batches werden der zugehörigen Organization in Rechnung gestellt.

Authentifizierung

Die API verwendet OAuth2 Client Credentials Flow. Nach der Registrierung erhalten Sie:

  • client_id - Ihre eindeutige Client-ID
  • client_secret - Geheimes Token (nur einmal angezeigt!)
  • scopes - Berechtigungen (z.B. batches:write, results:read)

Weitere Details finden Sie im Abschnitt Authentifizierung & Sicherheit.

Basis-URL

https://api.steuermappe-pro.de/v1

Konventionen

API-Namens- & Formatkonventionen

  • JSON-Feldnamen: englisch, snake_case (z. B. batch_id, created_at)
  • Geldbeträge: Strings mit Punkt als Dezimaltrennzeichen und 2 Nachkommastellen (z. B. "12.34")
  • Zeitstempel: ISO 8601 UTC (z. B. "2025-10-06T10:00:00Z")
  • Fehlerformat: Felder error, error_description, optional error_uri

Rate Limits

Standardmäßig gelten folgende Limits:

EndpunktLimit
POST /v1/batches100 req/min
GET /v1/batches/*200 req/min
Gesamt (alle Endpunkte)1000 req/min

Erhöhte Limits verfügbar

Für Enterprise-Kunden sind höhere Rate Limits verfügbar. Kontaktieren Sie unser Sales-Team unter api@steuermappe-pro.de

Nächste Schritte

Benötigen Sie Hilfe?

Unser Support-Team steht Ihnen gerne zur Verfügung.