【重要】freee会計 APIの仕様変更（インボイス制度対応）について

【重要】freee会計 APIの仕様変更（インボイス制度対応）について

2023年10月に開始予定のインボイス制度への対応として、freee会計APIの仕様変更を予定しています。
仕様変更は2023年4月〜10月にかけて、段階的に行われます。
変更点は大きく分けて5つあり、アプリの挙動に大きな影響がある変更（破壊的変更）が2点含まれます。

このお知らせは2022年12月にお知らせした、以下のお知らせの続報となります。
https://developer.freee.co.jp/news/6140
なお、今後このお知らせは、都度更新をさせていただく予定です。

freee会計APIをご利用されている開発者の皆さまにおかれましては、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

インボイス対応による仕様変更の一覧
1.請求書API・見積書APIの「freee請求書」への移行（破壊的変更）
2.経費精算APIの仕様変更（破壊的変更）
3.インボイス制度関連項目の追加（取引先・ファイルボックス）
4.新規税区分・税区分カテゴリの追加
5.支払依頼APIの仕様変更（適格・非適格のパラメーターの追加）

1.請求書API・見積書APIの「freee請求書」への移行（破壊的変更）【リリース済】

変更内容：

当社の新サービスである「freee請求書」が2022年12月にリリースされ、従来「freee会計」で操作可能であった請求書の発行、見積書の発行機能を「freee請求書」へ移行することとなりました。それに伴い以下の変更が行われ、インボイス制度対応は「freee請求書」APIのみで対応されます。

なお、「freee請求書」APIの仕様の詳細は、2023年4月に公開した、リファレンスにてご確認ください。

freee請求書 APIリファレンス

また、freee会計の請求書・見積書APIから、freee請求書の請求書・見積書APIへの移行に際しては、2023年5月に公開した、以下の移行ガイドをご活用ください。
freee会計 帳票API→freee請求書 帳票API移行ガイド

対象エンドポイント：

廃止(「freee会計」請求書・見積書API)

  • 請求書（invoices）
    • DELETE /api/1/invoices/{id}：請求書の削除
    • GET /api/1/invoices：請求書一覧の取得
    • GET /api/1/invoices/{id}：請求書の取得
    • POST /api/1/invoices：請求書の作成
    • PUT /api/1/invoices/{id}：請求書の更新
  • 見積書（quotations）
    • DELETE /api/1/quotations/{id}：見積書の削除
    • GET /api/1/quotations：見積書一覧の取得
    • GET /api/1/quotations/{id}：見積書の取得
    • POST /api/1/quotations：見積書の作成
    • PUT /api/1/quotations/{id}：見積書の更新

新設（「freee請求書API」としてリリース）

  • 請求書（invoices）
    • GET /invoices 請求書一覧の取得
    • POST /invoices：請求書の作成
    • GET /invoices/{id}：請求書の取得
    • PUT /invoices/{id}：請求書の更新
    • GET /invoices/templates：使用可能な請求書の帳票テンプレート一覧の取得
  • 見積書（quotations）
    • GET /quotations：見積書一覧の取得
    • POST /quotations：見積書の作成
    • GET /quotations/{id}：見積書の取得
    • PUT /quotations/{id}：見積書の更新
    • GET /quotations/templates：使用可能な見積書の帳票テンプレート一覧の取得

変更の実施予定時期

  • 2023年4月：freee請求書API「請求書」「見積書」リリース 【リリース済】
  • 2023年10月：freee会計API「請求書」「見積書」の新規作成（POST）廃止 【リリース済】
  • 時期未定：freee会計API「請求書」「見積書」の更新・削除（PUT, DELETE）廃止
  • 時期未定：freee会計API「請求書」「見積書」の取得（GET）廃止

2.経費精算APIの仕様変更（破壊的変更）【リリース済】

変更内容：

経費精算APIには以下の仕様変更が発生します。

変更①：複数明細行への対応（データ構造の変更）【リリース済】

今まで、経費精算には、一つの明細行しか紐づけることができませんでした。
そのため申請行はAPIのレスポンスにおいては省略されていました。
Web側の仕様変更に伴い、一つの申請行に対して複数の明細行を紐づけられるようになります。

これに伴い、経費精算のデータ構造が以下のように変わります。

