[人事労務API] 事務担当者廃止に伴う変更のお知らせ

■ 概要

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

ログインユーザの取得時に返却されるroleの値からclerkが削除されます。

■ 変更内容

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

変更対象API:freee人事労務 API

変更種別:Breaking Change

変更内容:

 – ログインユーザのGET時に、roleが返却されますが、その中のclerkという返却値が変更されます。今後、事務担当者権限のユーザがこの値を取得する際はカスタム権限としての値「custom-XX (※XX部分はランダムに変動する値)」になります。

変更理由:権限を自由に作成できるカスタム権限機能のリリースに伴い、事務担当者権限はプリセットの権限から、カスタム権限の一つに変更となります。それに伴い、本APIでの返却値もカスタム権限の値に変更します。

■ 変更スケジュール

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

アナウンス日:2025/04/23

変更リリース予定日:2025年05月~07月

■ 対応方法

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

なし

■ 変更後のAPI仕様

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

エンドポイント: /api/v1/users/me

リクエスト: GET

事務担当者の成功時のレスポンスの内容が変化します。role が clerk から custom- で始まるランダムな文字列となります。

レスポンスの具体例を示します。

変更前:

{
  "id": 1,
  "companies": [
    {
      "id": 100,
      "name": "株式会社フリー",
      "role": "clerk",
      "external_cid": "000-000-000",
      "employee_id": 10,
      "display_name": "フリー太郎"
    }
  ]
}

変更後:

{
  "id": 1,
  "companies": [
    {
      "id": 100,
      "name": "株式会社フリー",
      "role": "custom-01HFEC7P2ZMHBERZRBJ3HBBW2E-01JNZ0QKYH6ASRY468GNRMBV6C",
      "external_cid": "000-000-000",
      "employee_id": 10,
      "display_name": "フリー太郎"
    }
  ]
}

サービスメンテナンス(4/22)のお知らせ

下記の通り、freeeの全サービス (電子公告サービス除く) のメンテナンスを実施します。

・日時: 2025/4/22 (火) 1:00 – 5:00
・対象:freeeの全サービス (電子公告サービス除く)

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願い致します。

【重要】freee会計 ファイルボックス(証憑ファイル)のアップロードAPI 変更のお知らせ

概要

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

freee会計APIにおいて、ファイルボックス(証憑ファイル)のアップロードAPIの rate limit 仕様を変更します。

freee会計APIをご利用の開発者の皆様におかれましては、変更点をご確認いただき、アプリの改修などの必要な対応をいただきますよう、よろしくお願い申し上げます。
本お知らせでのrate limitは事業所単位で1分間に実行可能なAPIの呼び出し回数です。制限を超えると、呼び出しは一時的に制限されます。

■ 変更内容

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

変更対象API:freee会計 ファイルボックス(証憑ファイル)のアップロード

変更種別:Breaking Change

変更内容:

  • 上記エンドポイントの現在の rate limit は以下のように変わります。

【現在】600リクエスト/分

【変更後】300リクエスト/分

  • rate limitを超過した場合のエラー内容は以下のように変わります。

【現在】

ステータスコード:400

エラーメッセージ:「ファイルのアップロードに失敗しました。1分間にアップロードできるファイル数の上限(600ファイル)を超えています。」

【変更後】

ステータスコード:400

エラーメッセージ:「ファイルのアップロードに失敗しました。1分間にアップロードできるファイル数の上限(300ファイル)を超えています。」

変更理由:[変更を行う背景・理由]

freee Public APIの可用性及びセキュリティ強化の一環のため

■ 変更スケジュール

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

アナウンス日:2025/03/21

変更リリース予定日:2025/05/19

■ 対応方法

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

上記エンドポイントを利用するアプリが以下の2つの仕様を満たすことを推奨します。

  1. APIの呼び出し回数の制御

変更後のrate limit(300リクエスト/分)を超えないよう、呼び出し回数の調整をお願い致します。API処理時間は1秒程度のため、直列実行の場合は制限を超える可能性は低いですが、並列実行している場合はスレッド数の調整をご検討ください。※1

  1. エラー発生に備えた制御

以下のいずれかの機能を実装することをご検討ください。

  • rate limit制限超過時には、適切な間隔を設けた再試行処理
  • rate limit制限によりアップロードに失敗した証憑ファイルをユーザーが手動で再アップロードできる機能。※2

