【freee人事労務】API仕様の変更について(勤怠API、勤怠情報サマリAPI)

freee人事労務APIにおいて、以下の仕様変更があります。

  • 勤怠APIのリクエストボディとレスポンス、勤怠情報サマリAPIのレスポンスに変更があります。
  • 勤怠APIで特別休暇および有給休暇(時間休)の勤怠登録が可能になります。
  • 勤怠APIでの有給休暇(半休)の勤怠登録に変更があります。

この変更は2段階に分けて行います。

変更内容①は11月中旬に、破壊的な変更を含む変更②は2024年2月上旬に行います。

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

変更内容①:

freee人事労務 勤怠の取得API、勤怠の更新APIのリクエストボディとレスポンス、および勤怠情報月次サマリの取得API(work_records=trueの場合)のレスポンスに以下の項目を追加します。

  • half_paid_holiday_mins :有給休暇の半休を利用した時間(分単位)
  • special_holiday :この日の特別休暇取得数
  • special_holiday_setting_id :特別休暇設定ID
  • half_special_holiday_mins :特別休暇の半休を利用した時間(分単位)
  • hourly_special_holiday_mins :特別休暇の時間休を利用した時間(分単位)

freee人事労務 勤怠の更新APIにおいて、特別休暇の登録が可能になります。

  • 特別休暇(全休)は、special_holiday_setting_idとspecial_holiday=1を指定してください。
  • 特別休暇(半休)は、special_holiday_setting_idとhalf_special_holiday_minsを指定してください。
  • 特別休暇(時間休)は、special_holiday_setting_idとhourly_special_holiday_minsを指定してください。

freee人事労務 勤怠の更新APIにおいて、有給休暇(時間休)の登録が可能になります。

  • hourly_paid_holiday_minsを指定してください。

freee人事労務 勤怠の更新APIにおいて、有給休暇(半休)の登録方法に変更があります。

  • half_paid_holiday_minsを指定してください。
  • なお非推奨ではありますが、現行の有給休暇(半休)登録方法も引き続き使用できます。
    • normal_work_mins_by_paid_holiday(有給によって計上される所定労働時間(分))を指定します。paid_holiday(この日の有給休暇取得数)=0.5は入力不要です(入力してもエラーにはなりません)。

対象エンドポイント:

  • 勤怠の取得API(PUT /api/v1/employees/{employee_id}/work_records/{date})
  • 勤怠の更新API(PUT /api/v1/employees/{employee_id}/work_records/{date})
  • 勤怠情報月次サマリの取得API(/api/v1/employees/{employee_id}/work_record_summaries/{year}/{month})

変更理由:

  • freee人事労務の特別休暇をAPIで登録できるようにするためです。
  • freee人事労務の有給休暇(時間休)をAPIで登録できるようにするためです。
  • 有給休暇(半休)登録方法の移行期間を設けます。現行の登録方法も利用可能とするこの期間内に、アプリの改修など必要な対応を完了していただくためです。

変更の実施時期:

  • 2023年11月中旬

変更内容②:(破壊的な変更を含む)

freee人事労務 勤怠の取得API、勤怠の更新API、勤怠情報月次サマリの取得API(work_records)のレスポンスから、以下の項目を廃止します。

  • normal_work_mins_by_paid_holiday:有給によって計上される所定労働時間(分)

freee人事労務 勤怠の更新APIのリクエストボディから、以下の項目を廃止します。

  • normal_work_mins_by_paid_holiday:有給によって計上される所定労働時間(分)
  • このため、現行の有給休暇(半休)登録方法が使用できなくなります。
  • normal_work_mins_by_paid_holidayに時間を指定しても、有給休暇(半休)の登録はできなくなります。
  • paid_holiday(この日の有給休暇取得数)は1(全休)以外を指定するとエラーになります。

対象エンドポイント:

  • 勤怠の取得API(PUT /api/v1/employees/{employee_id}/work_records/{date})
  • 勤怠の更新API(PUT /api/v1/employees/{employee_id}/work_records/{date})
  • 勤怠情報月次サマリの取得API(/api/v1/employees/{employee_id}/work_record_summaries/{year}/{month})

変更理由:

  • 勤怠APIの有給休暇(半休)登録方法の変更に伴う移行対応期間を終了します。
  • ※変更の実施時期までに、アプリの改修など必要な対応を完了してください。

変更の実施時期:

  • 2024年2月上旬