All posts by freee

【重要】freeeアプリストアの運用変更について

freeeアプリストアについて、2024年7月より以下2点の運用変更を予定しております。

freeeアプリストアをご利用の開発者の皆様におかれましては、変更点をご確認いただき、アプリの改修などの必要な対応をいただきますよう、よろしくお願い申し上げます。

なお、変更の影響を受けるアプリの開発者様には個別メールにてご連絡を差し上げております。

ご確認のほどどうぞ宜しくお願い申し上げます。

変更内容①:アプリタイプによる事業所数制限の見直し

  • これまで「アプリ利用事業所数の制限」は、プライベートアプリのみが対象でしたが、一部のパブリックアプリについても対象となります。
  • 変更前
    • 利用事業所数の制限はプライベートアプリのみにある。(5事業所の制限)
  • 変更後
    • プライベートアプリに加え、freeeに未申請のパブリックアプリについて、デフォルトの利用事業所数を20以下までに制限します
    • 制限の詳細はアプリタイプのヘルプページをご確認ください。
    • freeeに申請を行うことで、利用事業所数の上限は撤廃できます。

影響範囲について

  • この変更はパブリック・プライベートに関わらず、freeeアプリストア上の全てのアプリに適用されます。
  • 既存のアプリについては、アプリの種別に応じて、対応が異なります。以下のフローチャートをご参照ください。

変更時期

  • 2024年7月頃を予定

変更内容②:プラン限定アプリ制度の開始

  • 特定の機能を持つfreee会計との連携アプリについて、利用できるユーザーのプランを限定する場合があります。
  • 変更前
    • 原則アプリと連携できるfreeeのプラン指定はなし。
  • 変更後

影響範囲について

  • 対象となるアプリ開発者には、既にメールでご連絡を差し上げております。
  • 今後新規で作成されるアプリについては同条件での審査を行いますのでご留意ください。

変更時期

  • 2024年7月頃を予定
    • 2024年7月より、ユーザーは特定プランに所属していないと、該当のアプリを利用できなくなります。
    • この変更がユーザーに適用されるのは2024年7月以降最初のプラン更新時となります。

【freee請求書】請求書の作成で明細に紐づく明細項目の指定が可能になりました

freee請求書APIにおいて、明細に紐づく明細項目(勘定科目・税区分・品目・メモタグ・セグメント・部門)の指定が可能になりました

対象エンドポイント

  • 請求書の作成API(POST /invoices)
  • 請求書の更新API(PUT /invoices)

変更内容

【freee人事労務】勤務時間修正申請の作成、取得、承認操作が可能になりました

freee人事労務APIにおいて、勤務時間修正申請の作成、取得および承認操作ができるエンドポイントをリリースしました。

対象エンドポイント

  • 勤務時間修正申請一覧の取得API(GET /api/v1/approval_requests/work_times)
  • 勤務時間修正申請の取得API (GET /api/v1/approval_requests/work_times/{id})
  • 勤務時間修正申請の作成API (POST /api/v1/approval_requests/work_times)
  • 勤務時間修正申請の削除API (DELETE /api/v1/approval_requests/work_times/{id})
  • 勤務時間修正申請の承認操作API (POST /api/v1/approval_requests/work_times/{id}/actions)
  • 勤務時間修正申請の更新API (PUT /api/v1/approval_requests/work_times/{id})

変更内容

  • 勤務時間修正申請の作成APIは、従業員が新規の勤務時間修正申請を作成することができます。
  • 勤務時間修正申請一覧の取得APIは、freee人事労務で申請済みの勤務時間修正申請一覧を、入力した条件に応じて取得することができます。

従業員は本人が申請者の申請と承認者に指定された申請の一覧を、管理者は入力した条件に合致する全ての従業員の申請一覧を取得できます。

  • 勤務時間修正申請の取得、更新、削除APIは、freee人事労務で申請済みの勤務時間修正申請を、申請IDを指定して取得、更新もしくは削除することができます。

