freee会計APIの仕様変更について

[2022-10-13更新]
告知事項の追加に伴い、「変更の詳細②」「変更の詳細③」を追記いたしました。
以前から告知している内容については「変更の詳細①」とタイトルを改めました。


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

変更の詳細①:

勘定科目一覧または事業所の詳細情報を取得した際のレスポンス項目から「tax_id(税区分ID)」に関連する項目が削除されます。

なお、freeeにおける税区分は「tax_code(税区分コード)」に移行しており、「tax_id(税区分ID)」は過去の変更により他のエンドポイントではすでに使用できなくなっているため、実質的な影響はありません。

対象のエンドポイントと削除される項目:

  • GET /api/1/account_items:勘定科目一覧の取得
    • default_tax_id(デフォルト設定がされている税区分ID)
  • GET /api/1/companies/{id}:事業所の詳細情報の取得
    • default_tax_id(デフォルト設定がされている税区分ID)
    • taxes.id(税区分ID)
    • taxes.name(税区分名)

変更の理由:

廃止された項目を削除するため

変更の実施予定時期:

2022年10月


変更の詳細②:

勘定科目の詳細情報を取得した際のレスポンス項目から「tax_id(税区分ID)」に関連する項目が削除されます(すでにリファレンスからは削除されておりますが実際には返却されており、仕様通りに修正するための変更です)。
なお、freeeにおける税区分は「tax_code(税区分コード)」に移行しており、「tax_id(税区分ID)」は過去の変更により他のエンドポイントではすでに使用できなくなっているため、実質的な影響はありません。

対象のエンドポイントと削除される項目:

  • GET /api/1/account_items/{id}:勘定科目の詳細情報の取得
    • default_tax_id(デフォルト設定がされている税区分ID)

変更の理由:

廃止された項目「tax_id(税区分ID)」を削除するため

変更の実施予定時期:

2022年10月


変更の詳細③:

フォーム用選択項目情報を取得した際のレスポンス項目から「tax_id(税区分ID)」に関連する項目が削除され、「tax_code(税区分コード)」に関連する項目が追加されます。

対象のエンドポイントと削除・追加される項目:

  • GET /api/1/forms/selectables:フォーム用選択項目情報の取得
    • [削除] account_categories.account_items.default_tax.tax_rate_5.id(税区分ID)
    • [削除] account_categories.account_items.default_tax.tax_rate_8.id(税区分ID)
    • [追加] account_categories.account_items.default_tax.tax_rate_5.code(税区分コード)
    • [追加] account_categories.account_items.default_tax.tax_rate_8.code(税区分コード)
    • [追加] account_categories.account_items.default_tax.tax_rate_10.code(税区分コード)
    • [追加] account_categories.account_items.default_tax.tax_rate_r8.code(税区分コード)

変更の理由:

使用されていない項目「tax_id(税区分ID)」を削除し、「tax_code(税区分コード)」への移行を行うため

変更の実施予定時期:

2022年12月
※「tax_code(税区分コード)」の追加に関しては2022年10月中を予定しており、リリース後に改めてお知らせいたします。