freee人事労務APIの仕様変更について

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

変更の実施予定時期:

2021年12月

変更内容:

給与明細APIで従業員の給与明細を取得する際、配列[overtime_pays]に含まれる内容が下記のように変更されます。

変更前:

name(項目名), time(時間[分]) ,amount(手当金額)の3項目が返却され、固定残業代および固定残業代の超過額は「固定割増手当」および「固定割増手当超過額」という項目名で返却されます。

レスポンスデータ例

overtime_pays: [
  {
    name: '法定内残業',
    time: '600.0'
    amount: '12350.0'
  },
  {
     name: '固定割増手当',
     time: null,
     amount: '100000.0'
  },
  {
     name: '固定割増手当超過額',
     time: null,
     amount: '0.0'
  }

変更後:

変更前の3項目に加え、事業所毎に任意に設定可能な小文字英数最大10桁のcode(コード)が返却され、固定残業代および固定残業代の超過額にも事業所毎でユーザーが設定した任意の項目名(最大20文字)で返却されます。
code(コード)には固定残業代および固定残業代の超過額場合にname(項目名)に対応する値が入り、それ以外の場合はnullが返却されます。

レスポンスデータ例

overtime_pays: [
  {
    name: '法定内残業',
    time: '600.0'
    amount: '12350.0',
    code: null
  },
  {
     name: 'カスタム固定残業代1',
     time: null,
     amount: '100000.0',
     code: 'a001'
  },
  {
     name: 'カスタム固定残業代1超過分',
     time: null,
     amount: '0.0',
     code: 'a001'
  },
 {
     name: 'カスタム固定残業代2',
     time: null,
     amount: '100000.0',
     code: 'a002'
  },
  {
     name: 'カスタム固定残業代2超過分',
     time: null,
     amount: '0.0',
     code: 'a002'
  },
  ...

対象エンドポイント:

  • GET /api/v1/salaries/employee_payroll_statements
  • GET /api/v1/salaries/employee_payroll_statements/{employee_id}

変更理由:

固定残業代付与に関する機能改善のため。(freee人事労務の仕様変更によるもの)

改訂履歴:

2021年11月17日

  • 変更の実施予定時期を2021年10月から2021年12月に変更しました
  • 変更後の記載をより詳細化しました
  • 変更前・変更後それぞれのレスポンスサンプルを記載しました