※この変更は、2023年5月〜10月は、後述の「移行方針」に記載した「ヘッダー分岐」を指定することで利用ができます。

変更前変更後
「経費精算」の直下に「明細行」が存在する。
「申請行」は存在するが見えない。
「明細行」は複数作成できる。

“expense_application”（経費精算）: {
  “expense_application_lines”（明細行）: [
  ]
}		「経費精算」と「明細行」の間に、
「申請行」が存在する。
「申請行」も「明細行」も複数作成できる。

“expense_application”（経費精算）: { 
“purchase_lines”（申請行）: [
  “expense_application_lines”（明細行）: [
    ]
  ]
}

移行方針：

新しいデータ構造（変更①）は2023年5月から利用することができます。
このデータ構造は、リクエストヘッダーに以下のAPIのバージョンを指定することで、利用可能となります。

Expense-Application-Mode: purchase-lines

※1 2023年10月以降、APIのバージョン指定の有無に関わらず、経費精算APIの仕様は①となります。
※2 2023年5月〜10月の間、APIのバージョン(Expence-Application-Mode: purchase-lines)を指定しない場合、「申請行」を持つ経費精算の取得（GET）をすることができません。
※3 2023年6月時点で予定していた「変更②(申請行ごとの適格非適格パラメーターの追加)」 は仕様の方針変更に伴い、対応不要となりました。

変更の実施予定時期：

2023年5月：freee会計API「経費精算」登録・更新・取得（POST,PUT, GET） ヘッダー分岐開始（変更①）【リリース済】

2023年10月末：freee会計API「経費精算」登録・更新・取得（POST,PUT, GET） 旧仕様の廃止【リリース済】

3.インボイス制度関連項目の追加（取引先・ファイルボックス）【リリース済】

変更内容：

インボイス制度対応に必要な下記項目が関連APIに追加されます。
いずれも任意のパラメーターとなります。

  • 適格請求書発行事業者の登録番号
  • 適格請求書発行事業者か否かのステータス
  • 書類の種類（ファイルボックスAPIのみ）

なお、仕様の詳細は、2023年4月に公開したリファレンスを合わせてご確認ください。

freee会計 APIリファレンス

取引先API

変更前変更後
以下のパラメーターに対応していない。



・適格請求書発行事業者の登録番号
・適格請求書発行事業者か否かのステータス		GETで以下のパラメーターを取得できる。
PUT・POSTで、以下のパラメーターの登録や更新ができる。

・適格請求書発行事業者の登録番号
・適格請求書発行事業者か否かのステータス

ファイルボックスAPI

変更前変更後
以下のパラメーターに対応していない。




・適格請求書発行事業者の登録番号
・適格請求書発行事業者か否かのステータス
・書類の種類		GETで以下のパラメーターを取得できる。
PUTで以下のパラメーターを指定して更新ができる。
※1 POST時は指定ができません。

・適格請求書発行事業者の登録番号※1
・適格請求書発行事業者か否かのステータス
・書類の種類

対象エンドポイント：

取引先（partners）

  • GET /api/1/partners：取引先一覧の取得
  • GET /api/1/partners/{id}：取引先の取得
  • POST /api/1/partners：取引先の作成
  • PUT /api/1/partners/{id}：取引先の更新
  • PUT /api/1/partners/code/{code}：取引先の更新

ファイルボックス（receipts）

  • GET /api/1/receipts：ファイルボックス（証憑ファイル）一覧の取得
  • GET /api/1/receipts/{id}：ファイルボックス（証憑ファイル）の取得
  • POST /api/1/receipts：ファイルボックス（証憑ファイル）アップロード
  • PUT /api/1/receipts/{id}： ファイルボックス（証憑ファイル）情報更新

変更の実施予定時期：

2023年4月上旬 【リリース済】

4.新規税区分・税区分カテゴリの追加【リリース済】

変更内容：

インボイス制度対応に伴い新たに48件の税区分および8件の税区分カテゴリが追加され、関連エンドポイントで利用可能になります。

新税区分は2023年7月から各APIで利用することができます。

新税区分一覧は以下のリンクよりご確認ください。
freee会計APIのインボイス制度における税区分追加のお知らせ

対象エンドポイント：

