APIキー方式および、アクセス元IPアドレスでの認証機能を提供しています。
APIキーの発行につきましては、「お問い合わせフォーム」からまたは、担当営業までご連絡ください。
GET /cabinets
HTTP/2
x-api-key: YOUR_API_KEY
2025-07-23 PATPOST画面へアクセスするためのリンクURLを変更しました。
2025-07-09 PATPOSTのシステム間連携機能のAPI仕様を公開しました。
指定場所（指定キャビネット直下または指定フォルダ）に存在しているフォルダとファイルの一覧を取得します。
検索オプションとして、取得対象の検索方法を指定することができます。
一度に取得できるフォルダおよびファイルの上限数は合計15,000件となります。超過分は取得対象外となります。
レスポンスの"itemList"の並び順は、”modifiedAt”の降順です。
| cabinetId required | integer <int32> キャビネットID |
| itemId | string Example: itemId=SOlNCKMByiVliEzPAJfS ID検索（オプション）.対象フォルダまたはファイルのアイテムIDを指定してください。パス検索と同時に指定することはできません。 |
| path | string Example: path=FOLDER1/フォルダ2/ パス検索（オプション）. ID検索と同時に指定することはできません。 |
{- "itemList": [
- {
- "itemId": "IWlPCI4ByiVliEzPPJfl",
- "itemName": "sample1.xlsx",
- "isFolder": false,
- "modifiedAt": "2024-04-01T10:00:00Z",
- "lastModifiedBy": "PATPOST 太郎",
- "size": 256,
- "path": "folder1/",
}, - {
- "itemId": "JKWEI4BTiVlialsPJeA",
- "itemName": "sample2.xlsx",
- "isFolder": false,
- "modifiedAt": "2024-04-03T15:00:00Z",
- "lastModifiedBy": "PATPOST 花子",
- "size": 516,
- "path": "folder1/",
}, - {
- "itemId": "SOlNCKMByiVliEzPAJfS",
- "itemName": "folder2",
- "isFolder": true,
- "modifiedAt": "2025-11-01T10:00:00Z",
- "lastModifiedBy": "PATPOST 太郎",
- "size": 0,
- "path": "folder1/",
}
], - "totalCount": 3
}指定場所（指定キャビネット直下または指定フォルダ）にフォルダを作成します。
指定場所に同じ名前のフォルダがある場合はエラーとなります。
フォルダごとのアップロードを行う場合は、「ファイルアップロード情報を登録」APIと組み合わせて実装を行ってください。
¥, /, :, *, ?, ", <, >, || cabinetId required | integer <int32> キャビネットID |
| folderName required | string [ 1 .. 250 ] characters ^[^¥¥¥/:¥*¥?¥"<>¥|]+$ フォルダ名 |
| parentFolder | string non-empty 親フォルダのアイテムID（オプション）.指定なしの場合は指定キャビネットの直下に作成されます。 |
{- "folderName": "SAMPLE_FOLDER"
}{- "itemId": "JKWEI4BTiVlialsPJeA"
}指定場所（指定キャビネット直下または指定フォルダ）にファイルをアップロードするための情報登録を行います。
登録オプションとして、取引情報項目の内容を指定することで、AI-OCRの読み取り結果にかかわらず、項目情報の一括登録ができます。
指定場所に同じ名前のファイルがある場合はエラーとなります。
APIのレスポンスとして返却される"url"に対して対象ファイルを直接アップロードしてください。
アップロード方法については選択するアップロード方式によって異なります。詳細は「アップロード方法」をご参照ください。
.csv, .doc, .docx, .jpeg, .jpg, .pdf, .png, .ppt, .pptx, .tif, .tiff, .txt, .xls, .xlsx
¥, /, :, *, ?, ", <, >, |PUT用URLの場合（デフォルト）
curl --request PUT \
--url 'https://orb-essentia-ai-app-prd.s3.ap-northeast-1.amazonaws.com/......' \ # APIのレスポンスで返却された"url"で置き換えてください
--upload-file './sample.pdf'
POST用URLの場合
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"で置き換えてください
| cabinetId required | integer <int32> キャビネットID |
| fileName required | string [ 1 .. 250 ] characters ^[^¥¥¥/:¥*¥?¥"<>¥|]+$ ファイル名 |
| folder | string non-empty 親フォルダのアイテムID（オプション） |
| docType | string Enum: "INVOICE" "QUOTATION" "RECEIPT" "ORDER_SHEET" "ORDER_CONFIRMATION" "DELIVERY_SLIP" "INSPECTION" "CONTRACT" "OTHERS" 登録オプション：書類種別
|
| receiptType | string Enum: "RECEIVE" "EMIT" 登録オプション：発行・受領
|
| voucherNumber | string <= 250 characters 登録オプション：伝票番号 |
| memo | string <= 250 characters 登録オプション：メモ |
| uploadMethod | string Enum: "PUT" "POST" ファイルアップロード方式（HTTPメソッド）選択
|
{- "fileName": "sample_file.pdf"
}{- "itemId": "IWlPCI4ByiVliEzPPJfl",
}アカウント内に登録されているキャビネット一覧を取得します。
他アカウントから共有されているキャビネット情報は取得対象外です。
一度に取得できるキャビネットの上限数は合計15,000件となります。超過分は取得対象外となります。
レスポンスの"cabinetList"の並び順は、"cabinetId"の昇順です。
{- "cabinetList": [
- {
- "cabinetId": 123456,
- "cabinetName": "【一般】サンプルキャビネット",
- "isDencho": false,
- "fileCount": 100
}, - {
- "cabinetId": 123457,
- "cabinetName": "【電帳法】サンプルキャビネット",
- "isDencho": true,
- "fileCount": 100
}
], - "totalCount": 2
}