Dieser Artikel ist relevant für System-Admins sowie IT-Personal.
Dieses Feature ist Teil unserer erweiterten Pakete. Möchten Sie Ihre Abläufe noch effizienter und ohne manuellen Aufwand gestalten? Dann wenden Sie sich einfach an Ihren Customer Success Manager – wir beraten Sie gerne zur Export API.
Was ist die Export-API
Die finway Expense Export API ist eine serverseitige, strikt schreibgeschützte REST-API für den automatisierten Export von CSV-Dateien. Der Ablauf ist asynchron. Durch den automatisierten Export der Standard-CSV-Datei können Sie die Informationen anschließend in Ihre eigenen BI-Plattformen einlesen.
Voraussetzungen
Die Export-API ist ein kostenpflichtiges Feature, welches bestellt werden muss.
Für die Einrichtung der API ist zwingend IT-Technisches Personal erforderlich.
Für die API-Nutzung wird ein API-Schlüssel aus finway benötigt; der Schlüssel beginnt mit
fwk_live_und kann durch einen Systemadmin in den Systemeinstellungen abgerufen werden. Der API-Schlüssel wird einmalig angezeigt und kann später nicht erneut aufgerufen werden. Der API-Schlüssel ist ein Jahr gültig und muss nach Ablauf erneuert werden.Die API-Host-URL wird tenant- bzw. umgebungsspezifisch von finway bereitgestellt.
So funktioniert die Export-API
Mit
POST /v1/exports/expenseseinen Export für eine Gesellschaft und einen Datumsbereich anstoßen.Mit
GET /v1/exports/expenses/{exportId}den Status regelmäßig abfragen, bis done oder failed erreicht ist.Über den Download-Endpunkt die fertige ZIP-Datei mit der CSV-Datei abrufen.
Was exportiert wird
Exportiert werden Ausgabedaten im selben fachlichen Format wie beim Standard-finway-CSV-Export.
Gefiltert wird nach dem Leitungsdatum.
Das Ergebnis ist ein ZIP-Archiv mit genau einer CSV-Datei. Optional können archivierte Anträge über
includeArchivedeinbezogen werden.
Was nicht enthalten ist
Die API verändert keine Daten in finway und unterstützt ausschließlich den Ausgabedatenexport.
Pro Gesellschaft darf höchstens ein Export gleichzeitig verarbeitet werden. Bei parallelen Anfragen wird
429 Too Many Requestszurückgegeben.
Technische Referenz
Endpunkte und Beispiel-Payloads
Methode und Pfad | Verwendung | Erfolgsantwort |
POST /v1/exports/expenses | Asynchronen Ausgabenexport starten. | 202 Accepted mit exportId und Status: pending |
GET /v1/exports/expenses/{exportId} | Status eines Export-Jobs abfragen. | Status pending, done oder failed |
GET /v1/exports/expenses/{exportId}/download | Fertiges Exportarchiv herunterladen. | ZIP-Archiv mit einer CSV-Datei |
Request-Felder
Feld | Typ | Beschreibung |
companyId | String | ID der Gesellschaft, für die exportiert wird. |
from | String, Datum | Startdatum des Kaufdatumsfilters, inklusive; Format YYYY-MM-DD. |
to | String, Datum | Enddatum des Kaufdatumsfilters, inklusive; Format YYYY-MM-DD. |
includeArchived | Boolean | Optional: archivierte Belege oder Dokumente einbeziehen. |
HTTP-Statuscodes und Fehlerbehandlung
Status | Bedeutung und empfohlene Aktion |
400 | Ungültige Anfrage, zum Beispiel fehlende oder falsch formatierte Felder prüfen. |
401 | Authentifizierung fehlgeschlagen; API-Schlüssel und Authorization-Header prüfen. |
403 | Gesellschaft ist für den API-Schlüssel nicht freigegeben oder deaktiviert. |
404 | Gesellschaft nicht gefunden oder keine Ausgaben im gewählten Zeitraum. |
422 | Export überschreitet das zulässige Größenlimit; Zeitraum verkleinern. |
429 | Für die Gesellschaft läuft bereits ein Export; Retry-After beachten und später erneut versuchen. |
500 | Interner Serverfehler; Anfrage später wiederholen oder Finway Support kontaktieren. |
API-Schlüssel
Die API Host URL lautet: https://api.finway.de
Der API-Schlüssel wird in den Systemeinstellungen-API-Schlüssel durch einen System-admin abgerufen.
Der API-Schlüssel wird einmalig angezeigt und kann später nicht erneut visualisiert werden.
Es können nicht mehr als 2 API-Schlüssel aktiv sein.
Ablauffrist: Ein API-Schlüssel läuft automatisch 12 Monate nach seiner Erstellung ab.
Benachrichtigungen: Der Benutzer, der den Schlüssel erstellt hat, wird rechtzeitig per E-Mail über den bevorstehenden Ablauf informiert. Diese Erinnerungen werden 30 Tage, 7 Tage und 1 Tag vor dem Ablaufdatum versendet.
Im Anhang finden Sie die detaillierte Anleitung, um die API durch technisches Personal einrichten zu können.
zuletzt bearbeitet 20.08.2026