※1. 事業所単位でファイルアップロードのrate limit制限を設けているため、直列実行の場合でも複数のユーザーが同時にアップロードをすると制限を超える可能性があります。

※2. 並列実行時にrate limitに達した場合でも、制限前にアップロードされた証憑ファイルは既に登録済みとなっているため、再アップロードは不要です。

■ 変更後のAPI仕様

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

事業所単位で1分間に実行可能なAPIの呼び出し回数が300回までとなります。rate limitの仕様変更のため、エンドポイント及びリクエストの仕様に変更はありません。

2025年2月の更新情報

(2/9) [会計] receipt_metadatum_amountプロパティの上限値、下限値が変更されました。
POST /api/1/receipts PUT /api/1/receipts/{id}
PUT /api/1/receipts PUT /api/1/receipts/{id}

以上です。
引き続きよろしくお願いいたします。

2025年1月の更新情報

(1/15)[人事労務]ログインユーザーの取得にshift_admin: AIシフト担当者が追加されました。
(1/23)[人事労務]支給対象の法定内残業時間 という文言が みなし外の法定内残業時間 に変更されました。
(1/29)[人事労務]以下に示す勤怠API・勤怠情報月次サマリAPI・有給申請APIにおける同日取得が可能になりました。
https://developer.freee.co.jp/news/7167

以上です。

引き続きよろしくお願いいたします。

サービスメンテナンス(2/13)のお知らせ

下記の通り、freeeの全サービス (電子公告サービス除く) のメンテナンスを実施します。

・日時: 2025/2/13 (木) 1:00 – 5:00
・対象:freeeの全サービス (電子公告サービス除く)

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願い致します。

2024年12月の更新情報

(12/24)[人事労務]所属一覧API のレスポンスに
‘employee_group_memberships/items/group_memberships/items/main_duty’
というオプションのプロパティが追加されました。

(12/24)[人事労務]従業員一覧APIのレスポンスに
‘employees/items/dependent_rules/items/health_insurance_qualification_required’
‘employees/items/health_insurance_rule/health_insurance_qualification_required’
というオプションのプロパティが追加されました。

(12/24)[人事労務]従業員APIのレスポンスに
‘employee/dependent_rules/items/health_insurance_qualification_required’
‘employee/health_insurance_rule/health_insurance_qualification_required’
というオプションのプロパティが追加されました。

(12/24)[人事労務]従業員の家族情報APIのレスポンスに
‘employee_dependent_rules/items/health_insurance_qualification_required’
というオプションのプロパティが追加されました。

(12/24)[人事労務]従業員の健康保険APIのレスポンスに
‘employee_health_insurance_rule/health_insurance_qualification_required’
というオプションのプロパティが追加されました。

(12/24)[人事労務]年末調整APIのレスポンスに
‘insurances/items/certification_type’
というオプションのプロパティが追加されました。

(12/24)[人事労務]年末調整従業員保険料情報APIのレスポンスに
‘insurances/items/certification_type’
というオプションのプロパティが追加されました。

(12/24)[人事労務]従業員の姓名・住所などの更新APIの
‘employee_profile_rule/employment_type’に’fixed-term’,’part-time’,’regular’,’temporary’
の新しい列挙値が追加されました。

【freee工数管理】プロジェクトの招待リンクの機能追加にともない、APIの仕様に変更があります

freee工数管理のプロジェクトの招待リンクの機能をリリースしました。
これにともない、プロジェクトのAPIで項目が増えました。

機能の詳細についてはヘルプページをご覧ください。

▼ 【ヘルプセンター】プロジェクトの招待リンクを有効にする
https://support.freee.co.jp/hc/ja/articles/42195635572121

任意項目のため、これまでのリクエストが使えなくなることはございません。

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

対象エンドポイント

  • プロジェクト一覧取得API
    • (GET /projects)
  • プロジェクト詳細の取得API
    • (GET /projects/{id})
  • プロジェクトの登録API
    • (POST /projects)

変更内容

  • プロジェクトの登録APIのRequest bodyに任意項目としてassignment_url_enabled(プロジェクトの招待リンク機能設定)を追加
  • プロジェクト一覧取得APIとプロジェクト詳細の取得APIとプロジェクトの登録APIのResponsesに項目としてassignment_url_enabled(プロジェクトの招待リンク機能設定)を追加

リリース時期

  • 2025年1月23日(木)

【freee請求書】取引先に設定されている帳票テンプレートが優先して使用されるようになりました

