PATPOST連携API (1.1)

概要

指定場所（指定キャビネット直下または指定フォルダ）に存在しているフォルダとファイルの一覧を取得します。
検索オプションとして、取得対象の検索方法を指定することができます。

検索オプション

• ID検索："itemId"が完全一致するフォルダおよびファイルの情報を取得します。
• パス検索：フォルダパスが完全一致するフォルダ直下に格納されているフォルダおよびファイルの一覧を取得します。
• 指定なし：対象キャビネット直下のフォルダおよびファイルの一覧を取得します。

制限事項

一度に取得できるフォルダおよびファイルの上限数は合計15,000件となります。超過分は取得対象外となります。

補足事項

レスポンスの"itemList"の並び順は、”modifiedAt”の降順です。

概要

ファイルの基本情報とテンプレートで抽出された単一項目の結果を取得します。
テンプレートの抽出項目のうち明細項目はこのAPIでは取得されません。
明細項目を取得する場合は別API「ファイルの明細項目の抽出結果を取得」をご利用ください。

補足事項

• 本APIはファイルに対してのみ利用可能です。フォルダを指定した場合はエラーとなります。

概要

テンプレートで抽出された明細項目の結果を取得します。
1リクエストでの最大取得件数は100件です。
取得件数が100件を超える場合は、ページ番号を指定して複数回リクエストを行ってください。

概要

指定場所（指定キャビネット直下または指定フォルダ）にフォルダを作成します。
指定場所に同じ名前のフォルダがある場合はエラーとなります。
フォルダごとのアップロードを行う場合は、「ファイルアップロード情報を登録」APIと組み合わせて実装を行ってください。

制限事項

• フォルダ名には次の文字を含めることはできません。 ¥, /, :, *, ?, ", <, >, |

概要

注意：このAPIは2026年10月以降に廃止が予定されています。新規ご利用の場合は新しいAPI（/documents/cabinets/{cabinetId}/files/uploads）をご利用ください。

指定場所（指定キャビネット直下または指定フォルダ）にファイルをアップロードするための情報登録を行います。
登録オプションとして、取引情報項目の内容を指定することで、AI-OCRの読み取り結果にかかわらず、項目情報の一括登録ができます。
指定場所に同じ名前のファイルがある場合はエラーとなります。
APIのレスポンスとして返却される"url"に対して対象ファイルを直接アップロードしてください。
アップロード方法については選択するアップロード方式によって異なります。詳細は「アップロード方法」をご参照ください。

登録オプション

• 書類種別
• 発行・受領
• 伝票番号
• メモ

アップロード方式オプション

• アップロードURLのHTTPメソッド

制限事項

• 対応可能なファイル種別は下記の通りです。

  .csv, .doc, .docx, .jpeg, .jpg, .pdf, .png, .ppt, .pptx, .tif, .tiff, .txt, .xls, .xlsx
  

• ファイル名には次の文字を含めることはできません。 ¥, /, :, *, ?, ", <, >, |
• 1度にアップロード可能なファイルのファイル容量は5GBまでとなります。
• AI-OCRの処理対象は50MBまでのファイルが対象になります。50MBを超過するファイルはAI-OCR処理対象外となります。
• アップロード先のキャビネットで電帳法テンプレートの利用が許可されていない場合はエラーとなります。

アップロード方法