従業員は本人が申請者の申請の取得、更新、削除と、承認者に指定された申請の取得ができます。管理者は全ての従業員の申請を、申請IDを指定して取得できます。

  • 勤務時間修正申請の承認操作APIは、承認者がfreee人事労務で申請済みの勤務時間修正申請を、申請IDを指定して承認、差し戻しもしくは取り消しすることができます。
  • このAPIはお手元での勤務時間修正申請の処理や、外部ツールとの連携に活用いただけます。
  • ご利用方法の詳細はfreee人事労務APIのリファレンスページをご確認ください。
    人事労務APIリファレンス – freee Developers Community

勤務時間修正申請について

  • 勤務時間修正申請とは、従業員が打刻・勤怠カレンダーから登録した勤務時間の修正または削除を申請する機能です。
    勤務時間修正申請の詳細は、ヘルプページをご参照ください。

勤怠ワークフロー – 申請を行う

従業員ガイド③:勤怠や身上変更申請・承認を行う

【freee会計】API仕様の変更について(ファイルボックス API)

下記2点、freee会計 ファイルボックス(証憑ファイル)APIの仕様変更があります。

変更内容①は実施済み、変更内容②は今後実施される予定です。
freee会計APIをご利用の開発者の皆様におかれましては、変更点をご確認いただき、アプリの改修などの必要な対応をいただきますよう、よろしくお願い申し上げます。

変更内容①:

  • POST・PUT時のリクエストパラメーター「issue_date(発生日)」を廃止しました。

対象エンドポイント:

  • POST /api/1/receipts ファイルボックス(証憑ファイル)のアップロード
  • PUT /api/1/receipts/{id} ファイルボックス(証憑ファイル)の更新

変更理由:

  • 不具合への対応となります。
    ユーザーがリクエストパラメーターで指定した値に関わらず、アップロード日付がissue_dateに登録されていました。
  • Webの仕様と合わせ、POSTやPUT時にissue_dateを指定できないようにします。
    ※なお、今後issue_dateを指定したリクエストはエラーにならず、値が無視されるようになります。
    そのため、この変更は既存アプリの挙動に影響はございません。

変更の実施時期:

  • 2023年6月(実施済み)

変更内容②:

  • GET時のレスポンスから「issue_date(発生日)」「file_src(ファイルのダウンロードURL)」を廃止します。

対象エンドポイント:

  • GET /api/1/receipts ファイルボックス(証憑ファイル)一覧の取得
  • GET /api/1/receipts/{id} ファイルボックス(証憑ファイル)の取得

変更理由:

  • いずれもWebで利用されてない非推奨の値となります。
    今後、issue_dateに代わりcreated_atをご利用ください。
  • 今後、file_srcに代わり、ファイルボックス(証憑ファイル)のダウンロードAPIをご利用ください。
  • ※なお、issue_dateは現在POST/PUT時のレスポンスパラメーターにも含まれますが、上記GETのレスポンスパラメーターと同じタイミングで廃止されます。

変更の実施時期:

  • 2023年7月中旬

【freee会計】総勘定元帳API(β版)がリリースされました

freee会計APIにおいて、総勘定元帳を取得できるエンドポイント(β版)をリリースしました。

対象エンドポイント

  • 総勘定元帳API(/api/1/reports/general_ledgers)

変更内容

β版における制限

  • このAPIは2023年6月現在、β版での提供であり、以下の制約がございます。
    • このAPIは法人プロフェッショナル・法人エンタープライズに加入している事業所のみが利用できます。
    • 利用状況によって事前の告知なく提供プラン・コール数の上限を変更する可能性があります。
    • 他エンドポイントと比べてレスポンスタイムが遅い場合があります。

【重要】リフレッシュトークンの有効期限の変更

下記の通り、freee APIの仕様変更を予定しています。

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

変更の概要

  • freee API リフレッシュトークンの有効期限を「有効期限なし」から、「発行後90日間」に変更します。

変更理由

  • freee API セキュリティ強化のため。

変更時期

  • 2023年12月頃

影響範囲

  • この変更は、全てのfreee API リフレッシュトークンに関わります。
  • なお、freee APIを利用するアプリにおいて、大部分のアプリはこの変更の影響を受けないことが確認できております。大部分のアプリは、リフレッシュートークンを用いたアクセストークン生成を90日以内の間隔で行っていることが確認できているためです。
  • 有効期限の影響を受ける場合
    • (アクセストークンと同時に発行された)リフレッシュトークンを、発行後91日以上経ってから利用する実装があるアプリ。
    • リフレッシュトークンを用いたアクセストークンの再発行を定期的に(90日以内に)行っていないアプリ。
  • 有効期限の影響を必ずしも受けない場合
    • ユーザーが90日以上freeeにログインしない場合
      • 該当アプリが、内部的にアクセストークンの再発行を(90日以内に)行っていれば影響を受けることはありません。
  • アクセストークン・リフレッシュトークンの概要については以下のページも併せてご参照ください。
    • この変更は、有効期限適用後に発行されたリフレッシュトークンだけでなく、有効期限適用前に発行された全てのリフレッシュトークンにも関わります。
    • 90日の有効期限は「有効期限が適用されてから」ではなく、「リフレッシュトークンが発行されてから」となります。

必要な対応内容

  • 既存のアプリにつきまして、 必要に応じて「リフレッシュトークンが無効の場合(有効期限切れの場合)、認可コードの再取得を行う」仕様を実装してください。
  • なおリフレッシュトークンの有効期限が切れていた場合は、現在無効なリフレッシュトークンを利用した際にも出力される、以下の401エラーが出力されます。
{
    "error": "invalid_grant",
    "error_description": "指定された認可グラントは不正か、有効期限切れか、無効か、リダイレクトURIが異なるか、もしくは別のクライアントに適用されています。"
}

【freee会計】固定資産台帳API(GET)がリリースされました

freee会計 固定資産台帳API(GET)が新たにリリースされました。

対象エンドポイント

  • 固定資産台帳(GET /api/1/fixed_assets)

概要

freee会計API インボイス制度における税区分追加について

※以下の変更は2023年7月3日にリリースされました。

2023年10月に開始するインボイス制度への対応として、freee会計APIの仕様変更を予定しています。
その一環として、以下の税区分コード48件を新規に追加します。

新しい税区分は2023年7月より利用いただける予定です。リリースが完了しましたら、別途お知らせをいたします。

新しい税区分の影響範囲、またfreee会計APIのインボイス制度への対応全体に関するお知らせは、【重要】freee会計 APIの仕様変更(インボイス制度対応)についてをご確認ください。

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

新税区分の概要

インボイス制度の開始に伴い、以下12種類の税区分がWeb上で追加されます。(それぞれ4通りの税率を持つため、48件の税区分コードが追加されます。)

  • 課税売上に対応する免税事業者からの仕入
    • 課対仕入(控80)、課対仕入(控50)
    • 課対仕返(控80)、課対仕返(控50)
  • 非課税売上に対応する免税事業者からの仕入
    • 非対仕入(控80)、非対仕入(控50)
    • 非対仕返(控80)、非対仕返(控50)
  • 課税・非課税売上に共通対応する免税事業者からの仕入
    • 共対仕入(控80)、共対仕入(控50)
    • 共対仕返(控80)、共対仕返(控50)

控80、控50の税区分については、免税事業者からの仕入れや適格請求書の要件を満たさない仕訳で、仕訳の発生日が経過措置期間である場合に選択してください。

控80
仕訳の発生日が、2023/10/1 〜 2026/9/30 の場合に選択してください。
仕入税額相当額の80%が控除可能であることを示します。