freee請求書APIにおいて、取引先に設定されている帳票テンプレートがfreee請求書のデフォルトより優先して使用されるようになりました。

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

対象エンドポイント

  • 納品書の作成API(POST /delivery_slips)
  • 納品書の更新API(PUT /delivery_slips)
  • 請求書の作成API(POST /invoices)
  • 請求書の更新API(PUT /invoices)
  • 見積書の作成API(POST /quotations)
  • 見積書の更新API(PUT /quotations)

変更内容

  • freee請求書APIにおいて、取引先に設定されている帳票テンプレートが優先して使用されるようになりました。
  • 取引先に帳票テンプレートが設定されている場合、freee請求書のデフォルトの帳票テンプレートより優先して使用されます。
  • APIでtemplate_idを指定した場合、取引先の帳票テンプレートより優先して使用されます。
  • 取引先の帳票テンプレート設定については取引先を登録する – freee ヘルプセンターをご確認ください。

リリース時期

  • 2025年01月28日(火)

サービスメンテナンス(1/22)のお知らせ

下記の通り、freeeの全サービス (電子公告サービス除く) のメンテナンスを実施します。

・日時: 2025/1/22 (水) 1:00 – 5:00
・対象:freeeの全サービス (電子公告サービス除く)

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願い致します。

【freee人事労務】API仕様の変更について(人事労務API)

freee人事労務APIにおいて、カスタム権限のリリースに伴いログインユーザーのロール情報の値に変更が入ります。

変更点: 

  • 現在返却されている role の他に、新たにカスタム権限の role も返却されるようになります。
  • 現在返却されている role: clerk は事務担当者のカスタム権限化に伴い、返却されなくなります。

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

対象エンドポイント

  • ログインユーザーの取得(GET  /api/v1/users/me)

変更内容

  • ログインユーザー情報のroleの値にカスタムロールのrole_keyが追加されます。
  • ログインユーザー情報のroleの値からclerkが削除されます。

リリース時期

  • 2025年1月末予定

2024年11月の更新情報

(11/5)[会計]口座一覧の取得APIのレスポンスから’with_sync_status’ と ‘with_sync_status’ が追加されました。
(11/5)[会計]各種申請APIにおいて、「代理承認」という文言が「特権承認」という表現に変わりました。

以上です。

引き続きよろしくお願いいたします。

【重要】freee人事労務 API仕様の変更 実施のご連絡

以前、こちらでご案内していたfreee人事労務APIのエンドポイント追加に伴う廃止(変更内容①②)につきまして、事前に告知していた通り実施いたしますので、再度ご案内いたします。
【freee人事労務】API仕様の変更について

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

「freee人事労務」APIの仕様の詳細はリファレンスにてご確認ください。
freee人事労務 APIリファレンス

引き続きfreee人事労務APIをご利用いただけますと幸いです。

変更内容①

2024年6月にfreee人事労務でリリースされた複数回出退勤機能により、複数の出退勤時間が登録できることから勤務時間修正申請にも複数の出退勤時間を登録するためのリクエストパラメーター「work_records」を対象エンドポイントに追加いたしました。

追加にあたり、現行の出退勤時間を登録するためのリクエストパラメーター「clock_in_at(勤務開始時間)」「clock_out_at(勤務終了時間)」項目を廃止します。

対象エンドポイント

  • 勤務時間修正申請の作成 (POST /api/v1/approval_requests/work_times)
  • 勤務時間修正申請の更新 (PUT /api/v1/approval_requests/work_times/{id})

変更内容②

2024年6月にfreee人事労務でリリースされた複数回出退勤機能に伴い、時間表記を48時間形式で返却するためのリクエストパラメーター「use_48h_time_notation」を対象エンドポイントに追加いたしました。

この度の移行期間を持って「use_48h_time_notation」を廃止し、廃止後は時間表記が48時間形式固定になります。

対象エンドポイント

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

リリース時期

  • 2025年2月4日(火)予定

【freee会計】口座の取得APIの口座の同期ステータスが変更になります。

freee会計 口座の取得APIをご利用の開発者の皆様へ

freee会計 口座の取得APIにおいて、口座の同期ステータスを変更いたします。freee会計 口座の取得APIをご利用の開発者の皆様におかれましては、変更点をご確認いただき、アプリの改修などの必要な対応をいただきますよう、よろしくお願い申し上げます。

対象エンドポイント

  • 口座一覧の取得(GET walletables)
  • 口座の取得(GET walletable/{type}/{id})

変更内容

従来同期非対応のステータスはother_errorに分類されておりましたが、

‘unsupported’: 同期非対応として返却されるようになります。

同期非対応の口座については以下のヘルプページをご参照ください。

【一覧】freee会計と同期できる口座

リリース時期

  • 2024年12月17日(火)

サービスメンテナンス(12/19)のお知らせ

下記の通り、freeeの全サービス (電子公告サービス除く) のメンテナンスを実施します。

・日時: 2024/12/19 (木) 1:00 – 5:00
・対象:freeeの全サービス (電子公告サービス除く)

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願い致します。

2024年10月の更新情報

  • (10/29)[納品書・請求書・見積書]partner_contact_email_ccとpartner_contact_email_toのプロパティのリクエストへの追加されました。
    • POST delivery_slips
    • PUT /delivery_slips/{id}
    • POST /invoices
    • PUT /invoices/{id}
    • POST /quotations
    • PUT /quotations/{id}

以上です。

引き続きよろしくお願いいたします。

【freee会計】エラーコードが変更になります

freee会計APIをご利用の開発者の皆様へ

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

対象エンドポイント

freee会計APIのすべてのエンドポイント

変更内容

エラーコード ‘invalid_access_token’ と ‘expired_access_token’ を統合し、’expired_access_token’ に一本化いたします。

変更詳細

従来 ‘invalid_access_token’ として返却されていたエラーが、’expired_access_token’ として返却されるようになります。

リリース時期

2024年12月20日(金)頃

本変更に関してご不明な点がございましたら、freeeサポートまでお問い合わせください。

今後とも freee API をよろしくお願いいたします。

サービスメンテナンス(11/18)のお知らせ

freeeでは下記の日程で「freee各種プロダクトの計画メンテナンス」および「決済代行会社によるシステムメンテナンス」を予定しております。
計画メンテナンス中は該当するサービスをご利用いただけません。
ご迷惑をおかけし申し訳ございませんが、何卒ご理解とご協力をお願い申し上げます。

【freee各種プロダクト計画メンテナンス】
・予定日時: 2024/11/18(月) 1:00〜5:00
・対象サービス: freee会計、freee人事労務、freeeサインを含むfreee各サービスおよび各モバイルアプリ(freee電子公告・freee業務委託管理は除く)

【決済代行会社によるシステムメンテナンス】
・予定日時: 2024/11/18(月) 1:00〜7:00
・対象サービス:全freeeサービスの新規契約・契約内容の変更/更新(※契約操作以外のプロダクト機能はご利用いただけます)

メンテナンス中は該当サービスをご利用いただけません。

ご迷惑をおかけしますが、ご理解の程よろしくお願い致します。

【freee会計】口座の同期ステータスと最終同期成功日時が取得可能になりました

freee会計APIにおいて、口座の同期ステータス・最終同期成功日時の取得が可能になりました。

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

対象エンドポイント

  • 口座一覧の取得(GET walletables)
  • 口座の取得(GET walletable/{type}/{id})

変更内容

  • freee会計APIにおいて、口座の同期ステータス(sync_status)・最終同期成功日時(last_synced_at)が取得可能になりました。
  • 同期ステータスを取得するにはリクエストパラメータ with_sync_statusの指定が必要となります。
  • 最終同期成功日時を取得するにはリクエストパラメータ with_last_synced_atの指定が必要となります。
  • なおこちらの機能を利用しない場合のPublic APIについては通常通りご利用いただけます。

リリース時期

  • 2024年11月5日

【重要】freee会計API「請求書」「見積書」の更新・削除(PUT, DELETE)廃止, 「請求書」「見積書」の取得(GET)廃止について

以前、こちらでご案内していたfreee会計帳票APIの廃止ですが、時期未定としていたものの日程が決まりましたので、ご案内いたします。
【重要】freee会計 APIの仕様変更(インボイス制度対応)について

freee会計帳票APIをご利用の開発者の皆様におかれましては、変更点をご確認いただき、アプリの改修などの必要な対応をいただきますよう、よろしくお願い申し上げます。freee請求書APIをご利用いただけますと幸いです。

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

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

対象エンドポイント

  • freee会計「請求書」「見積書」の更新・削除(PUT, DELETE)
  • freee会計「請求書」「見積書」の取得(GET)

変更内容

  • 廃止となります。

リリース時期

  • 2025年1月末