従業員休暇一覧取得

GET

/staff/holidays

サンドボックス
本番

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

対象

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

対象ユーザー権限

休暇管理閲覧

Authorizations

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

Parameters

Query Parameters

staff_name

string

従業員名

Example

スマレジ太郎

staff_code

string

社員番号

Example

EMP001

holiday_name

string

休暇名

Example

有給休暇

from_date

required

string format: date

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

Example

2020-01-01

to_date

required

string format: date

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

Example

2020-01-31

absence_flag

string

Allowed values: 0 1

欠勤扱いかどうか

0: 欠勤扱いでないもののみを表示する
1: 欠勤扱いのみを表示する

未指定で全て表示する

Example

paid_hoiday_flag

string

Allowed values: 0 1

有給取得かどうか

0: 有給取得でないもののみを表示する
1: 有給取得のみを表示する

未指定で全て表示する

Example

limit

integer

default: 30 >= 1 <= 100

上限値

Example

page

integer

default: 1 >= 1

検索対象ページ番号

Example

Responses

200

取得成功

object

count

件数

number

page

現在のページ番号

number

pageCount

総ページ数

number

staffHolidays

休暇詳細リスト

Array<object>

object

staffHolidayId

従業員有給ID

string

applicationDivision

申請区分

1: 作成
2: 修正
3: 削除

string

Allowed values: 1 2 3

division

休暇区分

0: 通常
1: 振替休日
2: 代休

string

Allowed values: 0 1 2

staffId

従業員ID

string

staffName

従業員名

string

fromDate

休暇期間開始日 [YYYY-MM-DD]

string format: date

fromDateTime

休暇開始日時 [YYYY-MM-DDThh:mm:ssTZD]
※ 時間休以外の場合はnull

string format: date-time

nullable

toDate

休暇期間終了日 [YYYY-MM-DD]
※ 半休・時間休の場合は常に休暇期間開始日と同一日

string format: date

toDateTime

休暇終了日時 [YYYY-MM-DDThh:mm:ssTZD]
※ 時間休以外の場合はnull

string format: date-time

nullable

totalDigestValue

合計休暇取得日

string

totalDigestMinutes

合計時間休暇取得時間(分)

integer

holidayWorkDate

休日出勤日（休日出勤日が存在する場合のみ） [YYYY-MM-DD]

string format: date

memo

メモ

string

holidaySettingId

休暇設定ID

string

holidaySettingName

休暇名

string

absenceFlag

欠勤扱い
欠勤扱いとするかどうか

0: しない
1: する

string

Allowed values: 0 1

paidHolidayFlag

有給取得
有給を取得するかどうか

0: しない
1: する

string

Allowed values: 0 1

halfDayFlag

半休
半日の休暇を設定できるようにするかどうか

0: しない
1: する

string

Allowed values: 0 1

hourlyFlag

時間単位の休暇かどうか

boolean

treatAsAttendanceFlag

出勤扱い
有給自動付与時の出勤率の算定において出勤扱いとするかどうか

0: しない
1: する

integer

Allowed values: 0 1

Example

{
  "count": 5,
  "page": 1,
  "pageCount": 1,
  "staffHolidays": [
    {
      "staffHolidayId": "2",
      "applicationDivision": "1",
      "division": "2",
      "staffId": "2",
      "staffName": "スマレジ花子",
      "fromDate": "2020-12-28",
      "fromDateTime": null,
      "toDate": "2020-12-28",
      "toDateTime": null,
      "totalDigestValue": "1",
      "totalDigestMinutes": 0,
      "holidayWorkDate": "2020-12-26",
      "memo": "年末年始対応の代休",
      "holidaySettingId": "2",
      "holidaySettingName": "代休",
      "absenceFlag": "0",
      "paidHolidayFlag": "0",
      "halfDayFlag": "0",
      "hourlyFlag": false,
      "treatAsAttendanceFlag": 1
    },
    {
      "staffHolidayId": "3",
      "applicationDivision": "1",
      "division": "0",
      "staffId": "3",
      "staffName": "スマレジ次郎",
      "fromDate": "2020-11-30",
      "fromDateTime": "2020-11-30T13:00:00+09:00",
      "toDate": "2020-11-30",
      "toDateTime": "2020-11-30T17:00:00+09:00",
      "totalDigestValue": "0",
      "totalDigestMinutes": 240,
      "holidayWorkDate": "",
      "memo": "時間休（4時間）",
      "holidaySettingId": "1",
      "holidaySettingName": "有給休暇",
      "absenceFlag": "0",
      "paidHolidayFlag": "1",
      "halfDayFlag": "0",
      "hourlyFlag": true,
      "treatAsAttendanceFlag": 1
    },
    {
      "staffHolidayId": "1",
      "applicationDivision": "1",
      "division": "0",
      "staffId": "1",
      "staffName": "スマレジ太郎",
      "fromDate": "2020-11-23",
      "fromDateTime": null,
      "toDate": "2020-11-23",
      "toDateTime": null,
      "totalDigestValue": "1",
      "totalDigestMinutes": 0,
      "holidayWorkDate": "",
      "memo": "体調不良による有給取得",
      "holidaySettingId": "1",
      "holidaySettingName": "有給休暇",
      "absenceFlag": "0",
      "paidHolidayFlag": "1",
      "halfDayFlag": "0",
      "hourlyFlag": false,
      "treatAsAttendanceFlag": 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で送信してください。"
}