控50
仕訳の発生日が、2026/10/1 〜 2029/9/30 の場合に選択してください。
仕入税額相当額の50%が控除可能であることを示します。

新税区分の税区分コード一覧

税区分コード
(code)
税区分名
(name)
日本語税区分名
(name_ja)
183purchase_with_tax_exempt_80課対仕入(控80)
184purchase_with_tax_exempt_50課対仕入(控50)
185purchase_with_tax_8_exempt_80課対仕入(控80) 8%
186purchase_with_tax_8_exempt_50課対仕入(控50) 8%
187purchase_with_tax_reduced_8_exempt_80課対仕入(控80) 8%(軽)
188purchase_with_tax_reduced_8_exempt_50課対仕入(控50) 8%(軽)
189purchase_with_tax_10_exempt_80課対仕入(控80) 10%
190purchase_with_tax_10_exempt_50課対仕入(控50) 10%
191purchase_with_no_tax_exempt_80非対仕入(控80)
192purchase_with_no_tax_exempt_50非対仕入(控50)
193purchase_with_no_tax_8_exempt_80非対仕入(控80) 8%
194purchase_with_no_tax_8_exempt_50非対仕入(控50) 8%
195purchase_with_no_tax_reduced_8_exempt_80非対仕入(控80) 8%(軽)
196purchase_with_no_tax_reduced_8_exempt_50非対仕入(控50) 8%(軽)
197purchase_with_no_tax_10_exempt_80非対仕入(控80) 10%
198purchase_with_no_tax_10_exempt_50非対仕入(控50) 10%
199purchase_with_common_exempt_80共対仕入(控80)
200purchase_with_common_exempt_50共対仕入(控50)
201purchase_with_common_8_exempt_80共対仕入(控80) 8%
202purchase_with_common_8_exempt_50共対仕入(控50) 8%
203purchase_with_common_reduced_8_exempt_80共対仕入(控80) 8%(軽)
204purchase_with_common_reduced_8_exempt_50共対仕入(控50) 8%(軽)
205purchase_with_common_10_exempt_80共対仕入(控80) 10%
206purchase_with_common_10_exempt_50共対仕入(控50) 10%
207return_of_purchase_with_tax_exempt_80課対仕返(控80)
208return_of_purchase_with_tax_exempt_50課対仕返(控50)
209return_of_purchase_with_tax_8_exempt_80課対仕返(控80) 8%
210return_of_purchase_with_tax_8_exempt_50課対仕返(控50) 8%
211return_of_purchase_with_tax_reduced_8_exempt_80課対仕返(控80) 8%(軽)
212return_of_purchase_with_tax_reduced_8_exempt_50課対仕返(控50) 8%(軽)
213return_of_purchase_with_tax_10_exempt_80課対仕返(控80) 10%
214return_of_purchase_with_tax_10_exempt_50課対仕返(控50) 10%
215return_of_purchase_with_no_tax_exempt_80非対仕返(控80)
216return_of_purchase_with_no_tax_exempt_50非対仕返(控50)
217return_of_purchase_with_no_tax_8_exempt_80非対仕返(控80) 8%
218return_of_purchase_with_no_tax_8_exempt_50非対仕返(控50) 8%
219return_of_purchase_with_no_tax_reduced_8_exempt_80非対仕返(控80) 8%(軽)
220return_of_purchase_with_no_tax_reduced_8_exempt_50非対仕返(控50) 8%(軽)
221return_of_purchase_with_no_tax_10_exempt_80非対仕返(控80) 10%
222return_of_purchase_with_no_tax_10_exempt_50非対仕返(控50) 10%
223return_of_purchase_with_common_exempt_80共対仕返(控80)
224return_of_purchase_with_common_exempt_50共対仕返(控50)
225return_of_purchase_with_common_8_exempt_80共対仕返(控80) 8%
226return_of_purchase_with_common_8_exempt_50共対仕返(控50) 8%
227return_of_purchase_with_common_reduced_8_exempt_80共対仕返(控80) 8%(軽)
228return_of_purchase_with_common_reduced_8_exempt_50共対仕返(控50) 8%(軽)
229return_of_purchase_with_common_10_exempt_80共対仕返(控80) 10%
230return_of_purchase_with_common_10_exempt_50共対仕返(控50) 10%
インボイス制度で追加される新規税区分コードの一覧

