Skip to content

Feature Request: 自動登録ルールのCRUD APIの追加(取得・作成・更新・削除) #542

@kojikojikojikoji

Description

@kojikojikojikoji

概要

freee会計の「自動登録ルール」を API 経由で取得・作成・更新・削除できるエンドポイントの追加をリクエストします。

現在、自動登録ルールの管理は freee UI での手動操作、または CSV インポート/エクスポートに限定されています。API からは自動登録ルールに一切アクセスできません。

背景と課題

税理士事務所における複数事業所管理の課題

税理士事務所では 60社以上の顧問先の記帳業務を管理するケースがあります。この場合、以下のような業務が発生します。

  • 事業所間で共通する仕訳ルール(例「コメダ珈琲→会議費」「Amazon→消耗品費」)を、各事業所に個別に設定する必要がある
  • 共通ルールに変更・追加があった場合、全事業所に対して一つずつ手動で反映しなければならない
  • 新規顧問先を受け入れる際、既存の共通ルールセットを一から手動入力する必要がある

CSV インポートの限界

現在、自動登録ルールの一括操作は CSV インポート/エクスポートで対応可能ですが、以下の制約があります。

  • 差分管理ができない — CSVは全件上書きのため、既存ルールの部分的な更新や削除が困難
  • プログラムからの操作ができない — システム間連携やバッチ処理に組み込めない
  • バリデーションが事後的 — インポート前にルールの妥当性をプログラムで検証する手段がない(勘定科目IDの存在確認、取引先の名寄せ等)
  • 文字コードの問題 — Shift-JIS または UTF-8 BOM 付きが要求され、プログラムからの生成で文字化けリスクがある

API 化により実現したいこと

自動登録ルールが API で操作可能になれば、以下のようなシステム化が実現できます。

  1. 共通ルールの一元管理と自動配信 — 税理士事務所側で管理している共通ルールマスターを、API 経由で各事業所の自動登録ルールに自動反映する
  2. ルールの差分同期 — 追加・変更・削除されたルールのみを差分で適用でき、既存ルールを壊さない
  3. ルールのバリデーション — 登録前にAPIで勘定科目・税区分・取引先・品目の存在を確認し、不正なルールの登録を防止する
  4. MCP(Model Context Protocol)との連携 — freee-mcp 経由でAIがルールの提案・登録を行うワークフローが実現可能になる
  5. 監査証跡 — API経由のルール変更はログとして記録でき、いつ誰がどのルールを変更したかを追跡可能になる

リクエストするエンドポイント

GET    /api/1/auto_registration_rules                 # ルール一覧の取得
POST   /api/1/auto_registration_rules                 # ルールの作成
GET    /api/1/auto_registration_rules/{id}             # ルールの取得
PUT    /api/1/auto_registration_rules/{id}             # ルールの更新
DELETE /api/1/auto_registration_rules/{id}             # ルールの削除

想定されるリクエスト/レスポンスの構造

既存のCSVインポート仕様(自動登録ルールをCSVファイルでインポートした場合)に準拠した項目構成を想定しています。

{
  "company_id": 2845996,
  "entry_side": "expense",
  "walletable_type": "credit_card",
  "walletable_id": 2286926,
  "description": "コメダ珈琲",
  "match_type": "partial",
  "amount_min": null,
  "amount_max": null,
  "action": "register",
  "account_item_id": 455544759,
  "tax_code": 136,
  "partner_id": 74455094,
  "item_id": 248675365
}

現在のfreee APIとの整合性

freee会計APIでは、仕訳に関連する主要なマスターデータ(勘定科目・取引先・品目・税区分・部門・メモタグ)は全てCRUD APIが提供されています。

マスター GET POST PUT DELETE
勘定科目 (account_items)
取引先 (partners)
品目 (items)
部門 (sections)
メモタグ (tags)
自動登録ルール

自動登録ルールのみ API が提供されていない状態です。freee会計の記帳自動化の中核機能であるにもかかわらず、プログラムからのアクセス手段がないことは、API連携の大きなギャップとなっています。

ユースケース

ユースケース1: 税理士事務所の共通ルール配信

60社以上の顧問先に対して「スターバックス→会議費」「JR東日本→旅費交通費」等の共通ルールを一括配信。新規顧問先にも自動でルールセットを適用。

ユースケース2: AIによるルール提案・登録

freee-mcp 等のMCPツール経由で、AIが仕訳済みデータを分析し、新しい自動登録ルールを提案・登録するワークフロー。現在はCSVを経由する必要があり、AIの判断結果を直接反映できない。

ユースケース3: ルールの品質管理

定期的にAPIで全ルールを取得し、重複ルール・矛盾するルール・使用されていないルールを検出。ルールの正答率(freee UIで表示される精度指標)もAPI経由で取得できれば、低精度ルールの自動検出と改善提案が可能になる。

関連

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions