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)

Die /match Endpunkte suchen nur im Verwendungszweck, während /search auch in weiteren Feldern, wie Absendername etc. sucht.

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
Findet bei direkter Übereinstimmung
Groß und Kleinschreibung macht kein Unterschied
Resistent gegenüber Tippfehler
Synonym-Erkennung
Wort-Ähnlichkeit
Vektor-Ähnlichkeit
Übergibt Score = Wie wahrscheinlich die Transaktion zur Suche passt

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/<workspaceId>/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/<workspaceId>/transactions?category=325 Kategorie 325 = Mieteinahmen. Gibt nur Transaktionen zurück die eindeutig Mieteinahmen sind. GET https://api.kontoflux.io/<workspaceId>/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.

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.

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.