従業員休暇設定一覧取得

GET

/staff/holidaySettings

サンドボックス
本番

従業員休暇設定一覧を取得します

対象

プラン
- プレミアム
- プレミアムプラス
- エンタープライズ、旧有料

対象ユーザー権限

休暇管理閲覧

Authorizations

AppAccessToken
timecard.holidays:read
UserAccessToken
timecard.holidays:read

Parameters

Query Parameters

staff_id

string

従業員ID（カンマ区切りで複数指定可）

Examples

単一指定

複数指定

1,2

termination

number

Allowed values: 0 1

退職者を含めて表示するかどうか

0: 表示しない
1: 表示する

Example

warning

number

Allowed values: 0 1

有給取得義務警告が出ている従業員のみを表示するかどうか

0: 警告が出ている従業員を含めて表示
1: 警告が出ている従業員のみ表示

Example

staff_group_code

string

従業員グループコード（カンマ区切りで複数指定可）

Examples

単一指定

GROUP01

複数指定

GROUP01,GROUP02

from_date

string format: date

検索開始日 [YYYY-MM-DD]

Example

2020-04-01

to_date

string format: date

検索終了日 [YYYY-MM-DD]

Example

2020-06-30

limit

integer

default: 30 >= 1 <= 100

上限値

Example

page

integer

default: 1 >= 1

検索対象ページ番号

Example

Responses

200

取得成功

object

count

件数

number

page

現在のページ番号

number

pageCount

総ページ数

number

holidaySettings

従業員別休暇設定リスト

Array<object>

object

staffId

従業員ID

string

staffCode

社員番号

string

staffName

従業員名

string

hireDate

入社日 [YYYY-MM-DD]

string format: date

terminationDate

退職日 [YYYY-MM-DD]

string format: date

terminationFlag

退職済みかどうか

0: 未退職
1: 退職済み

string

Allowed values: 0 1

employeeClassificationId

従業員区分ID

string

employeeClassificationName

従業員区分名

string

autoGrantPaidHolidayDivision

有給付与自動化区分

0: 手動付与
1: 自動付与（毎週の労働日数: 週5日以上）
2: 自動付与（毎週の労働日数: 週4日）
3: 自動付与（毎週の労働日数: 週3日）
4: 自動付与（毎週の労働日数: 週2日）
5: 自動付与（毎週の労働日数: 週1日）
6: 自動付与（勤務実績から計算）（属する従業員区分で「付与日数の計算方法」が「出勤日数から計算」の場合）

string

Allowed values: 0 1 2 3 4 5 6

autoGrantPaidHolidayConsiderAttendanceRate

有給休暇自動付与時に出勤率を考慮する

0: しない
1: する

integer

Allowed values: 0 1

autoGrantPaidHolidayAttendanceRateStoreId

有給休暇自動付与時に休日設定を参照する事業所ID

integer

nullable

totalGrantDays

期間内付与日数

string

totalGrantMinutes

期間内時間休付与時間数(分)

integer

totalDigestionDays

期間内取得日数

string

totalDigestionMinutes

期間内時間休取得時間数(分)

integer

totalExpirationDays

期間内失効日数

string

totalExpirationMinutes

期間内時間休失効時間数(分)

integer

fromDate

検索開始日 [YYYY-MM-DD]

string format: date

toDate

検索終了日 [YYYY-MM-DD]

string format: date

carryOverDays

前年からの繰越日

string

carryOverMinutes

前年からの時間休繰越時間数(分)

integer

workingTotalMonth

入社日からの勤続月数

string

remainingDays

有給残日数

string

remainingMinutes

有給残時間数(分)

integer

holidayWarningFlag

有給取得義務警告の有無

"": 警告なし
1: 警告あり

string

Allowed values: "" 1

Example

{
  "count": 50,
  "page": 1,
  "pageCount": 3,
  "holidaySettings": [
    {
      "staffId": "1",
      "staffCode": "A001",
      "staffName": "スマレジ太郎",
      "hireDate": "2020-04-01",
      "terminationDate": "",
      "terminationFlag": "0",
      "employeeClassificationId": "1",
      "employeeClassificationName": "正社員",
      "autoGrantPaidHolidayDivision": "1",
      "autoGrantPaidHolidayConsiderAttendanceRate": 1,
      "autoGrantPaidHolidayAttendanceRateStoreId": 1,
      "totalGrantDays": "20",
      "totalGrantMinutes": 480,
      "totalDigestionDays": "5",
      "totalDigestionMinutes": 240,
      "totalExpirationDays": "0",
      "totalExpirationMinutes": 0,
      "fromDate": "2020-04-01",
      "toDate": "2021-03-31",
      "carryOverDays": "0",
      "carryOverMinutes": 0,
      "workingTotalMonth": "36",
      "remainingDays": "15",
      "remainingMinutes": 240,
      "holidayWarningFlag": ""
    },
    {
      "staffId": "2",
      "staffCode": "A002",
      "staffName": "スマレジ花子",
      "hireDate": "2019-04-01",
      "terminationDate": "",
      "terminationFlag": "0",
      "employeeClassificationId": "2",
      "employeeClassificationName": "アルバイト",
      "autoGrantPaidHolidayDivision": "2",
      "autoGrantPaidHolidayConsiderAttendanceRate": 0,
      "autoGrantPaidHolidayAttendanceRateStoreId": 0,
      "totalGrantDays": "10",
      "totalGrantMinutes": 0,
      "totalDigestionDays": "7",
      "totalDigestionMinutes": 0,
      "totalExpirationDays": "0",
      "totalExpirationMinutes": 0,
      "fromDate": "2019-04-01",
      "toDate": "2020-03-31",
      "carryOverDays": "0",
      "carryOverMinutes": 0,
      "workingTotalMonth": "48",
      "remainingDays": "3",
      "remainingMinutes": 0,
      "holidayWarningFlag": "1"
    }
  ]
}

Headers

Link

string

<前のURI>; rel="prev", <次のURI>; rel="next"

400

パラメータに誤りがある場合

object

type

エラータイプを識別するURI、もしくはabout:blank

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "集計開始時刻はyyyy-MM-ddで送信してください。"
}