実行 - ABBYY Documentation

請求書取り込みタスクを実行します。リクエストでは複数のファイルを指定できます。お使いの任意のアプリケーションを使用して文書を処理できます。文書処理アプリケーションを変更するには、タスクの実行時に、適切なアプリケーション識別子とトークンに基づく Authentication ヘッダーを使用します。 ABBYY FlexiCapture for Invoices Cloud は、さまざまな国で発行された請求書を処理でき、幅広い言語にも対応しています。詳細については、Specification セクションを参照してください。各アプリケーションには、請求先の事業部門の国が識別されると適用される、事前定義の処理ルール、キーワード、その他の国固有の設定が用意されています。

受け取る予定の請求書に応じて、正しい地域を指定してください。適切な言語を使用すると、認識精度が大幅に向上します。

HTTP リクエスト

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

{location-id} をサポート対象のロケーションに置き換えてください。

リクエスト本文

リクエスト本文のデータ構造は次のとおりです。

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

field	型	説明
`files[]`	object	必須。処理するファイルのリスト。
`files[].id`	string	必須。file.Upload メソッドのレスポンスで返されたファイル ID。
`files[].token`	string	必須。file.Upload メソッドのレスポンスで返されたファイルアクセストークン。
`region`	string	必須。請求書のリージョン。サポートされているリージョン: `US`: USA、`AU`: オーストラリア、`EU`: 欧州連合諸国、`CA`: カナダ。
`export_format`	string	必須。出力ファイル形式。使用可能な形式は、Specification セクションに一覧表示されています。
`verification_type`	string	必須。検証タイプ。使用可能なタイプ: `NoVerification` — ドキュメントは常に検証なしで処理されます。`Troubleshooting` — 不確かな文字やエラーがある場合に、ドキュメントは検証に送られます。`UserVerification` — ドキュメントは常に検証に送られます。

レスポンス

成功した場合、レスポンス本文には 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

field	型	説明
`id`	string	必須。一意のタスクID。
`number`	string	必須。タスク番号。
`verification_id`	string	必須。このIDは、`https://{cloud-host}/verification/{verification_id}` の検証ページを開くために使用されます。
`type`	string	必須。タスクタイプ。サポートされるタイプ: `ic`: 請求書取り込み、`dc`: 文書取り込み。
`properties`	object	任意。処理設定またはカスタム登録パラメーター。名前と値のペアをいくつでも指定できます。
`email`	string	必須。タスクの作成に使用されたメールアドレス。
`account`	string	必須。タスクの作成に使用されたアカウントID。
`application`	string	必須。タスクの作成に使用されたアプリケーションID。
`created`	string ($date-time)	必須。タスクの作成日。
`started`	string ($date-time)	任意。タスクの開始日。
`action_required`	string ($date-time)	任意。タスクが WaitForAction ステータスになった日付。
`billed`	string ($date-time)	任意。タスクの請求日。
`delivered`	string ($date-time)	任意。タスクの完了日。
`deleted`	string ($date-time)	任意。データの削除日。
`progress`	number ($double)	必須。タスク全体の進捗。
`status`	string	必須。タスクのステータス。サポートされるステータス: `Submitted`、`InProgress`、`WaitForAction`、`Done`、`Failed`、`Canceled`。
`is_deleted`	boolean	必須。タスクデータが削除されたかどうかを示します。
`is_demo`	boolean	必須。タスクがデモアプリケーションで作成されたかどうかを示します。
`is_billed`	boolean	必須。タスクが請求対象となったかどうかを示します。
`documents_count`	integer ($int32)	任意。タスク内のドキュメント数。
`pages_count`	integer ($int32)	任意。タスク内のページ数。
`documents[]`	object (DataCaptureDocumentModel)	必須。タスク内のドキュメント。

DataCaptureDocumentModel

field	型	説明
`files`	object (DataCaptureFileLinkModel)	必須。ドキュメントにリンクされたファイルの一覧。
`data`	string	省略可能。文書データ。
`is_moved`	boolean	必須。検証中にドキュメントが削除されたかどうかを指定します。

DataCaptureFileLinkModel

field	型	説明
`id`	string	必須。ファイル ID。
`token`	string	必須。ファイルアクセストークン。
`name`	string	必須。ファイル名。

管理者ガイド

管理ガイド

パフォーマンスガイド

トラブルシューティング

クラウド

実行

HTTP リクエスト

リクエスト本文

レスポンス

CaptureTask

DataCaptureDocumentModel

DataCaptureFileLinkModel

​HTTP リクエスト

​リクエスト本文

​レスポンス

​CaptureTask

​DataCaptureDocumentModel

​DataCaptureFileLinkModel

HTTP リクエスト

リクエスト本文

レスポンス

CaptureTask

DataCaptureDocumentModel

DataCaptureFileLinkModel