■ 概要
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
既定の備考テンプレートがfreee請求書で設定されている場合、その備考テンプレートから備考の内容を補完するようになりました。
■ 変更内容
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
変更対象API:freee請求書 API v1
変更種別:Non-Breaking Change
変更内容:
– 各帳票(請求書、納品書、見積書)のPOST時に、各帳票の備考に対応するkeyが存在しておらず、freee請求書で既定の備考テンプレートが設定されている場合、その備考テンプレートから備考の内容を補完する形で各帳票を作成するように変更
変更理由:これまで請求書APIにおいて、freee請求書の既定テンプレートが参照できない状態であり、そのため複数の備考テンプレートを活用しないシンプルな運用であっても、帳票発行元のデータとして備考データを保存する仕組みを開発する必要がありました。これを既定の備考テンプレートを活用可能にすることで、比較的シンプルな利用要件における開発負荷の軽減、及び利用者の便益を向上することを目的としております。
■ 変更スケジュール
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
アナウンス日:2025/07/17
変更リリース日:2025/07/09
■ 対応方法
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
今回の変更は破壊的変更ではないため、既存の動作に影響はなく、対応は不要です。
ただし、希望される方は以下の操作を行うことで、freee請求書の既定の備考テンプレートに設定した内容を帳票の備考として補完して帳票を作成できるようになります。
1. freee請求書Webにログインし、各帳票種別ごとに既定の備考テンプレートを設定する
2. 請求書APIにて各帳票の備考に対応するkeyを、空文字やnullでなくkeyとして存在しない形でパラメータとして送信する
※各keyの値を送信すれば、APIの値がfreee請求書Webの既定テンプレートの値よりも優先されます。
各帳票の備考に対応するkeyは以下の通りです。
・納品書: delivery_slip_note
・請求書: invoice_note
・見積書: quotation_note
上記に関して、詳細は以下のヘルプページを御覧ください。
▼ 【ヘルプセンター】備考テンプレートを設定する
https://support.freee.co.jp/hc/ja/articles/18531082542745
■ 変更後のAPI仕様
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
エンドポイント:/delivery_slips
リクエスト:POST
key「delivery_slip_note」に「変更内容」に記載した変更が適用されます
エンドポイント:/invoices
リクエスト:POST
key「invoice_note」に「変更内容」に記載した変更が適用されます
エンドポイント:/quotations
リクエスト:POST
key「quotation_note」に「変更内容」に記載した変更が適用されます