税区分

  • 税区分（taxes）
    • GET /api/1/taxes/codes 税区分一覧の取得
    • GET /api/1/taxes/codes/{code} 税区分の取得
    • GET /api/1/taxes/companies/{company_id} 指定した事業所の税区分一覧の取得
  • 事業所（companies）
    • GET /api/1/companies/{id}： 事業所の詳細情報の取得
  • 取引（deals）
    • GET /api/1/deals：取引（収入・支出）一覧の取得
    • GET /api/1/deals/{id}：取引（収入・支出）の取得
    • POST /api/1/deals：取引（収入・支出）の作成
    • PUT /api/1/deals/{id}：取引（収入・支出）の更新
  • 仕訳帳（journals）
    • GET /api/1/journals/reports/{id}/download：ダウンロード実行
  • 振替伝票（manual journals）
    • GET /api/1/manual_journals 振替伝票一覧の取得
    • GET /api/1/manual_journals/{id} 振替伝票の取得
    • POST /api/1/manual_journals 振替伝票の作成
    • PUT /api/1/manual_journals/{id} 振替伝票の更新
  • 取引の＋更新（renews）
    • POST /api/1/deals/{id}/renews：取引（収入・支出）に対する+更新の作成
    • PUT /api/1/deals/{id}/renews/{renew_id}：取引（収入・支出）の+更新の更新
  • フォーム用選択項目（selectables）
    • GET /api/1/forms/selectables フォーム用選択項目情報の取得

税区分カテゴリ

  • 税区分（taxes）
    • GET /api/1/taxes/codes 税区分一覧の取得
    • GET /api/1/taxes/codes/{code} 税区分の取得
    • GET /api/1/taxes/companies/{company_id} 指定した事業所の税区分一覧の取得

変更の実施予定時期：

2023年7月 【リリース済】

5.支払依頼APIの仕様変更（適格・非適格のパラメーターの追加）【リリース済】

変更内容：

支払依頼ごとに「適格・非適格・未指定」を選択できるようになります。
なお、こちらは任意のパラメーターとなります。

変更前変更後
  “payment_requests”（支払依頼）に適格・非適格のパラメーター“qualified_invoice_status”はない。“payment_requests”（支払依頼）に適格・非適格のパラメーター“qualified_invoice_status”が存在する。

上記のパラメーターはGETで取得ができる。
PUT・POST登録や更新ができる。

対象エンドポイント：

支払依頼（payment requests）

  • GET /api/1/payment_requests 支払依頼一覧の取得
  • GET /api/1/payment_requests/{id} 支払依頼の取得
  • POST /api/1/payment_requests 支払依頼の作成
  • PUT /api/1/payment_requests/{id} 支払依頼の更新

変更の実施予定時期：

2023年7月 【リリース済】

お知らせの変更履歴

2023年10月 11日　1.請求書API・見積書APIの「freee請求書」への移行　（POST）廃止　リリース済みの旨追記

2023年7月 4日　2.経費精算APIの仕様変更 変更②　　変更内容を削除
                            4.新規税区分・税区分カテゴリの追加　リリース済みの旨追記
                            5.支払依頼APIの仕様変更　リリース済みの旨追記

2023年6月 23日　5.支払依頼APIの仕様変更 パラメーター名をqualified_invoice_statusに修正

2023年5月 26日　2.経費精算APIの仕様変更 変更①　リリース済みの旨追記

2023年5月 9日　1.請求書API・見積書APIの「freee請求書」への移行　移行ガイドへのリンクを追加

2023年4月 17日 4.新規税区分・税区分カテゴリの追加　新規税区分一覧へのリンクを追加
                         　 2. 経費精算APIの変更予定時期　修正

2023年4月 4日　1.請求書API・見積書APIの「freee請求書」への移行　リリース済みの旨追記
                        　 3.インボイス制度関連項目の追加　リリース済みの旨追記
                        　 4.新規税区分・税区分カテゴリの追加　税区分の公開予定時期を修正

2023年3月30日　2.経費精算APIの仕様変更 変更②　修正（明細行→申請行）

2023年3月29日　5. 支払依頼APIの変更内容　追記
                         　 2. 経費精算APIの変更予定時期　修正

2023年3月10日　初回掲載