以下の2024年10月30日に発信したお知らせの内容に訂正がありました。
詳しくは2024年10月30日発信のお知らせ内容の訂正をご覧ください。
2024年10月30日発信のお知らせ内容の訂正
訂正があったエンドポイントは以下となります
- 有給申請一覧の取得API（GET /api/v1/approval_requests/paid_holidays）
- Response
- paid_holidays->values->type
- 有給休暇の種別（full:全休、half:半休、morning_off:午前休、 afternoon_off:午後休、hour:時間休）
- paid_holidays->values->type
- Response
- 有給申請の取得API（GET /api/v1/approval_requests/paid_holidays/{id}）
- Response
- paid_holiday->values->type
- 有給休暇の種別（full:全休、half:半休、morning_off:午前休、 afternoon_off:午後休、hour:時間休）
- paid_holiday->values->type
- Response
- 有給申請の作成API（POST /api/v1/approval_requests/paid_holidays）
- Request
- values->type
- 休暇種別（full:全休、half:半休、morning_off:午前休、 afternoon_off:午後休、hour:時間休）
- values->type
- Request
- 有給申請の更新API（PUT /api/v1/approval_requests/paid_holidays/{id}）
- Request
- values->type
- 休暇種別（full:全休、half:半休、morning_off:午前休、 afternoon_off:午後休、hour:時間休）
- values->type
- Request
今回のリリースの詳細について、訂正内容を反映したものを再掲いたします。
概要
freee勤怠APIと勤怠情報月次サマリAPI、freee有給申請APIにおいて、従業員が半日単位と時間単位の年次有給休暇を同日に日次勤怠として登録・取得することができるようになります。
freee勤怠APIと勤怠情報月次サマリAPI、freee有給申請APIをご利用の開発者の皆様におかれましては、変更点をご確認いただき、アプリの改修などの必要な対応をいただきますよう、よろしくお願い申し上げます。
対象エンドポイント
- 勤怠の取得API（GET /api/v1/employees/{employee_id}/work_records/{date}）
- 勤怠の更新API（PUT /api/v1/employees/{employee_id}/work_records/{date}）
- 勤怠情報月次サマリの取得API（GET /api/v1/employees/{employee_id}/work_record_summaries/{year}/{month}）
- 有給申請一覧の取得API（GET /api/v1/approval_requests/paid_holidays）
- 有給申請の取得API（GET /api/v1/approval_requests/paid_holidays/{id}）
- 有給申請の作成API（POST /api/v1/approval_requests/paid_holidays）
- 有給申請の更新API（PUT /api/v1/approval_requests/paid_holidays/{id}）
- 有給申請の承認操作API（POST /api/v1/approval_requests/paid_holidays/{id}/actions）
新規機能の内容
- 勤怠の取得APIと勤怠情報月次サマリの取得APIは、従業員が半日単位と時間単位の年次有給休暇が同日に登録されている日次勤怠を取得することができるようになります。
- 勤怠の更新APIは、従業員が半日単位と時間単位の年次有給休暇を同日に日次勤怠として登録することができます。※１
- 有給申請一覧の取得APIと作成API、更新API、承認操作APIは、従業員が半日単位と時間単位の年次有給休暇が同日に登録されている日次勤怠実績の申請を取得することができます。
- 有給申請の作成APIと更新APIは、従業員が半日単位と時間単位の年次有給休暇が同日に登録されている日次勤怠実績を登録する申請を作成、更新することができます。※１
※１：半日単位と時間単位の年次有給休暇を同日に日次勤怠に登録するためには、勤怠基本設定で「年次有給休暇のうち半日単位と時間単位の同日取得を許可する」という設定が有効化されている必要があります。（勤怠基本設定で「年次有給休暇のうち半日単位と時間単位の同日取得を許可する」が設定可能になる機能のリリースに関するスケジュールは今後の対応予定のお知らせをご確認ください。）
年次有給休暇の同日取得に対応しない場合の影響
半日単位と時間単位の年次有給休暇が同日に登録されている勤怠や有給申請が存在しない場合には、勤怠APIや勤怠情報月次サマリAPI、有給申請APIには直ちに影響はありません。ただし、従来の有給休暇に関するパラメータは1年後を目処に削除予定のため非推奨となっております。
- 勤怠の更新APIにおいて、従来のパラメータを用いて半日単位と時間単位の年次有給休暇が同日に登録されている勤怠を更新する場合には、一律でエラーが発生するようになります。
- 有給申請の取得APIで半日単位と時間単位の年次有給休暇が同日に日次勤怠として登録する申請を取得する場合には、申請時に最初に設定した休暇情報が返されます。
- 有給申請の更新APIにおいて、従来のパラメータを用いて半日単位と時間単位の年次有給休暇が同日に勤怠を登録する申請を更新する場合には、一律でエラーが発生するようになります。
- ご利用方法の詳細はfreee人事労務APIのリファレンスページをご確認ください。人事労務APIリファレンス – freee Developers Community
勤怠の取得APIの変更内容
| 要素 | 型定義 | 変更前 | 変更後 |
| half_paid_holiday_mins | number(integer) | 有給休暇の半休を利用した時間（分単位） | [deprecated] 有給休暇の半休を利用した時間（分単位）※ 削除予定のため paid_holidays->minsを参照してください |
| hourly_paid_holiday_mins | number(integer) | 有給休暇の時間休を利用した時間（分単位） | [deprecated] 有給休暇の時間休を利用した時間（分単位）※ 削除予定のため paid_holidays->minsを参照してください |
| paid_holiday | number(float) | この日に対する有給取得日数。半休の場合は0.5が入ります。時間休の場合はhourly_paid_holiday_minsを所定労働時間で割った値が入るため、実際の時間を確認するにはhourly_paid_holiday_minsを参照してください。 | [deprecated] この日に対する有給取得日数。半休の場合は0.5が入ります。時間休の場合はhourly_paid_holiday_minsを所定労働時間で割った値が入るため、実際の時間を確認するにはhourly_paid_holiday_minsを参照してください。※ 削除予定のため paid_holidays の days または mins を参照してください |
| paid_holidays->type | string | – | 有給休暇の種別が返されます。（全休：full, 半休：half, 午前休：morning_off, 午後休：afternoon_off, 時間休：hourly） |
| paid_holidays->mins | number(integer) | – | 休暇時間（分単位） |
| paid_holidays->days | number(float) | – | 消化日数（全休：1, 半日単位：0.5, 時間休：0） |
勤怠の更新APIの変更内容
RequestBody
| 要素 | 型定義 | 変更前 | 変更後 |
| paid_holiday | number(float) | この日の有休取得日数。1日単位で指定します。 | [deprecated] この日の有休取得日数。1日単位で指定します。 ※ paid_holidaysを指定する場合にはこちらの値は参照されません ※ 削除予定のためpaid_holidays->type を指定してください |
| half_paid_holiday_mins | number(integer) | 有給休暇の半休を利用した時間（分単位） | [deprecated] 有給休暇の半休を利用した時間（分単位） ※ paid_holidaysを指定する場合にはこちらの値は参照されません※ 削除予定のためpaid_holidays->mins を指定してください |
| half_holiday_type | string | morning_off または afternoon_off を指定します | [deprecated] morning_off または afternoon_off を指定します ※ paid_holidaysを指定する場合にはこちらの値は参照されません※ 削除予定のためpaid_holidays->type を指定してください |
| hourly_paid_holiday_mins | number(integer) | 有給休暇の時間休を利用した時間（分単位） | [deprecated] 有給休暇の時間休を利用した時間（分単位） ※ paid_holidaysを指定する場合にはこちらの値は参照されません※ 削除予定のためpaid_holidays->mins を指定してください |
| paid_holidays->type | string | – | 有給休暇の種別を指定します（全休：full, 半休：half, 午前休：morning_off, 午後休：afternoon_off, 時間休：hourly） |
| paid_holidays->mins | number(integer) | – | 有給休暇を利用した時間（分単位） ※ 全休の場合や午前休、午後休の場合にはこちらの値は参照されません |
Response
勤怠の取得APIの変更内容と同様です。
勤怠情報月次サマリの取得APIの変更内容
| 要素 | 型定義 | 変更前 | 変更後 |
| work_records->half_paid_holiday_mins | number(integer) | 有給休暇の半休を利用した時間（分単位） | [deprecated] 有給休暇の半休を利用した時間（分単位）※ 削除予定のためwork_records->paid_holidays を参照してください |
| work_records->hourly_paid_holiday_mins | number(integer) | 有給休暇の時間休を利用した時間（分単位） | [deprecated] 有給休暇の時間休を利用した時間（分単位）※ 削除予定のためwork_records->paid_holidays を参照してください |
| work_records->paid_holiday | number(float) | この日に対する有給取得日数。半休の場合は0.5が入ります。時間休の場合はhourly_paid_holiday_minsを所定労働時間で割った値が入るため、実際の時間を確認するにはhourly_paid_holiday_minsを参照してください。 | [deprecated] この日に対する有給取得日数。半休の場合は0.5が入ります。時間休の場合はhourly_paid_holiday_minsを所定労働時間で割った値が入るため、実際の時間を確認するにはhourly_paid_holiday_minsを参照してください。※ 削除予定のためwork_records->paid_holidays を参照してください |
| work_records->paid_holidays->type | string | – | 有給休暇の種別（full:全休、half:半休、morning_off:午前休、 afternoon_off:午後休、hourly:時間休） |
| work_records->paid_holidays->mins | number(integer) | – | 年次有給休暇の休暇時間（分単位） |
| work_records->paid_holidays->days | number(float) | – | 消化日数（全休：1, 半日単位：0.5, 時間休：0） |
有給申請一覧の取得APIの変更内容
| 要素 | 型定義 | 変更前 | 変更後 |
| paid_holidays->start_at | string | 取得予定開始時間 | [deprecated] 取得予定開始時間 ※ 削除予定のためpaid_holidays->values->start_at を参照してください |
| paid_holidays->end_at | string | 取得予定終了時間 | [deprecated] 取得予定終了時間 ※ 削除予定のためpaid_holidays->values->end_at を参照してください |
| paid_holidays->holiday_type | string | 取得単位。（full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休） | [deprecated] 取得単位。（full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休）※ 削除予定のためpaid_holidays->values->type を参照してください |
| paid_holidays->values->type | string | – | 有給休暇の種別（full:全休、half:半休、morning:午前休、 afternoon:午後休、hourly:時間休） |
| paid_holidays->values->start_at | string | – | 取得予定開始時間 |
| paid_holidays->values->end_at | string | – | 取得予定終了時間 |
有給申請の取得APIの変更内容
| 要素 | 型定義 | 変更前 | 変更後 |
| paid_holiday->start_at | string | 取得予定開始時間 | [deprecated] 取得予定開始時間 ※ 削除予定のためpaid_holiday->values->start_at を参照してください |
| paid_holiday->end_at | string | 取得予定終了時間 | [deprecated] 取得予定終了時間※ 削除予定のためpaid_holiday->values->end_at を参照してください |
| paid_holiday->holiday_type | string | 取得単位。（full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休） | [deprecated] 取得単位。（full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休）※ 削除予定のためpaid_holiday->values->type を参照してください |
| paid_holiday->values->type | string | – | 有給休暇の種別（full:全休、half:半休、morning:午前休、 afternoon:午後休、hourly:時間休） |
| paid_holiday->values->start_at | string | – | 取得予定開始時間 |
| paid_holiday->values->end_at | string | – | 取得予定終了時間 |
有給申請の作成、更新APIの変更内容
RequestBody
| 要素 | 型定義 | 変更前 | 変更後 |
| start_at | string | 取得予定開始時間 | [deprecated] 取得予定開始時間 ※ paid_holidays->values を指定している場合にはこちらの値は参照されません ※ 削除予定のためvalues->start_at を指定してください |
| end_at | string | 取得予定終了時間 | [deprecated] 取得予定終了時間 ※ paid_holidays->valuesを指定している場合にはこちらの値は参照されません ※ 削除予定のためvalues->end_at を指定してください |
| holiday_type | string | 取得単位。（full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休） | [deprecated] 取得単位。（full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休） ※ paid_holidays->valuesを指定している場合にはこちらの値は参照されません ※ 削除予定のためvalues->type を指定してください |
| values->type | string | – | 休暇種別（full:全休、half:半休、morning:午前休、 afternoon:午後休、hourly:時間休） |
| values->start_at | string | – | 取得予定開始時間 ※全休の場合や午前休、午後休の場合にはこちらの値は参照されません |
| values->end_at | string | – | 取得予定終了時間 ※全休の場合や午前休、午後休の場合にはこちらの値は参照されません |
Response
有給申請の取得APIの変更内容と同様です。
有給申請の承認APIの変更内容
RequestBody
変更はありません。
Response
有給申請の取得APIの変更内容と同様です。
リリース時期
- web版における同日取得の対応時期
- PublicAPIにおける同日取得の対応時期
- 1月中予定