> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API-Referenz

> Referenz für die FlexiCapture for Invoices Cloud REST API: Endpunkte und Ressourcen für Dateien, Aufgaben, Datensätze für Geschäftsbereiche und Vendors sowie Training.

Die ABBYY FlexiCapture for Invoices Cloud API ist als [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)-API aufgebaut. Mit der API können Sie auf Ressourcen des ABBYY FlexiCapture Cloud Service zugreifen. Nachdem Sie sich registriert und den Header für die Authentifizierung erhalten haben, können Sie Anfragen an die ABBYY FlexiCapture for Invoices Cloud API senden.

Die API verwendet integrierte HTTP-Funktionen wie HTTP-Authentifizierung und HTTP-Verben, die von gängigen HTTP-Clients unterstützt werden.

Das [ABBYY FlexiCapture Cloud-Webportal](https://flexicapture.com) enthält das API-Schema im Swagger-Format. Sie können es verwenden, um mithilfe spezieller Tools, z. B. des [Swagger Editor](https://editor.swagger.io/), Client-Code in der Sprache zu generieren, die Sie für Ihr Projekt verwenden.

<div id="api-endpoint">
  ## API-Endpoint
</div>

<a id="icaas-supported-countries" />

```text theme={null}
https://api-{location-id}.flexicapture.com
```

Ersetzen Sie `{location-id}` durch eine der unterstützten Regionen:

* `us`: USA und Kanada
* `au`: Australien
* `eu`: die Länder der Europäischen Union

<div id="rest-resources">
  ## REST-Ressourcen
</div>

Die folgenden Endpoint-Pfade sind relativ zum oben beschriebenen API-Endpoint.

<div id="v2file">
  ### v2.file
</div>

| Methode                                                                          | Endpoint                         | Beschreibung                                           |
| -------------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------ |
| [Hochladen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-upload-file)       | `POST /v2/file`                  | Laden Sie eine oder mehrere Dateien in die Cloud hoch. |
| [Herunterladen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-download-file) | `GET /v2/file/{id}/{token}`      | Laden Sie eine Datei aus der Cloud herunter.           |
| [Abrufen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-file-metadata)   | `GET /v2/file/{id}/{token}/info` | Gibt Dateimetadaten zurück.                            |
| [Löschen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-delete-file)         | `DELETE /v2/file/{id}/{token}`   | Löschen Sie eine Datei aus der Cloud.                  |

<div id="v2task">
  ### v2.task
</div>

| Methode                                                                 | Endpoint                         | Beschreibung                                           |
| ----------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------ |
| [Ausführen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-run-task) | `POST /v2/task/capture/invoices` | Führen Sie eine Rechnungserfassungsaufgabe aus.        |
| [Abrufen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-task)   | `GET /v2/task/{id}`              | Rufen Sie Aufgabeninformationen anhand der Task ID ab. |
| [Delete](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-delete-task) | `DELETE /v2/task/{id}`           | Löschen Sie Aufgabendaten anhand der Task ID.          |

<div id="v2dataset">
  ### v2.dataset
</div>

| Methode                                                                                                      | Endpoint                                                           | Beschreibung                                                                     |
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | -------------------------------------------------------------------------------- |
| [Geschäftsbereich erstellen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-create-bu)                    | `POST /v2/dataset/businessunits`                                   | Erstellt eine Liste von Geschäftsbereichen.                                      |
| [Geschäftsbereich aktualisieren](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-update-bu)                | `PUT /v2/dataset/businessunits`                                    | Aktualisiert Informationen zu Geschäftsbereichen im Dataset.                     |
| [Geschäftsbereich abrufen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-bu)                         | `GET /v2/dataset/businessunits/{region}`                           | Gibt eine Liste von Geschäftsbereichen für die angegebene Region zurück.         |
| [Geschäftsbereich nach Region entfernen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-b-uby-reg) | `DELETE /v2/dataset/businessunits/{region}`                        | Entfernt Geschäftsbereiche aus der angegebenen Region aus dem Dataset.           |
| [Geschäftsbereich nach ID entfernen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-b-uby-id)      | `DELETE /v2/dataset/businessunit/{region}/{externalId}`            | Entfernt einen Geschäftsbereich mit der angegebenen externen ID aus dem Dataset. |
| [Vendor erstellen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-create-vendor)                          | `POST /v2/dataset/vendors`                                         | Erstellt eine Liste von Vendors.                                                 |
| [Vendor aktualisieren](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-update-vendor)                      | `PUT /v2/dataset/vendors`                                          | Aktualisiert Informationen zu Vendors im Dataset.                                |
| [Vendor abrufen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-vendor)                               | `GET /v2/dataset/vendors/{region}`                                 | Gibt eine Liste von Vendors für die angegebene Region zurück.                    |
| [Vendor nach Region entfernen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-vendor-by-reg)       | `DELETE /v2/dataset/vendors/{region}`                              | Entfernt Vendors aus der angegebenen Region aus dem Dataset.                     |
| [Vendor nach ID entfernen](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-vendor-by-id)            | `DELETE /v2/dataset/vendor/{region}/{externalId}/{businessUnitId}` | Entfernt einen Vendor mit der angegebenen externen ID aus dem Dataset.           |

<div id="v2training">
  ### v2.training
</div>

| Methode                                                                     | Endpoint                                    | Beschreibung                        |
| --------------------------------------------------------------------------- | ------------------------------------------- | ----------------------------------- |
| [Trainieren](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-train-model) | `POST /v2/training`                         | Ein Erfassungsmodell trainieren.    |
| [Layout](/de/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-layout)      | `GET /v2/training/layout/{taskId}/{fileId}` | Layout der erfassten Daten abrufen. |