コンシューマー向け
ユーザーレシートAPI
コンシューマー(エンドユーザー)向けのレシート管理APIです。ユーザー自身のレシート一覧・詳細取得、月間支出サマリー、レシート画像のAI解析(OCR)、レシートの保存・削除に対応しています。OAuth 2.0のuser.*スコープが必要です。
api/v1/user/receipts
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/user/receipts/
|
レシート一覧を取得
ログインユーザーのレシート一覧を返します。year, monthパラメータで月別フィルタが可能です。スコープ: user.receipts.read
|
200 401 403 |
| GET |
/api/v1/user/receipts/{id}
|
レシート詳細を取得
明細(アイテム)と店舗情報を含む単一レシートの詳細を返します。スコープ: user.receipts.read
|
200 404 |
| GET |
/api/v1/user/receipts/summary
|
月間支出サマリーを取得
指定月の合計金額、レシート数、カテゴリ別内訳、前月比を返します。year, monthパラメータで月を指定。スコープ: user.spending.read
|
200 401 403 |
| POST |
/api/v1/user/receipts/analyze
|
レシート画像をAI解析(OCR)
レシート画像をアップロードしてAIでデータを抽出します。保存はされません。multipart/form-dataでファイルを送信。最大5MB。スコープ: user.receipts.read
|
200 400 |
| POST |
/api/v1/user/receipts/
|
レシートを保存
レシートを新規作成または更新します。multipart/form-dataで画像も同時にアップロード可能。重複レシート検出時は409を返します。スコープ: user.receipts.read
|
200 409 |
| DELETE |
/api/v1/user/receipts/{id}
|
レシートを削除
レシートを論理削除します。スコープ: user.receipts.read
|
204 404 |
エンドポイント詳細
ログインユーザーのレシート一覧を返します。year, monthパラメータで月別フィルタが可能です。スコープ: user.receipts.read
完全パス:
GET /api/v1/user/receipts/
レスポンスコード:
200
401
403
明細(アイテム)と店舗情報を含む単一レシートの詳細を返します。スコープ: user.receipts.read
完全パス:
GET /api/v1/user/receipts/{id}
レスポンスコード:
200
404
指定月の合計金額、レシート数、カテゴリ別内訳、前月比を返します。year, monthパラメータで月を指定。スコープ: user.spending.read
完全パス:
GET /api/v1/user/receipts/summary
レスポンスコード:
200
401
403
レシート画像をアップロードしてAIでデータを抽出します。保存はされません。multipart/form-dataでファイルを送信。最大5MB。スコープ: user.receipts.read
完全パス:
POST /api/v1/user/receipts/analyze
レスポンスコード:
200
400
レシートを新規作成または更新します。multipart/form-dataで画像も同時にアップロード可能。重複レシート検出時は409を返します。スコープ: user.receipts.read
完全パス:
POST /api/v1/user/receipts/
レスポンスコード:
200
409
レシートを論理削除します。スコープ: user.receipts.read
完全パス:
DELETE /api/v1/user/receipts/{id}
レスポンスコード:
204
404
リクエスト例
リクエスト
GET /api/v1/user/receipts?year=2026&month=3
Authorization: Bearer {access_token}
レスポンス
[
{
"id": "abc-123",
"storeName": "セブンイレブン 渋谷店",
"totalAmount": 842,
"taxAmount": 76,
"category": "食費",
"paymentMethod": "現金",
"receiptDate": "2026-03-15T12:30:00",
"createdAt": "2026-03-15T12:35:00Z"
}
]
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。