■概要
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
freee会計APIに、仕訳帳を検索条件で絞り込み、該当する仕訳を
JSON 形式で取得するエンドポイントを追加しました。
freee会計の仕訳帳画面と同じ検索条件で絞り込んだ結果を、
1 回のリクエストで直接取得できます。
■ 変更内容
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
新規追加API:
仕訳帳の検索API(POST /api/1/journals/search)
変更種別:
Non-Breaking Change
変更内容:
- 仕訳帳の検索APIは、指定した検索条件に一致する仕訳を、
借方・貸方の明細行を含めて JSON 形式で返します。 - 発生日・作成日の期間、勘定科目、税区分、取引先、品目、部門、
メモタグ、セグメント、金額、承認状況、コメントなど、仕訳帳画面と同等の条件で絞り込めます。 - 1 回のリクエストで最大 1,000 件を取得できます。
続きは、レスポンスの next_page_token を次のリクエストに指定して取得します。 - 税抜経理の場合は、仕訳帳画面と同じく、
仮払消費税等・仮受消費税等の行を明細行の末尾に含めて返します。
既存の仕訳帳APIとの違い:
帳票ファイル(CSV・PDF)が必要な場合は、既存の仕訳帳の
ダウンロード要求API(GET /api/1/journals)を、データを JSON で
扱う場合は仕訳帳の検索APIをご利用ください。
変更理由:
これまで仕訳帳の内容をプログラムで扱うには、ファイルの作成を
依頼し、作成の完了を待ってからダウンロードし、ファイルを解析
する必要がありました。
仕訳帳のデータを直接 JSON で取得できるようにし、外部ツールや
AIエージェントから仕訳の確認・分析を行いやすくします。
■ 変更スケジュール
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
アナウンス日:2026/11/06(金)
変更リリース日:2026/11/06(金)
■ 対応方法
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
既存の仕訳帳API
(GET /api/1/journals、GET /api/1/journals/reports/{id}/status、
GET /api/1/journals/reports/{id}/download)の仕様は変わりません。
今後も提供を続けるため、対応は必要ありません。
仕訳帳の検索APIを利用する場合は、freee会計APIリファレンスで
リクエストとレスポンスの仕様をご確認ください。
■ 変更後のAPI仕様
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
エンドポイント:
https://api.freee.co.jp/api/1/journals/search
リクエスト:
検索条件はリクエストボディに JSON で指定します。
発生日の期間(start_issue_date・end_issue_date)は、取引ID(deal_ids)を指定しない場合は必須です。
各パラメータは、freee会計APIリファレンスの「仕訳帳」をご確認ください。
必要な権限:
既存の仕訳帳APIと同じく、仕訳帳の参照権限が必要です。