• APIのレスポンスとして返却される"url"に対して対象ファイルを直接アップロードしてください。
• 返却される"url"の有効期限は60秒です。有効期限以内にアップロード処理を開始してください。
• 有効期限が切れた場合は再度APIを実行して"url"を発行してください。
• PUT用とPOST用でアップロードの方法が異なりますので、それぞれ以下の手順に従ってアップロードしてください。

  • PUT用URLの場合（デフォルト）

    • HTTPメソッドはPUTとしてください。
    • リクエストヘッダーには下記を含めてください。
      • Host:[宛先]
      • Content-Length:[ファイルサイズ]
    • 下記リクエストヘッダーは非対応です。
      • Transfer-Encoding
    • サンプルコード

      curl --request PUT \
        --url 'https://orb-essentia-ai-app-prd.s3.ap-northeast-1.amazonaws.com/......' \ # APIのレスポンスで返却された"url"で置き換えてください
        --upload-file './sample.pdf'
      

      ※ ご利用のシステムの仕様によっては、HostとContent-Lengthを手動で設定する必要があります

  • POST用URLの場合

    • HTTPメソッドはPOSTとしてください。
    • リクエストヘッダーには下記を含めてください。
      • Host:[宛先]
      • Content-Length:[ファイルサイズ]
      • Content-Type:multipart/form-data
    • フォームデータとして下記情報をリクエストに含めてください
      • X-Amz-Signature: [APIレスポンスのpostFormData.X-Amz-Signature]
      • X-Amz-Algorithm: [APIレスポンスのpostFormData.X-Amz-Algorithm]
      • X-Amz-Date: [APIレスポンスのpostFormData.X-Amz-Date]
      • X-Amz-Credential: [APIレスポンスのpostFormData.X-Amz-Credential]
      • X-Amz-Security-Token: [APIレスポンスのpostFormData.X-Amz-Security-Token]
      • key: [APIレスポンスのpostFormData.key]
      • policy: [APIレスポンスのpostFormData.policy]
      • file: [アップロードファイルのバイナリデータ]
    • リクエストの最後のフィールドは"file"としてください
    • サンプルコード

      curl -i -X POST \
        -H "Content-Type:multipart/form-data" \
        -F "X-Amz-Signature=XXXX...[省略]...XXXX" \
        -F "X-Amz-Algorithm=AWS4-HMAC-SHA256" \
        -F "X-Amz-Date=20250101T000000Z" \
        -F "X-Amz-Credential=XXXX...[省略]...XXXX/20250101/ap-northeast-1/s3/aws4_request" \
        -F "X-Amz-Security-Token=XXXX...[省略]...XXXX" \
        -F "key=proj/1/11111/XXXX...[省略]...XXXX" \
        -F "policy=XXXX...[省略]...XXXX" \
        -F "file=@\"./sample.pdf\";filename=\"sample.pdf\"" \
      'https://orb-essentia-ai-app-prd.s3.ap-northeast-1.amazonaws.com' # APIのレスポンスで返却された"url"で置き換えてください
      

概要

指定場所（指定キャビネット直下または指定フォルダ）にファイルをアップロードするための情報登録を行います。
指定されたテンプレートIDに紐づくテンプレートで、指定項目抽出AIによる項目抽出処理が実行されます。
電帳法テンプレートを指定した場合は、登録オプションとして取引情報項目の内容を指定することで、AI-OCRの読み取り結果にかかわらず、項目情報の一括登録ができます。
指定場所に同じ名前のファイルがある場合はエラーとなります。
APIのレスポンスとして返却される"url"に対して対象ファイルを直接アップロードしてください。
アップロード方法については選択するアップロード方式によって異なります。詳細は「アップロード方法」をご参照ください。

電帳法テンプレートで利用可能な登録オプション

• 書類種別
• 発行・受領
• 伝票番号
• メモ

アップロード方式オプション

• アップロードURLのHTTPメソッド

制限事項

• 対応可能なファイル種別は下記の通りです。

  .csv, .doc, .docx, .jpeg, .jpg, .pdf, .png, .ppt, .pptx, .tif, .tiff, .txt, .xls, .xlsx
  

• ファイル名には次の文字を含めることはできません。 ¥, /, :, *, ?, ", <, >, |
• 1度にアップロード可能なファイルのファイル容量は5GBまでとなります。
• AI-OCRの処理対象は50MBまでのファイルが対象になります。50MBを超過するファイルはAI-OCR処理対象外となります。

アップロード方法

