# Willkommen zur Dokumentation {% hint style="info" %} Kontoflux.io befindet sich aktuell in **Beta-Phase!** \ Funktionalitäten können sich während dieser Zeit ändern. [Mehr zur Beta](/beta-and-early-access/zugang-zum-early-access) {% endhint %} ## Überblick Die Dokumentation bietet einen umfassenden Überblick über die Funktionalitäten und die Verwendung von Kontoflux.io. Erfahre, wie du mithilfe von Kontoflux.io Banktransaktionen automatisieren und in deine Arbeitsabläufe integrieren kannst. Von der Erstellen eines Workspaces, einrichten von Integrationen bis hin zur Nutzung von Schlüsselfunktionen bietet die Dokumentation eine klare Anleitung für eine effiziente und erfolgreiche Nutzung der Plattform. ### Quick-Start Hier eine Liste hilfreicher Links um direkt durchzustarten! {% content-ref url="/pages/C7HJ0fdDR1fDceO9pORS" %} [Step-by-Step Guide](/erste-schritte/step-by-step-guide) {% endcontent-ref %} # Zugang zum Early Access Der Early Access ermöglicht es Nutzern, frühzeitig auf Kontoflux.io zuzugreifen und die Vorteile der automatisierten Banktransaktionen und nahtlosen Integration in ihre Arbeitsabläufe schon heute zu nutzen. Natürlich befindet sich das Produkt noch im Aufbau, so dass der Feature Umfang noch nicht der einer vollen Version entspricht und hier und da könnten Fehler auftauchen.\ \ Im Gegenzug erhalten Nutzer die Möglichkeit die Platform direkt mitzugestalten, Zugriff auf als erster auf neue Funktionen und eine Vergünstigung bei Abschluss einer Subscription.\ \ Erfahre mehr über den Beta-Deal auf unserer Website: ### Am Early Access teilnehmen Melde dich auf unserer Website zum Early Access an. Du erhältst anschließend eine Einladung zum persönlichen Onboarding, sobald wir neue Nutzer auf die Platform lassen. Sobald du ongeboarded wurdest kannst die Software einen Monat lang kostenlos testen. Erfüllt Kontoflux im aktuellen Umfang zu deinen Automationsvorhaben kannst du eine Subscription abschließen und den Beta-Deal nutzen, um von Vergünstigungen zu profitieren. [https://kontoflux.io/#beta](https://bankflux.io/#beta)\ \ Oder fülle das Formular hier aus: {% embed url="" %} ### Ablauf des Early Access und des Onboardings Mit der Anmeldung zum Early Access bist du bei uns auf der **Warteliste**. Wir werden dich dann in den nächsten Tagen kontaktieren und mit dir einen zeitnahen Termin für ein **persönliches Onboarding** vereinbaren. Du erhältst von uns zum Onboarding deinen **Einladungscode**, mit dem du dich auf registrieren kannst. Sobald wir gemeinsam deinen Account eingerichtet haben, kannst du die Software **einen Monat lang kostenlos** testen. Nach dem Testmonat kannst du dann entscheiden, ob du Kontoflux nutzen möchtest und eine Subscription abschließen möchtest. Denke auch an unseren Beta-Deal, um eine Vergünstigung zu erhalten!\ Im Laufe der Beta werden wir bei den Nutzern Feedback einholen, um gemeinsam die Features zu priorisieren. # Step-by-Step Guide Alles was Du wissen musst auf einem Blick. ### 1. Account und Workspace Erstellen Erstelle Dir deinen persönlichen Nutzer Account auf . (Ggf. benötigst du einen [Einladungscode](/beta-and-early-access/zugang-zum-early-access))\ Nach Erfolgreicher Registrierung und Bestätigung deine E-Mail-Adresse folge den Anweisungen um deinen [Workspace](/workspaces-and-account-management/workspaces) zu erstellen. Du kannst hier auch einfach weitere Personen zur [Kollaboration](/workspaces-and-account-management/nutzerrollen-and-berechtigungen) via E-Mail einladen. ### 2. Bankkonten verbinden Verbinde dein erstes Bankkonto. Auf der Unterseite Bankkonten () findest du oben den Button *"*[*Bankkonto hinzufügen*](/konten-anbinden/bankkonten-hinzufugen)*"* die Möglichkeit nach deiner Bank zu suchen und wirst dann über finAPI nach deinen Bank-Login gefragt und löst über deine Bank ein TAN oder 2FA-Verfahren aus, um Kontoflux Zugang zu deinem Konto zu gewähren.\ \ Es werden beim **initialen Import bis zu einem Jahr Transaktionshistorie** der Bankkonten mit übertragen. Das ermöglicht dir sofort mit deinen Transaktionen zu arbeiten. Zukünftige gehen automatisch ein. {% hint style="success" %} Kontoflux.io arbeitet mit dem TÜV-Zertifizierten Third-Party Provider [finAPI.io](https://finAPI.io) um deine Bankkonten sicher anzubinden. {% endhint %} {% hint style="info" %} Du möchtest Kontoflux.io testen ohne ein richtiges Bankkonto zu verbinden?\ Schaue welche [Testmöglichkeiten](/konten-anbinden/demokonto-zum-testen) wir dir bieten. {% endhint %} ### 3. Automationen einrichten Mit Direkt Integrationen, Webhooks und APIs bietet dir Kontoflux.io alles, was du brauchst, um deine Bankkonten und Banktransaktionen zu automatsieren. Auf der Unterseite Automationen () kannst du all das anlegen und verwalten.\ \ Mit [**Direkt Integrationen**](/integrationen/direkt-integrationen) kannst du dir NoCode mit Plug & Play zu verschiedenen Tools deine Transaktionen nach deinen Bedürfnissen bequem übertragen lassen. Füge die Integration aus unserem Katalog hinzu, folge den Anweisungen zum Einrichten und lehne dich entspannt zurück: Einmal innerhalb weniger Minuten eingerichtet laufen unsere Integrationen im Hintergrund.\ \ Über **Webhooks** kannst du Event basiert mit deinen Bankkonten arbeiten: Bei einer neuen Transaktion werden dazugehörige Daten an die Entpunkte deiner Wahl geschickt. So lassen sich eine Vielzahl Softwares einfach anbinden. Für fortgeschrittene Anwendungsfälle ist unsere [**REST-API**](/api/uberblick-api)**.** Sie ermöglicht es dir direkt mit den Daten zu arbeiten und so auch komplexere Automationsvorhaben einfach und effizient zu lösen. ### 4. Lifecycle und Maintenance Fertig! Oder? \ \ Ab hier laufen die wesentlichen Dinge automatisch. **Eine Besonderheit** gibt es jedoch noch: Die PSD2 Regulation die, die Services wie Kontoflux.io erst ermöglicht, erfordert eine neue Autorisierung **alle 90-Tage.** \ \ Aber keine Sorge: dazu findest du im Kontoflux.io bei ausgelaufenen Konten eine entsprechende Meldung und kannst mit einem Klick eine neue Autorisierung starten. Der Prozess ist hier der gleiche wie beim Anbinden eines neuen Kontos: Über finAPI wird ein Login in dein Online-Banking durchgeführt und ggf. ein TAN- bzw. 2FA-Verfahren ausgelöst. \ \ Erfahre mehr über die [Aktualität der Daten](/limitationen-and-sonderfalle/aktualitat-der-daten), [Sonderfälle der Banken](/limitationen-and-sonderfalle/sonderfalle-datenfelder-und-banken) und ob es [Wechselwirkungen](/limitationen-and-sonderfalle/wechselwirkung-softwares-mit-finapi.io) mit anderen finAPI basierenden Softwares für dein Anwendungsfall gibt.
# Account Management Um Kontoflux.io zu nutzen musst dir einen Account erstellen. Mit deinem Account kannst du in beliebig vielen Workspaces Mitglied sein und weitere erstellen. {% hint style="danger" %} Es wird dringend empfohlen, dass **jedes Mitglied** sich mit seiner **geschäftlichen E-Mail-Adresse** registriert und einen **individuellen Account** erstellt. {% endhint %} [Berechtigungen](/workspaces-and-account-management/nutzerrollen-and-berechtigungen) innerhalb des [Workspaces](/workspaces-and-account-management/account-management) sind an den Mitgliedern direkt verknüpft. Außerdem kann bei ausscheiden eines Mitgliedes dieses einfach von einem Workspace-Admin aus dem Workspace entfernt werden und verliert so jeglichen Zugriff. \ \ Bei Verwendung von Sammelpostfächern und geteilten Passwörtern kann dies so nicht gewährt werden und kompromittieren die Sicherheit. ### Erfahre mehr zur Kollaboration: {% content-ref url="/pages/BGvhT1zPgpu58VxDAHpI" %} [Workspaces](/workspaces-and-account-management/workspaces) {% endcontent-ref %} {% content-ref url="/pages/mA1ht3GRl8Lw2kq3pwJO" %} [Nutzerrollen & Berechtigungen](/workspaces-and-account-management/nutzerrollen-and-berechtigungen) {% endcontent-ref %} # Workspaces Kontoflux.io arbeitet in Workspaces. Durch Workspaces steigern wir die Kollaboration mit Team-Mitgliedern aber auch externen Dienstleistern und erhöhen damit die Sicherheit und sorgen für ein angenehmes arbeiten über alle Ebenen deines Automationsvorhaben. Ein Nutzer von Kontoflux.io kann in beliebig vielen Workspaces Mitglied sein und weitere Erstellen. Subscriptions werden pro Workspace abgeschlossen. Im Rahmen der jeweiligen gewählten Subscription kann ein Workspace eine beliebige Anzahl von Bankkonten und Integrationen enthalten.[
](#user-content-fn-1)[^1]\ Innerhalb eines Workspaces kannst du: * Bankkonten anbinden und verwalten * Integrationen anbinden und verwalten * Mitglieder hinzufügen und entfernen * Vergabe von [Rollen und Berechtigungen](/workspaces-and-account-management/nutzerrollen-and-berechtigungen) an Workspace-Mitgliedern * Verwaltung von Einstellungen und Konfigurationen innerhalb des Workspaces #### Mache dich mit unseren Nutzerrollen und Berechtigungen vertraut: {% content-ref url="/pages/mA1ht3GRl8Lw2kq3pwJO" %} [Nutzerrollen & Berechtigungen](/workspaces-and-account-management/nutzerrollen-and-berechtigungen) {% endcontent-ref %} ### Beispiel Workspaces aus der Sicht eines Dienstleisters Unser Beispielhafter Dienstleister richtet Kontoflux.io für mehrere Kunden ein.\ \ Er sieht bei sich folgende Workspaces: * Test Workspace für unseren Dienstleister * Workspace eines Kunden * Workspace eines anderen Kunden Durch die Workspaces ist für Ihn klar getrennt in welchem Projekt er sich befindet und es wird aktiv vermieden, dass er Daten zwischen den Kunden vertauscht. ### Beispiel Workspaces aus der Sicht eines Unternehmens Innerhalb eines unseres Beispiel Unternehmens arbeiten mehrere Mitglieder im selben Workspace. Im Workspace sind folgende Mitglieder: * Mitglied A, ist Workspace-Owner und verwaltet diesen Workspace * Mitglied B, dass Bankkonten authorisiert * Mitglied C, dass Integrationen verwaltet [^1]: # Nutzerrollen & Berechtigungen Jedes Mitglied eines Workspaces kann einer Nutzerrolle für diesen Workspace zugewiesen werden, um bestimmte Berechtigungen und Zugriffsrechte innerhalb des Workspaces zu erhalten. Folgende Nutzerrollen mit jeweiligen Berechtigungen gibt es:
NutzerrolleWorkspace verwaltenFinanz-Daten und -DashboardsBankkonten verwaltenIntegrationen verwaltenMitglieder verwaltenSubscription verwalten
Workspace-Admintruetruetruetruetruetrue
Membertruetruetruetruefalsefalse
Analystfalsetruefalsefalsefalsefalse
Bankingfalsefalsetruefalsefalsefalse
Integratorfalsefalsefalsetruefalsefalse
{% hint style="info" %} Jede Rolle kann beliebig oft besetzt werden. So kann es auch **mehrere Workspace-Admins** geben. {% endhint %} # Abrechnung und Abonnements Unser Service wird pro Workspace abgerechnet. Ein Workspace bucht dabei ein Kontingent anzubindener Bankkonten. Aktuelle Preise und AGBs können der Website entnommen werden. {% hint style="warning" %} Aktuelle Preise und Informantionen können den [Nutzungsbedingungen](https://kontoflux.io/nutzungsbedingungen), der [Website](https://kontoflux.io/) und der [Buchungsseite](https://app.kontoflux.io/upgrade) im Backend entnommen werden. **Diese Seite hier dient nur als Hilfestellung.** {% endhint %} ### Abonnements Unsere Abonnements sind vorallem Verbrauchs-Orientiert. Dabei buchst du deine erwartbare Menge an benötigter, angebundener Bankkonten als Slots im vorraus. Mit der gebuchten Menge werden auch weitere Features frei in sogenanten "Tiers" freigeschaltet: | Basis | Pro | Enterprise | | ----------- | -------------- | --------------------------------------------- | | 1 Bankkonto | 2-3 Bankkonten |

4+ Bankkonten
(bis zu 500 möglich)

| | | | | ### Anzahl gebuchter Bankkonten während der Laufzeit wechseln (Pro-Rata-Verechnung) Du kannst während der Laufzeit die gebuchte Menge **rauf**, als auch **runter** skalieren. \ \ 📈 **Rauf-Skalierung** (Erhöhung der gebuchten Menge während der Laufzeit):\ Die zusätzlich gebuchte Menge wird anteilig mit dem bereits gezahlten Betrag verrechnet, sodass du nur die Differenz für das Upgrade zahlst. \ \ **Neue Features**, die durch das höhere Tier freigeschaltet werden, sind sofort verfügbar. 📉 **Runter-Skalierung** (Reduzierung der gebuchten Menge während der Laufzeit):\ Der bereits gezahlte Betrag wird anteilig auf die reduzierte Leistung angepasst und als Guthaben gutgeschrieben. Dieses Guthaben wird automatisch mit zukünftigen Rechnungen verrechnet, sodass dir kein Nachteil entsteht. Die Änderungen treten sofort in Kraft, und die reduzierte Leistung wird entsprechend angepasst.\ \ Eine Auszahlung dieses Guthabens ist nicht möglich.\ \ Wird dabei ein niedrigeres Tier erreicht, **entfallen die entsprechenden Features unmittelbar**. ### Rechnungen Deine Rechnungen findest du alle unter **Dashboard > Abrechnung** verwalten.\ Dort solltest du am unteren Ende der Seite.\ \ Des weiteren ist dort eine **E-Mail zu Abrechnungszwecken (automatischer Rechnungsversand)** hinterlegt. An diese E-Mail werden die Rechnungen gesendet, als und alle Informationen zum Abonnement und der Abrechnung. ### Abrechnungs-Daten Anpassungen der Rechnungsdetails, wie Adress- oder Steuerdaten (Umsatzsteuer-ID, zB.), kannst du Self-Service im Backend des jeweiligen Workspaces: **Dashboard > Abrechnung verwaltung > Rechnungsinformationen** verwalten. ### **Abrechnungszyklus** Abos können entweder **monatlich** oder **jährlich** abgerechnet werden. {% hint style="success" %} Tipp: Spare mit der **jährlichen Abrechnung** bis zu 30%! \ Genaueres entnehme der [Buchungsseite](https://app.kontoflux.io/upgrade) im Backend. {% endhint %} Das Abrechnungsdatum wird auf Basis des Erstellungsdatums des Abos festgelegt. Bei Änderungen im Abonnement (z. B. Skalierungen) wird der Restbetrag anteilig für den laufenden Zyklus berechnet. ### Kündigung #### **Kündigungsoptionen** Du kannst ein Abonnement jederzeit kündigen. Die **Kündigung erfolgt immer zum Ende des Abrechnungszeitraums**: * Das Abo bleibt bis zum Ende des aktuellen Abrechnungszyklus aktiv. * Es erfolgen keine weiteren Abbuchungen. # Bankkonten hinzufügen Der einfachste Weg ein Bankkonto anzubinden ist direkt über das Kontoflux.io Backend. ### Direkt über das Backend * Rufe auf und logge dich ggf. ein * Stelle sicher dass du im richtigen Workspace bist! * Gehe auf *> Bankkonten* * Klicke oben in der Navigations-Leiste auf "+ Bankkonto" hinzufügen * Suche nach deiner Bank * Folge den Anweisungen im Fenster ### Über den Quick-Connect Link Der [Quick-Connect](/konten-anbinden/quick-connect) Link ist eine zusätzliche und einfache Möglichkeit Bankkonten direkt anzubinden. Er eignet sich besonders um ihn in Anwendungen einzubetten und ist als simpler linearer Prozess gebaut. Ideal um den Anwender, der die Bankkonten pflegt, nicht zu sehr zu verwirren. * Wechsle in den Workspace, zu dem du den Quick-Connect haben willst. * Gehe zum Dashboard * Kopiere den Link aus der Quick-Connect Box, er sieht in etwa so aus: **** * Teile diesen Link mit der Person, die die Konten einpflegt oder bette Ihn in deiner Applikation ein {% hint style="info" %} Der **Quick-Connect** Link verfügt über **URL-Parameter** um automatisch nach einer Bank zu suchen, was den Anwendern sogar einen weiteren Schritt erspart:\ zB.: \*\* \ **Alle Parameter findest du auf der** [**Quick-Connect Seite.**](/konten-anbinden/quick-connect) {% endhint %} {% content-ref url="/pages/Na2fF4pxrU52PKx9OLxP" %} [Quick-Connect](/konten-anbinden/quick-connect) {% endcontent-ref %} # Quick-Connect Konten schnell und bequem aus einer anderen Applikation heraus anbinden. {% hint style="warning" %} Auch bei Verwendung des Quick-Connect Links muss der Nutzer einen Kontoflux.io Account, Member im Workspace sein und eingeloggt sein. Ist er ausgeloggt und ruft den Link auf, wird er nach dem Login direkt zum Quick-Connect weitergeleitet. {% endhint %} # Demokonto zum Testen Wie du Kontoflux testen kannst ohne dabei gleich ein echtes Konto anzubinden. Um die Funktionalitäten von Kontoflux zu testen gibt es von finAPI aus die *finAPI Test Bank*. 1. Folge den Prozess zum Anbinden eines neuen Kontos über den Quick-Connect Link oder dem Backend über den Button "Bankkonto hinzufügen" 2. In der Suche zu deiner Bank Suche nach dem Stichwort "Demo" oder der BIC DEMO0001 # PayPal anbinden Zusätzlich zu Bankkonten können PayPal Accounts zu Kontoflux.io hinzugefügt werden und so in allen Services von Kontoflux.io genutzt und verarbeitet werden.
{% hint style="warning" %} Da PayPal-Konten keine Bankkonten sind **fehlen** dazugehörige Felder, wie zB. **IBAN**. Und andere sind anders zugewiesen. Die **Paypal E-Mail** zB. ist das Feld **AccountNumber** bzw. **CounterpartAccountNumber**. {% endhint %} ### Ein Paypal Konto hinzufügen 1. Entweder direkt über das Kontoflux Backend über den Button "[**Bankkonto hinzufügen**](/konten-anbinden/bankkonten-hinzufugen)" oder den [**Quick-Connect** ](/konten-anbinden/quick-connect)link des Workspaces. 2. Suche nach "PayPal". Es empfiehlt sich hier PayPal "API" zu wählen. 3. Du wirst auf den PayPal Login weitergeleitet und nach deinen Login-Daten gefragt. Ggf. wirst du auch deine Double-Authentification Methode ausführen müssen. 4. Fertig! Deine PayPal Transaktionen liegen nun in Kontoflux.io vor und können weiter verarbeitet werden. ### Fragen rund um Paypal in Kontoflux.io
Kostet es extra PayPal Accounts anzubinden? Wir bieten die PayPal Integration ohne weitere Kosten an. Es wird jediglich ein Bankkonten-Slot in deinem Workspace verbraucht.
Können mehrere PayPal Accounts eingebunden werden? Es können beliebig viele PayPal Accounts einen Workspaces hinzugefügt werden.
# Automatische Synchronisation Lasse deine Transaktionen deiner Bankkonten automatisch synchronisieren. Kontoflux.io ermöglicht dir, Transaktionen automatisch in festgelegten, individuell anpassbaren Intervallen zu synchronisieren. Dies erreichst du, indem du eine Integration erstellst und die Konfiguration abschließt. Nach erfolgreicher Einrichtung kannst du für jede Integration ein individuelles Intervall festlegen, mit dem die Integration deine Transaktionen in die von dir gewählte Software überträgt. Hierbei kannst du **tägliche, wöchentliche oder monatliche Intervalle** auswählen.
### Beschreibung und Optionen der Intervalle | täglich | wöchentlich | monatlich | | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Einmal täglich zu einer wählbaren Uhrzeit von 00:00 bis 23:45 in 15 Minuten abständen. | Einmal wöchentlich zu einem Wochentag deiner Wahl, zu einer Uhrzeit deiner Wahl von 00:00 bis 23:45 in 15 Minuten abständen. | Zu einem bestimmten Tag im Monat (1.-31.) oder explizit den letzten Tag des Monats, zu einer Uhrzeit deiner Wahl von 00:00 bis 23:45 in 15 Minuten abständen. | # Manuelle Synchronisation Die Synchronisation einer Integration kann auch manuell erfolgen. ### Quick-Sync Link (Aktiver Login erforderlich) Der Quick-Sync Link kann in einer Applikation eingebettet werden. Beim Aufrufen der URL wird der Sync gestartet und das Fenster zeigt auch den aktuellen Stand des Syncs bis hin zur Erfolgs oder Fehlermeldung. {% content-ref url="/pages/S1b6qqdptmDJDzi2a8MK" %} [Quick-Sync Link](/konten-synchronisieren/quick-sync-link) {% endcontent-ref %} *** ### JSON Synchronisations-Endpoint (Ohne Login / durch Token geschützt) Wer gern einen komplett eingebetteten Ansatz ohne Absprung zu Kontoflux.io haben möchte, kann den JSON-Synchronisation-Endpoint nutzen. Die URL zum Endpunkt findest du in deiner Integration nach erfolgreichen Einrichten. Dieser Endpunkt liefert eine JSON Antwort über Erfolg oder Fehlschlagen der Synchronisation. {% content-ref url="/pages/8hyyMXVmkJbucq9PtnuG" %} [JSON-Sync Endpunkt](/konten-synchronisieren/json-sync-endpunkt) {% endcontent-ref %} # Quick-Sync Link Starten der Synchronisation aus einer anderen Applikation mit visuellen Feedback
Um die Synchronisation deiner Integration manuell anzustoßen kannst du den Quick-Sync Link (oder stellenweise auch Synchronisations-Link genannt) nutzen. Er lässt sich in anderen Applikationen einbetten oder als Popup öffnen. Du findest den individuellen Quick-Sync Link deiner Integration nach erfolgreichen Einrichten der Integration direkt in der Detail-Ansicht deiner Integration. {% hint style="warning" %} Zum ausführen der Synchronisation muss der Nutzer **eingeloggt** sein! Ist er das nicht, wird er zum Login von Kontoflux.io geführt und landet nach erfolgreichen einloggen direkt beim Quick-Sync. {% endhint %} Der Quick-Sync gibt auch visuelles Feedback über den Status der Synchronisation und zeigt Informationen im Falle einer Erfolgreichen als auch Fehlgeschlagenen Synchronisation. # JSON-Sync Endpunkt Starten einer Synchronisation ohne Login und Absprung zu Kontoflux.io Mit dem JSON Endpunkt zum Synchronisieren kannst du den Sync komplett eingebettet in einer Applikation starten ohne dabei einen Absprung zu Kontoflux.io zu haben.
Du erhältst dabei in der Antwort des JSON Endpunkts auch Informationen über den Status des Syncs und die Menge der übertragenen Transaktionen. {% hint style="warning" %} Das Ausführen des Syncs kann ein paar Sekunden dauern. Der Request wird so lange offen gelassen. Ist der Sync nach 60 Sekunden noch nicht abgeschlossen, gibt der JSON-Endpunkt eine Schätzung zurück, wie lange der Sync dauern wird. {% endhint %} ### JSON Endpunkt Link generieren Du musst zum nutzen des Endpunktes in der Integrationen nach erfolgreichen Einrichten einen Link generieren und kannst Ihn dann zum einbetten kopieren. Dabei wird ein Token generiert und automatisch der URL angehangen. Du kannst jederzeit den Token erneuern oder den Endpunkt gänzlich aktivieren durch Löschen des Tokens. ### Parameter Es funktionieren GET als auch POST Requests an den Endpunkt. Neben den Token, der als GET Parameter mit geschickt wird, sind keine weiteren Parameter notwendig. ### JSON Antwort durchgeführten Sync Sollte der Sync innerhalb einer Minute erledigt sein, käme direkt das Ergebnis des Syncs. ``` { "message": "integration sync finished", "items": 1568, "log": [ "Log Entries...", "... of the Sync ...", "... as Array" ], "combinedLog": "Log Entries as single String" } ``` ### JSON Antwort eingereihter Sync Wenn ein Sync länger als eine Minute dauert, antwortet der JSON Endpunkt mit einer Zeitschätzung zu wann die Daten Synchronisiert sind. ``` { message: "integration is scheduled for sync. Estimate: 1 minute", estimation: 1, unit: "minutes" } ``` # Direkt Integrationen Verbinde ohne eine Zeile Code deine Transaktionen tagesaktuell mit anderen Softwares innerhalb weniger Minuten und automatisiere Direkt deine Bankkonten. {% hint style="info" %} Seite noch im Aufbau. {% endhint %} # Ninox {% hint style="warning" %} Diese Seite ist noch im Aufbau. Weitere Informationen folgen. {% endhint %} ## Quickstart Hier eine Liste von Aktionen um die Integration mit Ninox schnell und einfach durchzuführen. Stelle sicher dass du dich im richtigen Workspace befindest oder erstelle dir einen für dein Automationsvorhaben.\ \ 1.) Verbinde ein Konto mit Kontoflux. Am einfachsten geht das über Bankkonten > Bankkonten hinzufügen \ Zu Testzwecken kannst du das finAPI Test Konto verwenden (Findet sich unter Stichwort: "Demo")\ 2.) Wechsel zu Automationen > Integration > Integration hinzufügen\ 3.) Wähle Ninox\ 4.) Folge den Schritten der Erstkonfiguration\ 4.1.) Füge deinen API-Key aus Ninox hinzu. In Ninox findest du Ihn unter Integrationen. Denk im Falle der Private-Cloud an deine geänderte API Url.\ 4.2) Wähle das **Ninox-Team** und die **Ninox-Datenbank**. Es empfiehlt sich beides vorher anzulegen.\ 4.3) Wähle mind. eine **Ninox-Tabelle**. Kontoflux.io kann dir die Transaktionen und/oder Bankkonten zu Ninox übertragen. Auch hier empfiehlt es sich das Tabellen-Layout vorher anzulegen. Du kannst auch dem Beispiel auf der Konfigurations-Seite folgen. Solltest du Änderungen in Ninox während der Konfiguration gemacht haben, kannst dein aktuelles Tabellen-Layout unter mit dem Button "**Tabellen neuladen**" aktualisieren.\ 4.4) Wähle nun welche **Ninox-Felder** wie von Kontoflux.io zu befüllen sind. Auf der linken Seite findest Du deine Ninox-Felder, auf der rechten Seite wie Kontoflux.io diese zu befüllen hat. Initial schlägt Kontoflux die Felder KI-basiert vor. Wähle "**Do nothing/Tue nichts**" für Felder, die nicht auszufüllen sind.\ 4.5) Du hast die Konfiguration abgeschlossen!\ 5.) Teste deine Integration: Du findest unten einen Button "**Testdaten senden**". Mit diesem wird eine Fake-Transaktion geschickt, bei der du auch alle Parameter anpassen kannst. Praktisch, um gewisse IBAN oder Verwendungszwecke zu testen.\ 6.) Prüfe ob alle Felder korrekt in Ninox ankamen. Fahre fort, sobald das sicher gestellt ist.\ 7.) Wähle dein gewünschtes **Interval,** solltest Du automatisch die Transaktionen zu Ninox geschickt bekommen wollen.\ 8.) Für **manuelle Syncronisationen** rufe den [Quick-Sync-Link](/konten-synchronisieren/quick-sync-link) in einem neuen Fenster auf oder hinterlege Ihn in einem Button in deiner Ninox Instanz. Fertig! Nun solltest du deine Transaktionen deiner Bankkonten nach deinen Präferenzen in Ninox vorfinden. {% hint style="info" %} Die **erste Synchronisation** beinhaltet **alle Transaktionen**, die noch nicht zu Ninox übertragen wurden. Erfahrungsgemäß ist das ein gutes Jahr Historie deines Kontos. Wundere dich nicht, das daher der erste Sync so viele Transaktionen beinhaltet. {% endhint %} Es gibt noch weitere Möglichkeiten Kontoflux.io noch tiefer in Ninox zu Integrieren, auf dieser Seite findest du weitere Beispiele.
## Snippets ### Ninox-Button: Script zum anstoßen des JSON-Endpunkts mit Feedback Mit dem JSON Sync könnt Ihr direkt hinter einem Ninox-Button die Synchronisation der Ninox Integration ausführen und erhaltet für alle Szenarien im JSON eine Antwort.\ \ **Vorteil:** Hierfür muss sich der Nutzer **nicht anmelden** und alles passiert **direkt in Ninox**. Tipp: Kopier dir deine URL zum JSON-Endpunkt direkt von deiner Ninox Integration aus Kontoflux herraus. Mehr zum [JSON-Sync Endpunkt](/konten-synchronisieren/json-sync-endpunkt). ``` let url := "https://sys-api.kontoflux.io/v1/WorkspaceID/integrations/IntegrationsID/sync/json?token=GeheimerToken"; let response := http("POST", url, { 'content-type': "application/json" }, {}); if response.result.finished then if response.result.status = "success" then if response.result.items > 0 then alert("Transaktionen synchronisiert! Es wurden " + response.result.items + " Transaktionen übertragen.") else alert("Es gab keine neuen Transaktionen zu übertragen.") end else alert("Es gab einen Fehler beim Versuch neue Transaktionen zu übertragen. Bitte wende dich an deinen Administrator.") end else alert("Synchronisation wurde gestartet und benötigt noch ca. " + response.result.estimation + "Minuten.") end ``` ### Ninox-Button: Konto im Pop-Up-Style einbinden (Paypal-Feeling)

Kontoanbinden als Pop-Up

Diese Variante sorgt für ein mehr Integriertes Feeling der Kontoflux.io Integration. Der Nutzer muss logischer Weise immer noch eingeloggt sein. Falls der Nutzer das nicht ist, wird er zum Login aufgefordert und an entsprechende Stelle weitergeleitet. \*\*\* **WorkspaceID ist im Script nach window\.open in die URL einzutragen ! \*\*\*** **Außerdem können die Ninox-Felder IBAN, BIC oder Name mit übertragen werden, damit die Bank direkt gefunden werden kann. Wenn nicht verwendet, kann die Parameter aus der URL entfernt werden.** ``` html(---
Konto Verbinden
---) ``` # Überblick API Nutze unsere REST-API um deine Bank- und Transaktionsdaten einfach in anderen Prozesse und Tools zu integrieren. Hier sind alle Informationen die du benötigst um mit unserer API direkt durchzustarten. ### Links 👆Interaktive Dokumentation: 📜 OpenAPI Spezifikation: [🧑‍🚀](https://emojipedia.org/astronaut) Postman Collection: 🌳 API-Root: ### Verfügbarkeit ✅ Für alle Abonnements uneingeschränkt verfügbar. ### Authentifizierung Zur Authentifizierung wird ein gültiger API-Key benötigt. Erfahre hier wie du dir deinen API-Key erstellen kannst: {% content-ref url="/pages/xVHiPs7nJcpyl0HhrSjk" %} [Zugang zur API](/api/zugang-zur-api) {% endcontent-ref %} ### Rate-Limits und Pagination * Die Nutzung ist nicht auf ein monatliches Volumen beschränkt. * Es liegt ein Rate-Limit von 100 Requests pro Minute vor. * Pagination erfolgt über den **Offset** und **Limit** Parameter (Bei 100er Limit wäre Seite 2 Offset=100) * Um die totale Menge der Daten zu erhalten ist bei jedem Request der **Header X-Total-Count** gesetzt. Nützlich um die maximale Anzahl an Pagination zu ermitteln. # Zugang zur API Der Zugang zur API erfolgt über API-Key-Authentifizierung. Zusätzlich wird für jeden Endpunkt die Workspace-ID benötigt. {% hint style="info" %} Die API findest du unter [**https://api.kontoflux.io**](https://api.kontoflux.io)\ Zur **Authentifizierung** wirst du einen gültigen **API Key** zu deinem Workspace benötigen. {% endhint %} ### API-Key Generieren 1. Gehe im Kontoflux.io Backend zum Bereich **Automationen** [(**https://app.kontoflux.io/automations/api)**](https://app.kontoflux.io/automations/api) 2. Wähle ggf. den Tab **"API"** 3. **Erstelle** dir einen neuen API-Key 4. Wähle die **Optionen** für deinen gewünschen API-Key und erstelle Ihn. \ Du kannst hier vor allem den Zugang zu bestimmen Resourcen, wie Bankkonten oder Endpunkte, die dieser API-Key erreichen einschränken. 5. Kopiere dir den API-Key und verwahre Ihn sicher! Er gewährt Zugang zu deinen Daten. {% hint style="danger" %} **API-Keys** gewähren kompletten, oder je nach Einstellungen: eingeschränkten Zugang, zu deinen Bank- und Transaktionsdaten. Lege Ihn nur auf absolut vertrauenswürdigen Orten und Softwares ab und teile Ihn nur mit Personen, die auf den Zugriff dieser Daten berechtigt sind. {% endhint %} # Transaktionen filtern Hier eine kleine Übersicht an API-Abfragen, die verschiedene Filtern deiner Transaktionen der Kontoflux.io API schnell am Beispiel sehen zeigen. ### Matching Endpunkt für Transaktionserkennung Neben der regulären Freitext-Suche Endpunkte (.../search) verfügt die Kontoflux.io API über einen Endpunkt der speziell für Transaktionserkennung trainiert ist. (...*/match)* {% hint style="info" %} Die **/match** Endpunkte suchen nur im Verwendungszweck, während **/search** auch in weiteren Feldern, wie Absendername etc. sucht. {% endhint %} Die Matching Endpunkte geben dir für Ergebnis ein Score zwischen 0.0 und 1.0. Wobei ein Score von 1.0 einen direkten Treffer entspricht und alles darunter eine Wahrscheinlichkeit angibt, wie sehr der Verwendungszweck zur Suche passt. Die verwendeten Suchalgorithmen sind hier speziell für Fälle wie Rechnungserkennung, Mietererkennung, Zahlungsreferenzen oder jegliche Information, du die möglichst exakt über den query Parameter übergibst übereinstimmen sollten.
Funktion/search/match
Freitext Suche truetrue
Findet bei direkter Übereinstimmungtruetrue
Groß und Kleinschreibung macht kein Unterschiedtruetrue
Resistent gegenüber Tippfehlerfalsetrue
Synonym-Erkennungfalsetrue
Wort-Ähnlichkeitfalsetrue
Vektor-Ähnlichkeitfalsetrue
Übergibt Score
= Wie wahrscheinlich die Transaktion zur Suche passt		falsetrue
### Transaktionen mit der KI-Kategorisierung filtern Jeder der Transaktions-Endpunkte ist in der Lage über die Parameter `category` und `parentCategory` deine Transaktionen zu filtern. Hierdurch ergeben sich besonders praktische Kombinationen.\ \ Es muss die **Category ID** übergeben werden **ODER der exakte Name** der Kategorie. `GET https://api.kontoflux.io//transactions?parentCategory=Einnahmen`\ Alle Einnahmen, auch die wo category etwas detailierteres Beschreibt, also zB. auch Mieteinahmen. Also wo category=Mieteinnahmen & parentCategory=Einnahmen sind. `GET https://api.kontoflux.io//transactions?category=325`\ Kategorie 325 = Mieteinahmen. Gibt nur Transaktionen zurück die eindeutig Mieteinahmen sind.\ \ `GET https://api.kontoflux.io//transactions/match?query=Mustermann&category=325`\ Gibt alle Transaktionen die eindeutig Mieteinahmen sind und im Verwendungszweck in irgendeiner Weise (Auch Tippfehler-Resistent) was mit "Mustermann" zu tun hat. zB. zum Matchen ob Herr Mustermann seine Miete bezahlt hat. {% hint style="info" %} Das **Kategorie**-Feld gibt eine sehr detailierte Eingliederung der Transaktion vor.\ Das **Eltern-Kategorie**-Feld, oder auch **Hauptkategorie** ist eine breitere, gröberer gefächerte Einordnung der Transaktion.\ \ Ist keine passende "Unterkategorie" einer Transaktion gefunden, bleibt parentCategory leer und die gröbere Kategorie rutscht in die category spalte der Transaktion. {% endhint %} #### Zusammenspiel der category und parentCategory Parameter in der API | Nur "category" übergeben | Nur "parentCategory" übergeben | "category" + "parentCategory" übergeben | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Kategorie kommt exakt als *"category"* der Transaktion vor. *"parentCategory"* hat keine Auswirkung. | Kategorie kommt entweder als *"category"* oder *"parentCategory"* für die Transaktion vor. | Kategorie muss exakt mit *"category"* UND *"parentCategory"* muss ebenfalls mit der übergebenen Hauptkategorie der Transaktion übereinstimmen. | | Ziel: Nach detailierteren Kategorien suchen. (zB. ist *Hotel & Übernachtung* eine Unterkategorie von *Reisen*) | Ziel: Überfassende a.k.a. parentCategories nutzen um eine breitere Auswahl an Transaktionen zu erhalten. | Ziel: Innerhalb der Elternkategorie / Hauptkategorie nach der detailierteren Kategorie suchen. | | | Ist keine detailiertere Kategorie für eine Transaktion gefunden, wird die breiter gefächerte Elternkategorie in das category Feld geschrieben und parentCategory bleibt leer. Daher wird bei übergebener parentCategory in beiden Feldern gesucht. | | # Interaktive API Dokumentation Verbinde dich einfach mit einem gültigen API-Key und deiner Workspace-ID über deinen Browser und teste interaktiv mit unserer OpenAPI basierten Dokumentation. {% hint style="info" %} Öffne den API Root ([**https://api.kontoflux.io**](https://api.kontoflux.io)) für eine interaktive und steht's aktuelle API-Dokumentation. {% endhint %} {% embed url="" %} ### Du suchst Möglichkeiten die API Direkt zu importieren? | OpenAPI Specification | Postman Collection | | ----------------------------------------------------- | ----------------------------------------------------- | | [OpenAPI.json](https://api.kontoflux.io/openapi.json) | [Postman.json](https://api.kontoflux.io/postman.json) | # API Snippets Eine Sammlung von Snippets in gängigen Tools für Beispiele mit der Kontoflux API ### Airtable #### Airtable Script Rechnungs als Bezahlt prüfen Ziel des Scriptes ist es den Zahlungs einer Rechnung anhand der Rechnungsnummer zu prüfen. Rechnungen werden hier in Airtable verwaltet. Über den [transactions/match](https://api.kontoflux.io/#/operations/matchTransactions) Endpunkt können wir hier einfach und zuverlässig mit speziellen Matching Algorithmen bauen – die uns sogar ein Confidence Score übermitteln, den wir nutzen um sicherzustellen, dass nur relevante Ergebnisse einbezogen werden.\ \ Danach Updaten wir in Airtable-Manier unsere Datensätzen, sobald sicher gestellt wurde, dass die Rechnungen mit einer Transaktion übereinstimmen.
```typescript const invoice = input.config(); // invoice.invoiceNumber, recordId, amount let response = await fetch('https://api.kontoflux.io/v1/yourWorkspaceId/transactions/match?query='+encodeURI(invoice.invoiceNumber), { method: 'GET', headers: { 'Content-Type': 'application/json', 'Authorization': 'sk-y0ur-ap1-k3y' }, }); let transactions = await response.json(); transactions.forEach((transaction)=>{ if(transaction.score > 0.85){ // only if the probabillity is high enough if(Math.abs(transaction.amount) == invoice.amount){ // even the amount matches, fantastic! return output.set("recordId", invoice.recordId); } else { // might notify that the amount paid is mismatching the invoice amount } } }); ``` ### Ninox #### Ninox Script Rechnungseingang prüfen Ziel des Scriptes ist es den Zahlungseingang einer Rechnung anhand der Rechnungsnummer zu prüfen. Rechnungen werden hier in Ninox erstellt und verwaltet. Über den [transactions/match](https://api.kontoflux.io/#/operations/matchTransactions) Endpunkt können wir hier einfach und zuverlässig mit speziellen Matching Algorithmen bauen – die uns sogar ein Confidence Score übermitteln, den wir nutzen um sicherzustellen, dass nur relevante Ergebnisse einbezogen werden. # Aktualität der Daten Auf den Bankkonten sind die Daten am aktuellsten. Hier die Informationen mit welchen Verzögerungen zu rechnen ist, bis die Daten synchronisiert sind. Wenn du die Transaktion auf deinem Bankkonto hast braucht es eine gewisse Zeit, bis Sie komplett verarbeitet sind und für andere Softwares bereitstehen oder automatisch synchronisiert werden. {% hint style="info" %} Grundsätzlich sind die Daten in Kontoflux.io **tagesaktuell**. {% endhint %} | Bank | finAPI | Kontoflux.io | Automationen | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Sofort, sobald gebucht. |

Feste Abholungszeiten Aufgrund von Regulation

08:00 Uhr
10:00 Uhr
12:00 Uhr
16:00 Uhr

| Sobald bei finAPI verfügbar. Kleinere Zeitverzögerung durch Verarbeitungszeit möglich. (max. Minuten) |

Sobald in Kontoflux.io sichtbar, für Integrationen und API verfügbar.

Webhooks werden getriggert in batches, sobald Transaktionen bekannt sind.

Bei Integrationen: je nach Einstellung des Syncs

| | Achtung! In manchen Fällen wird die Buchung als Vorschau gezeigt, ist aber noch nicht komplett durchgebucht bei der Bank. | | | | ### Am Beispiel durchlebt Du hast eine Buchung um **8:05** erhalten, deine Bank zeigt Sie sofort an.\ Um **10:00** holt finAPI neue Daten ab.\ Gegen **10:01** hat Kontoflux.io alle Informationen.\ Wir haben unsere Integration auf **10:15** automatisch gestellt, um Transaktionen garantiert zu übertragen. # Wechselwirkung Softwares mit finAPI.io Die PSD2-Regulation und so wie finAPI.io funktioniert bringen eine Limitation mit sich, die den Reibungslosen Ablauf von Kontoflux.io stören können.\ \ Hier eine Liste der Softwares, bei denen uns bekannt ist, das finAPI.io auch im Einsatz ist und welche Symptome in Kombination beider (Fremdsoftware und Kontoflux.io) zu erwarten sind. | Software | Verwendung von finAPI | Wechselwirkung zu Kontoflux | | -------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DATEV | Betrifft nur das abholen der Transaktionen der Bankkonten. Das passiert bei DATEV auf Knopfdruck. | Sobald bei DATEV das Konto angefragt wird, fliegt die Autorisierung bei Kontoflux.io raus und muss erneuert werden. Das ist bei Kontoflux.io für das manuelle Synchronisieren fester Bestandteil, insofern dürfte das vorallem Nutzer der automatischen Synchronisation betreffen. | | | | | | | | | # Sonderfälle Datenfelder und Banken Von Bank zu Bank kann es Unterschiede in den übermittelten Daten geben. Hier Listen wir uns bekannte Fälle. Kontoflux.io verbindet sich mit den Bankkonten bei deiner Bank, dabei bleiben die Daten von deinen Transaktion unverändert. Es kann von Bank zu Bank unterschiedlich sein in welchem Umfang Daten zu deinen Transaktionen uns zur Verfügung gestellt werden. Die Gute Nachricht: Das sind in der Regel marginale Unterschiede und stören dich sicherlich nicht in der Automation deiner Bankkonten.
FeldSonderfälleBetroffene Banken

Buchungsdatum

bookingDate
Das Buchungsdatum enthält nur den Buchungstag, keine Zeit-Information.
(zB. 2023-12-04, bzw. 2023-12-04T00:00:00)		Alle Banken

Wertstellungsdatum

valueDate
Tag der Wertstellung, keine Zeit-Information.
(zB. 2023-12-04, bzw. 2023-12-04T00:00:00)		Alle Banken

Verwendungszweck

purpose
Zusätzliche Infos im Verwendungszweck, wie zB. IBAN, BIC, Ausführungsdaten und verwendete PINManche Volksbanken

Type

type
Wird nicht übermittelt, bleibt LeerManche Volksbanken