【重要】[freee人事労務API] 変更のお知らせ

■ 概要
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

従業員番号(num)フィールドが未設定の場合に返却していた null を廃止し、今後は空文字列 (“”) を返却します。

レスポンス型そのものは string のままのため、ほとんどのアプリは改修不要ですが、null を前提に実装している場合はご確認をお願いします。

■ 変更内容
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

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

変更種別:Non-Breaking Change

変更内容:

1. レスポンスの変更

GET系リクエストおよびPOST/PUT後のレスポンスにおいて、numが未設定の場合はnullではなく空文字列 (“”) を返却します。
POST /employees などでnumを省略して作成した従業員も、取得時には空文字列を返却します。

2. APIリファレンスの更新

現在、nullで返却されているnumは、変更後は空文字で返却されるようになります。
レスポンスのnumは常にstringとなるため、nullable:trueを削除します。

対象エンドポイントは以下の通りです。

  • 賞与明細:
    • GET /bonuses/employee_payroll_statements
    • GET /bonuses/employee_payroll_statements/{id}
  • 従業員:
    • GET /company/employees
    • GET /employees
    • GET /employees/{id}
    • POST /employees
    • PUT /employees/{id}
  • 所属:
    • GET /employee_group_memberships
  • 年末調整:
    • GET /yearend_adjustment/employees
    • GET /yearend_adjustment/employees/{id}
    • PUT /yearend_adjustment/employees/{id}
  • 給与明細:
    • GET /salaries/employee_payroll_statements
    • GET /salaries/employee_payroll_statements/{id}


変更理由:

null と空文字列が混在しているため、未設定値を空文字列に統一します。

■ 変更スケジュール
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

アナウンス日:2025/07/24

変更リリース予定日:2025/09/01

■ 対応方法
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

バリデーションやシリアライズで num を optional string として扱っている場合は変更不要です。

SDK/型定義をコード生成している場合、更新後に nullable:false へ変わりますので、 型定義の再生成を推奨します。

■ 変更後のAPI仕様
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

エンドポイント例:GET /employees/{id}

【変更前】

{

“id”: 123,

“num”: null,

}

【変更後】

{

“id”: 123,

“num”: “”,

}

(POST /employees で num を省略してリクエストしても、レスポンスには “” が返却されます)