Wie realisiert man kundenspezifische Automatisierungen mit der Finmatics API?

Hintergrund

Mit der REST-API von Finmatics können Sie kundenspezifische Automatisierungen realisieren. Sie können Daten in jeder Phase der Verarbeitungspipeline abrufen und Manipulationen von außen durchführen. Sie haben vollen Zugriff auf OCR- und Feldinformationen. Wie bei einem normalen Benutzer werden die Aktionen eines API-Benutzers im Audit-Trail von Finmatics protokolliert.

In diesem Artikel werden die relevanten API-Endpunkte beschrieben, die erforderlich sind, um eine benutzerdefinierte Automatisierung über die REST-API zu realisieren. Dafür müssen Sie mit der Finmatics REST-API vertraut sein.

Außerdem benötigen Sie einen API-Benutzer. Wenden Sie sich an support@finmatics.com, um einen API-Benutzer zu beantragen.

1. Identifizieren relevanter Dokumente

Zuerst müssen Sie die relevanten Dokumente identifizieren, die Sie ändern möchten. Sie können dies mit dem GET /documents/-Endpunkt tun. Sie erhalten eine Liste von Dokumenten-IDs.

Tipp: Filtern Sie nur nach Dokumenten, die Sie bearbeiten möchten. Folgende Filter können für Sie nützlich sein:

  • Filtern nach Dokumenten, die nicht exportiert werden – Exportiert
  • Filtern nach einem bestimmten Client – Client
  • Filtern nach Dokumenten, die Sie noch nicht bearbeitet haben
    • Verwenden Sie die Felder training__exclude__capture oder training__exclude__complete, die Sie nach der Bearbeitung festlegen können
  • Filtern nach Dokumenten basierend auf der Stufe in der Verarbeitungspipeline – Überprüfungsebene
    • Wenn Sie nur Rechnungen nach der menschlichen Überprüfung durch das gemeinsame Servicecenter bearbeiten möchten, filtern Sie nach Überprüfungsebene.

 2. Abrufen von OCR-Daten einer Rechnung

Nachdem Sie eine Liste der relevanten IDs erhalten haben, können Sie den vollständigen OCR-Text abrufen, der in den Dokumenten vorhanden ist. Verwenden Sie den ENDpunkt GET /documents/’id’/text/, um die Begrenzungsfelder von Wörtern abzurufen, die in einer Rechnung erkannt wurden.

3. Aktualisieren/Korrigieren von Feldinformationen

Um Feldinformationen zu korrigieren/ zu aktualisieren, können Sie die PUT/PATCH-Anforderung verwenden: PUT/PATCH /documents/-id/

4. Markieren der Rechnung als manipuliert

Sie können die Rechnung mit den folgenden Endpunkten als bearbeitet markieren:

training__exclude__capture

training__exclude__complete