※「フォーム用選択項目情報の取得」仕様変更について

上記税区分追加と同時に、「フォーム用選択項目情報の取得API」に、以下の仕様修正を行います。

変更の詳細:

これまでフォーム用選択項目について、消費税の仕様設定に関わらず、default_taxにて全ての税率、(tax_rate_5,tax_rate_8,tax_rate_10,tax_rate_r8)を返却していました。

上記を修正し、消費税の仕様設定で「使用しない」と設定した税率は返却しないように修正します。

消費税の使用設定についてはヘルプページ2. 消費税・税区分の設定を行うをご確認ください。

対象エンドポイント:

GET /api/1/forms/selectables フォーム用選択項目情報の取得
(account_items内のdefault_taxの返却内容)

変更の理由:

不要な税率を表示しないため。

【freee人事労務】従業員カスタム項目の内容が取得可能になりました

freee人事労務APIにおいて、従業員情報に入力された「カスタム項目」を取得できるエンドポイントをリリースしました。

対象エンドポイント

  • カスタム項目API(/api/v1/employees/{employee_id}/profile_custom_fields)

変更内容

  • カスタム項目APIは、freee人事労務のカスタム項目に入力された内容を従業員ごとに取得することができます。
  • このAPIはお手元での人事データの分析や、外部ツールとの連携に活用いただけます。
  • ご利用方法の詳細はfreee人事労務APIのリファレンスページをご確認ください。
    人事労務APIリファレンス – freee Developers Community

従業員カスタム項目について

【freee会計】仕訳帳APIにおいて、「新CSV形式での取得」、「文字コードの選択」が可能になりました

freee会計 仕訳帳APにおいて「新CSV形式での仕訳帳の取得」、「文字コードの選択」が可能になりました。

対象エンドポイント

  • 仕訳帳API(/api/1/journals)

変更点

  • ダウンロード形式(download_type)で新CSV形式(generic_v2)を選択して、仕訳帳をダウンロードすることができるようになりました。
  • 文字コード(encoding)を指定して、仕訳帳をダウンロードすることができるようになりました。
  • ご利用方法の詳細はfreee会計 仕訳帳APIのリファレンスをご確認ください。
    会計APIリファレンス – freee Developers Community

新CSV形式について

  • 新CSV形式では、これまでのAPIでは出力できなかった「(仕訳を)登録した方法」のような項目を出力することができます。
  • 新CSV形式で出力できる項目の詳細については、ヘルプページ「仕訳帳をCSV形式・PDF形式で出力する」をご確認ください。

[復旧済み]freee APIにて動作が不安定な状況が確認されておりました

[2023/3/28 19:38追記]

本日17時53分頃より、freeeの全てのAPI(会計・人事労務・プロジェクト管理・受発注)で動作が不安定な状況が発生しておりましたが、18時36分に機能復旧を完了しています。

ご迷惑をおかけし、大変申し訳ございませんでした。


本日17時57分頃より、freeeの全てのAPI(会計・人事労務・プロジェクト管理・受発注)で動作が不安定な状況が確認されております。

https://status.freee.co.jp/issues/6422b024386fb37753e257e9

現在、復旧に向けた対応を行っております。

ご迷惑をおかけし、大変申し訳ございません。

【重要】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日 初回掲載

【重要】 freee会計APIの仕様変更について

下記の通り、freee会計APIの仕様変更を予定しております。

ご迷惑をおかけし大変恐れ入りますが、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の詳細:

「グループ管理機能」で「利用可能な部門」を制限されているユーザーの場合、section_ids に “0”(部門:未選択)を指定できなくなります。 

対象エンドポイント:

[GET] /api/1/reports/trial_pl_sections: 損益計算書(部門比較)の取得

[GET] /api/1/reports/trial_cr_sections: 製造原価報告書(部門比較)の取得

変更の理由:

上記のエンドポイントを利用する際、グループ管理機能で利用可能な部門を制限していても、section_ids に “0”(未選択)を指定することで、Web版では指定できない「部門:未選択」で比較ができてしまうという不具合が存在しています。

これを修正し、利用可能な部門を制限されたユーザーの場合は(Webと同様に)部門:未選択で比較ができないようにする変更を下記の日程で計画しています。
※グループ管理機能について詳しくは「メンバーが利用できる口座・部門を指定する(グループ管理)」をご参照ください。

変更の実施予定時期:

2023年3月末

freee人事労務Webhook(β版)をリリースしました

この度freee人事労務Webhook(β版)をリリースしました。

Webhookはfreeeプロダクト上で操作が行われた際、そのことを連携先のアプリに通知するための仕組みです。

freee人事労務Webhook(β版)は「freee人事労務上で従業員の追加・更新・削除が行われたこと」を、連携先のアプリに通知することができます。

これにより、連携アプリに「従業員の追加・更新・削除」をトリガーとしたアクションを実装頂けるようになりました。

freee人事労務Webhook(β版)の機能の詳細、β版における制限については人事労務Webhook概要をご参照ください。

【重要】freeeプロジェクト管理API「工数登録」時にworkload_tags.tag_idが必須になりました

freeeプロジェクト管理APIにおいて、工数登録(POST /workloads)でこれまで任意だったリクエストパラメータ「工数タグID(workload_tags.tag_id)」が必須になりました。
利用方法については下記リファレンスページをご確認ください。

https://developer.freee.co.jp/reference/pm/reference#operations-tag-Workloads