• APIのレスポンスとして返却される"url"に対して対象ファイルを直接アップロードしてください。
• 返却される"url"の有効期限は60秒です。有効期限以内にアップロード処理を開始してください。
• 有効期限が切れた場合は再度APIを実行して"url"を発行してください。
• PUT用とPOST用でアップロードの方法が異なりますので、それぞれ以下の手順に従ってアップロードしてください。

  • PUT用URLの場合（デフォルト）

    • HTTPメソッドはPUTとしてください。
    • リクエストヘッダーには下記を含めてください。
      • Host:[宛先]
      • Content-Length:[ファイルサイズ]
    • 下記リクエストヘッダーは非対応です。
      • Transfer-Encoding
    • サンプルコード

      curl --request PUT \
        --url 'https://orb-essentia-ai-app-prd.s3.ap-northeast-1.amazonaws.com/......' \ # APIのレスポンスで返却された"url"で置き換えてください
        --upload-file './sample.pdf'
      

      ※ ご利用のシステムの仕様によっては、HostとContent-Lengthを手動で設定する必要があります

  • POST用URLの場合

    • HTTPメソッドはPOSTとしてください。
    • リクエストヘッダーには下記を含めてください。
      • Host:[宛先]
      • Content-Length:[ファイルサイズ]
      • Content-Type:multipart/form-data
    • フォームデータとして下記情報をリクエストに含めてください
      • X-Amz-Signature: [APIレスポンスのpostFormData.X-Amz-Signature]
      • X-Amz-Algorithm: [APIレスポンスのpostFormData.X-Amz-Algorithm]
      • X-Amz-Date: [APIレスポンスのpostFormData.X-Amz-Date]
      • X-Amz-Credential: [APIレスポンスのpostFormData.X-Amz-Credential]
      • X-Amz-Security-Token: [APIレスポンスのpostFormData.X-Amz-Security-Token]
      • key: [APIレスポンスのpostFormData.key]
      • policy: [APIレスポンスのpostFormData.policy]
      • file: [アップロードファイルのバイナリデータ]
    • リクエストの最後のフィールドは"file"としてください
    • サンプルコード

      curl -i -X POST \
        -H "Content-Type:multipart/form-data" \
        -F "X-Amz-Signature=XXXX...[省略]...XXXX" \
        -F "X-Amz-Algorithm=AWS4-HMAC-SHA256" \
        -F "X-Amz-Date=20250101T000000Z" \
        -F "X-Amz-Credential=XXXX...[省略]...XXXX/20250101/ap-northeast-1/s3/aws4_request" \
        -F "X-Amz-Security-Token=XXXX...[省略]...XXXX" \
        -F "key=proj/1/11111/XXXX...[省略]...XXXX" \
        -F "policy=XXXX...[省略]...XXXX" \
        -F "file=@\"./sample.pdf\";filename=\"sample.pdf\"" \
      'https://orb-essentia-ai-app-prd.s3.ap-northeast-1.amazonaws.com' # APIのレスポンスで返却された"url"で置き換えてください
      

概要

アップロード済みのファイルに対して指定項目抽出AI処理を再実行します。
抽出処理は非同期で実行され、リクエストが受理された場合は202ステータスが返却されます。
電帳法テンプレートで処理を行う場合は、付加情報をオプションで指定できます。

電帳法テンプレートで利用可能な登録オプション

• 書類種別
• 発行・受領
• 伝票番号
• メモ

制限事項

• 1ファイルに対して処理できるテンプレートの数は合計5つです。
• 1ファイルに紐づくテンプレートの累積数（削除済みを含む）の上限は10件です。
• 既に処理済みのテンプレートで再処理を行なった場合は、既存の抽出結果が上書きされます。
  • ただし、OCR抽出対象外の項目については上書きされません。

補足事項

再処理依頼を行った後、指定項目抽出処理の完了の判断については別API「ファイル情報を取得」にてファイルの情報を取得し、"attachedTemplates"の中の該当テンプレートの"status"をご確認ください。
PROCESSING から SUCCESS に変わったタイミングで処理完了となります。

概要

キャビネット内で利用可能なテンプレートの一覧を取得します。

補足事項

レスポンスの"templateList"の並び順は、管理者が設定した”displayOrder”の昇順です。

概要

APIキーに紐づくユーザーに対して権限付与されているキャビネット一覧を取得します。
他アカウントから共有されているキャビネット情報は取得対象外です。

制限事項

一度に取得できるキャビネットの上限数は合計15,000件となります。超過分は取得対象外となります。

補足事項

レスポンスの"cabinetList"の並び順は、"cabinetId"の昇順です。