Ausführen - ABBYY Documentation

Führt einen Task zur Rechnungserfassung aus. In der Anfrage können mehrere Dateien angegeben werden. Sie können jede Ihrer Anwendungen verwenden, um das Dokument zu verarbeiten. Wenn Sie die Anwendung für die Dokumentverarbeitung ändern möchten, verwenden Sie beim Ausführen des Tasks den Authentifizierungs-Header mit dem entsprechenden Anwendungsbezeichner und Token. ABBYY FlexiCapture for Invoices Cloud verarbeitet Rechnungen aus zahlreichen verschiedenen Ländern und unterstützt viele Sprachen. Weitere Informationen finden Sie im Abschnitt Spezifikation. Jede Anwendung wendet einen vordefinierten Satz an Verarbeitungsregeln, Schlüsselwörtern und anderen länderspezifischen Einstellungen an, nachdem sie das Land des in Rechnung gestellten Geschäftsbereichs erkannt hat.

Geben Sie die richtige Region für die Rechnungen an, die Sie voraussichtlich erhalten. Die Verwendung der richtigen Sprache verbessert die Erkennungsqualität erheblich.

HTTP-Anfrage

POST https://api-{location-id}.flexicapture.com/v2/task/capture/invoices

Ersetzen Sie {location-id} durch Ihre unterstützte Region.

Request-Body

Der Request-Body enthält Daten in der folgenden Struktur:

{
  "files": [
    {
      "id": "string",
      "token": "string"
    }
  ],
  "properties": {
    "region": "US",
    "export_format": "Xls",
    "verification_type": "NoVerification"
  }
}

Feld	Typ	Beschreibung
`files[]`	object	Erforderlich. Liste der zu verarbeitenden Dateien.
`files[].id`	string	Erforderlich. Die Datei-ID, die in der Antwort der Methode file.Upload zurückgegeben wurde.
`files[].token`	string	Erforderlich. Das Zugriffstoken der Datei, das in der Antwort der Methode file.Upload zurückgegeben wurde.
`region`	string	Erforderlich. Region der Rechnung. Unterstützte Regionen: `US`: USA, `AU`: Australien, `EU`: Länder der Europäischen Union, `CA`: Kanada.
`export_format`	string	Erforderlich. Format der Ausgabedatei. Die verfügbaren Formate sind im Abschnitt Spezifikation aufgeführt.
`verification_type`	string	Erforderlich. Verifizierungstyp. Verfügbare Typen: `NoVerification` (Dokumente werden immer ohne Verifizierung verarbeitet), `Troubleshooting` (Dokumente werden zur Verifizierung weitergeleitet, wenn unsichere Zeichen oder Fehler vorliegen) oder `UserVerification` (Dokumente werden immer zur Verifizierung weitergeleitet).

Antwort

Bei Erfolg enthält der Response-Body eine Instanz von CaptureTask.

{
  "id": "string",
  "number": "string",
  "verification_id": "string",
  "type": "ic",
  "properties": {
    "property_name": "string"
  },
  "email": "string",
  "account": "string",
  "application": "string",
  "created": "YYYY-MM-DDT00:00:00.000",
  "started": "YYYY-MM-DDT00:00:00.000",
  "action_required": "YYYY-MM-DDT00:00:00.000",
  "billed": "YYYY-MM-DDT00:00:00.000",
  "delivered": "YYYY-MM-DDT00:00:00.000",
  "deleted": "YYYY-MM-DDT00:00:00.000",
  "progress": 0,
  "status": "Submitted",
  "is_deleted": true,
  "is_demo": true,
  "is_billed": true,
  "documents_count": 0,
  "pages_count": 0,
  "documents": [
    {
      "files": {},
      "data": {},
      "is_moved": true
    }
  ]
}

CaptureTask

Feld	Typ	Beschreibung
`id`	string	Erforderlich. Eindeutige Task-ID.
`number`	string	Erforderlich. Task-Nummer.
`verification_id`	string	Erforderlich. Diese ID wird verwendet, um die Verifizierungsseite zu öffnen: `https://{cloud-host}/verification/{verification_id}`.
`type`	string	Erforderlich. Task-Typ. Unterstützte Typen: `ic`: Rechnungserfassung, `dc`: Dokumenterfassung.
`properties`	object	Optional. Verarbeitungseinstellungen oder benutzerdefinierte Registrierungsparameter. Beliebig viele Name-Wert-Paare.
`email`	string	Erforderlich. Die E-Mail-Adresse, die zum Erstellen der Task verwendet wurde.
`account`	string	Erforderlich. Die Konto-ID, die zum Erstellen der Task verwendet wurde.
`application`	string	Erforderlich. Die Application ID, die zum Erstellen der Task verwendet wurde.
`created`	string ($date-time)	Erforderlich. Erstellungsdatum der Task.
`started`	string ($date-time)	Optional. Startdatum der Task.
`action_required`	string ($date-time)	Optional. Datum, an dem die Task den Status `WaitForAction` erhalten hat.
`billed`	string ($date-time)	Optional. Abrechnungsdatum der Task.
`delivered`	string ($date-time)	Optional. Abschlussdatum der Task.
`deleted`	string ($date-time)	Optional. Datum der Datenlöschung.
`progress`	number ($double)	Erforderlich. Gesamtfortschritt der Task.
`status`	string	Erforderlich. Abschlussstatus der Task. Unterstützte Status: `Submitted`, `InProgress`, `WaitForAction`, `Done`, `Failed`, `Canceled`.
`is_deleted`	boolean	Erforderlich. Gibt an, ob die Task-Daten gelöscht wurden.
`is_demo`	boolean	Erforderlich. Gibt an, ob die Task in der Demo application erstellt wurde.
`is_billed`	boolean	Erforderlich. Gibt an, ob die Task abgerechnet wurde.
`documents_count`	integer ($int32)	Optional. Anzahl der Dokumente in der Task.
`pages_count`	integer ($int32)	Optional. Anzahl der Seiten in der Task.
`documents[]`	object (DataCaptureDocumentModel)	Erforderlich. Dokumente in der Task.

DataCaptureDocumentModel

Feld	Typ	Beschreibung
`files`	object (DataCaptureFileLinkModel)	Erforderlich. Liste der mit dem Dokument verknüpften Dateien.
`data`	string	Optional. Daten des Dokuments.
`is_moved`	boolean	Erforderlich. Gibt an, ob das Dokument während der Verifizierung entfernt wurde.

DataCaptureFileLinkModel

Feld	Typ	Beschreibung
`id`	string	Erforderlich. Datei-ID.
`token`	string	Erforderlich. Zugriffstoken der Datei.
`name`	string	Erforderlich. Dateiname.