なお、本リリースは先日配信いたしましたお知らせ「【重要】freeeプロジェクト管理APIの仕様変更について(https://developer.freee.co.jp/news/6298)」に関連するリリースです。

【重要】freeeプロジェクト管理APIの仕様変更について(不具合への対応)

下記の通り、freeeプロジェクト管理APIの仕様変更を予定しております。

この仕様変更は不具合対応によるもののため、リリース直前のお知らせとなります。

ご迷惑をおかけし大変恐れ入りますが、新仕様の確認ならびに必要に応じてアプリの改修などの対応をご検討いただきますよう、よろしくお願い申し上げます。

変更の詳細:

工数登録の際に、これまで任意だったリクエストパラメータ「工数タグID(workload_tags.tag_id)」が必須になります。

対象エンドポイント:

[POST] /workloads: 工数登録

変更の理由:

工数登録時の工数タグ選択を「必須」に設定していても、工数登録する際、工数タググループを選択することで工数タグを選択せずに工数登録ができてしまう不具合が存在しています。

これを修正し、工数タグの選択を必須とする変更を下記の日程で計画しています。

これに伴い、Public APIについてもこれまで任意だった工数タグIDが必須となります。

変更の実施予定時期:

2023年2月中

[復旧済み]freeeAPIの一部の動作が不安定な状況が発生していました

[2023/2/14 14:00追記]

本日8時24分頃~8時47分頃の間、freee 会計・人事労務Public APIの一部について動作が不安定な状況が発生しておりましたが、14時00分現在、機能復旧を完了しています。

ご迷惑をおかけし、大変申し訳ございませんでした。


本日8時24分頃より、「モバイルアプリ(会計/人事労務/電子申告/プロジェクト管理)、Public APIの一部の機能」の動作が不安定な状況が確認されておりましたが、8時47分より安定的な稼働状況に戻っていることを確認しております。

https://status.freee.co.jp/issues/63ead4faf4e01e46241f5bad

現在、念の為稼働状況のモニタリングを続けております。

ご迷惑をおかけし大変申し訳ございません。

freee Public APIに関する事業所選択機能のリリースについて

この度freeeが提供しているAPIにおいて、「事業所選択機能」をリリースしたことをお知らせいたします。

機能の概要

事業所選択機能は、「freeeユーザーが連携アプリの利用を開始する際、アプリがアクセスできる事業所を指定する機能」のことです。
これまで開発者がfreee上で公開アプリを作成する際、開発者自身で「事業所選択機能」を実装頂く必要がありました。

今後はfreeeが提供するデフォルトの認証用URLをご利用頂くことで、freee製の事業所選択機能をご利用頂けます。

事業所選択機能について、詳しくはfreee APIの使い方-事業所の選択についてをご覧ください。

既存機能への影響

この変更による、既存アプリケーションの挙動への影響はありません。

開発者ページ・アプリ詳細画面内でデフォルトで表示される以下のURL2つが変更されました。

  • Webアプリ認証用URL
  • モバイル・JSアプリ認証用URL

各URLについて、末尾に以下文言が追加されています。

  • &prompt=select_company

なお文言を削除し、旧来のURLを引き続きご利用頂くことも可能です。
但し旧来のURLでは、freee製の事業所選択機能をご利用頂くことができません。
詳しくはfreee APIの使い方-事業所の選択についてをご覧ください。

freee会計 Public APIに関するSDKのメンテナンス終了、およびスキーマのymlファイルでの公開終了について

※2023/4/17追記
このお知らせの内容は2023/4/17に以下の通り実施されました。

  1. freee会計SDKのメンテナンス終了
  2. freee会計スキーマのymlファイルでの公開終了

1.freee会計SDKのメンテナンス終了

この度freeeが提供している以下3つのAPI開発者向けのSDKについて、定期のメンテナンスを終了することになりましたのでお知らせいたします。

対象のSDK:

メンテナンスの終了時期:

2023年4月

今後のご利用につきまして:

いずれのSDKについても定期メンテナンスは終了しますが、github上ではdepreceated(非推奨)として公開を継続しますので、ご利用は可能です。

また、クライアントコードはリファレンス内で公開しているjsonを利用して、開発者ご自身で生成頂くことが可能です。

設計ガイドライン内で会計 PHP用クライアントコード(SDK)の生成方法を公開しておりますのでご活用ください。

2.freee会計スキーマのymlファイルでの公開終了

またgithub上でymlファイルの形式で公開していた会計APIのスキーマファイルについて、公開を終了することになりましたのでお知らせいたします。

対象のリポジトリ:

公開の終了時期:

2023年4月

今後のご利用につきまして:

今後はリファレンス内でも公開している、json形式のスキーマファイルをご活用ください。

試算表APIのレスポンス内容変更について

下記の通り、試算表APIの仕様変更を予定しています。

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

変更の実施予定時期

2021年10月

変更内容

試算表APIのリクエストパラメータ[section_id(部門ID)]に親部門のIDを指定した場合の実行結果が変更されます。

変更前

親部門のIDを指定した場合、集計値は0が返却されます。(HTTPステータスコードは[200(成功)])

変更後

親部門のIDを指定した場合、指定した親部門の配下の部門(子部門)の集計値が返却されます。(HTTPステータスコードは[200(成功)])

対象エンドポイント

  • /api/1/reports/trial_bs
  • /api/1/reports/trial_bs_two_years
  • /api/1/reports/trial_bs_three_years
  • /api/1/reports/trial_pl
  • /api/1/reports/trial_pl_two_years
  • /api/1/reports/trial_pl_three_years
  • /api/1/reports/trial_pl_segment_1_tags
  • /api/1/reports/trial_pl_segment_2_tags
  • /api/1/reports/trial_pl_segment_3_tags

変更理由

freee会計の機能アップデートのため