勤怠実績一覧取得

GET

/shifts/results

• サンドボックス
• 本番

勤怠実績の一覧を取得します。
データは勤務実績ごとのリストで返却されます。
一日に複数回勤務した場合は、同じ勤務日のデータが複数返却されます。

対象

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

対象ユーザー権限

• 実績閲覧

Authorizations

• AppAccessToken
  timecard.shifts:read
• UserAccessToken
  timecard.shifts:read

Parameters

Query Parameters

from_date

required

string format: date

/^\d{4}-\d{2}-\d{2}/

期間（開始） [YYYY-MM-DD]
検索対象の期間（開始）を指定します。
期間（終了）to_date との期間の差は3ヶ月までで指定してください。

Example

2022-01-01

to_date

required

string format: date

/^\d{4}-\d{2}-\d{2}$/

期間（終了） [YYYY-MM-DD]
検索対象の期間（終了）を指定します。

Example

2022-01-31

staff_id

Array<integer>

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

Example

?staff_id=1,2,3

store_id

Array<integer>

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

Example

?store_id=1,2,3

min_working_minutes

integer

10

指定すると、指定した値以上の勤務時間（分）で絞り込みます。

max_working_minutes

integer

10

指定すると、指定した値以下の勤務時間（分）で絞り込みます。

min_total_overtime_minutes

integer

10

指定すると、指定した値以上の合計時間外労働時間（分）で絞り込みます。
こちらの合計時間外労働時間はレスポンス内の

• overtimeMinutes
• over45HourOvertimeMinutes
• over60HourOvertimeMinutes

の合計に対して絞り込みます。

max_total_overtime_minutes

integer

10

指定すると、指定した値以下の合計時間外労働時間（分）で絞り込みます。
こちらの合計時間外労働時間はレスポンス内の

• overtimeMinutes
• over45HourOvertimeMinutes
• over60HourOvertimeMinutes

の合計に対して絞り込みます。

min_overtime_minutes

integer

10

指定すると、指定した値以上の時間外労働時間（分）で絞り込みます。

max_overtime_minutes

integer

10

指定すると、指定した値以下の時間外労働時間（分）で絞り込みます。

min_45overtime_minutes

integer

10

指定すると、指定した値以上の月45時間超時間外労働時間（分）で絞り込みます。

max_45overtime_minutes

integer

10

指定すると、指定した値以下の月45時間超時間外労働時間（分）で絞り込みます。

min_60overtime_minutes

integer

10

指定すると、指定した値以上の月60時間超時間外労働時間（分）で絞り込みます。

max_60overtime_minutes

integer

10

指定すると、指定した値以下の月60時間超時間外労働時間（分）で絞り込みます。

min_midnight_minutes

integer

10

指定すると、指定した値以上の深夜労働時間（分）で絞り込みます。

max_midnight_minutes

integer

10

指定すると、指定した値以下の深夜労働時間（分）で絞り込みます。

min_break_minutes

integer

10

指定すると、指定した値以上の休憩時間（分）で絞り込みます。

max_break_minutes

integer

10

指定すると、指定した値以下の休憩時間（分）で絞り込みます。

min_tardy_minutes

integer

10

指定すると、指定した値以上の遅刻時間（分）で絞り込みます。

max_tardy_minutes

integer

10

指定すると、指定した値以下の遅刻時間（分）で絞り込みます。

min_early_leaving_minutes

integer

10

指定すると、指定した値以上の早退時間（分）で絞り込みます。

max_early_leaving_minutes

integer

10

指定すると、指定した値以下の早退時間（分）で絞り込みます。

holiday_type

Array<string>

default: none,prescribed,statutory

Allowed values: none prescribed statutory

[
  "prescribed",
  "statutory"
]

休日出勤区分を指定します（カンマ区切りで複数指定可）。省略すると全てのデータを対象とします。

• none: 通常勤務
• prescribed: 所定休日出勤
• statutory: 法定休日出勤

page

integer

default: 1 >= 1

検索対象ページ番号

Example

2

limit

integer

default: 30 >= 1 <= 2000

上限値
※この API ではページネーションで記載した上限値とは範囲が異なりますのでご注意ください。

Example

100

sort

string

ソート順
パラメータ名で昇順、パラメータ名:descで降順指定可 カンマ区切りで複数項目指定可
以下の項目でソートが可能です。

• shift_date
• staff_id
• staff_code
• store_id
• attendance_at
• leaving_at
• break_1_start_at
• break_1_end_at
• break_2_start_at
• break_2_end_at
• working_minutes
• overtime_minutes
• over_45_hour_overtime_minutes
• over_60_hour_overtime_minutes
• midnight_minutes
• break_minutes
• tardy_minutes
• early_leaving_minutes
• holiday_type

指定しない場合、出勤時間の降順でデータがソートされます。

Example

shift_date,staff_id:desc

Responses

200

取得成功

object

count

件数

number

page

現在のページ番号

number

pageCount

総ページ数

number

results

勤怠実績一覧

Array<object>

object

shiftDate

勤務日 [YYYY-MM-DD]

string format: date

staffId

従業員ID

string

staffName

従業員名

string

staffCode

社員番号

string

staffClassificationId

従業員区分ID

string

staffClassificationName

従業員区分名

string

staffGroups

従業員グループ情報

Array<object>

object

staffGroupCode

従業員グループコード

string

staffGroupName

従業員グループ名

string

positionId

役職ID

string

nullable

positionName

役職名

string

nullable

storeId

事業所ID

string

storeName

事業所名

string

attendanceAtRounded

出勤時間（丸め後） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

attendanceAt

出勤時間（丸め前） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

attendanceLatitude

出勤緯度

number format: double

nullable

attendanceLongitude

出勤経度

number format: double

nullable

attendanceHorizontalAccuracy

出勤時水平精度（m）

integer

nullable

attendanceAddress

出勤住所

string

nullable <= 255 characters

leavingAtRounded

退勤時間（丸め後） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

leavingAt

退勤時間（丸め前） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

leavingLatitude

退勤緯度

number format: double

nullable

leavingLongitude

退勤経度

number format: double

nullable

leavingHorizontalAccuracy

退勤時水平精度（m）

integer

nullable

leavingAddress

退勤住所

string

nullable <= 255 characters

break1StartAtRounded

休憩1 開始時間（丸め後） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

break1StartAt

休憩1 開始時間（丸め前） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

break1StartLatitude

休憩1 開始緯度

number format: double

nullable

break1StartLongitude

休憩1 開始経度

number format: double

nullable

break1StartHorizontalAccuracy

休憩1 開始時水平精度（m）

integer

nullable

break1StartAddress

休憩1 開始住所

string

nullable <= 255 characters

break1EndAtRounded

休憩1 終了時間（丸め後） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

break1EndAt

休憩1 終了時間（丸め前） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

break1EndLatitude

休憩1 終了緯度

number format: double

nullable

break1EndLongitude

休憩1 終了経度

number format: double

nullable

break1EndHorizontalAccuracy

休憩1 終了時水平精度（m）

integer

nullable

break1EndAddress

休憩1 終了住所

string

nullable <= 255 characters

break2StartAtRounded

休憩2 開始時間（丸め後） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

break2StartAt

休憩2 開始時間（丸め前） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

break2StartLatitude

休憩2 開始緯度

number format: double

nullable

break2StartLongitude

休憩2 開始経度

number format: double

nullable

break2StartHorizontalAccuracy

休憩2 開始時水平精度（m）

integer

nullable

break2StartAddress

休憩2 開始住所

string

nullable <= 255 characters

break2EndAtRounded

休憩2 終了時間（丸め後） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

break2EndAt

休憩2 終了時間（丸め前） [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

nullable

break2EndLatitude

休憩2 終了緯度

number format: double

nullable

break2EndLongitude

休憩2 終了経度

number format: double

nullable

break2EndHorizontalAccuracy

休憩2 終了時水平精度（m）

integer

nullable

break2EndAddress

休憩2 終了住所

string

nullable <= 255 characters

workingMinutes

勤務時間（単位: 分）

integer

overtimeMinutes

時間外労働時間（単位: 分）
月45時間超時間外労働時間・月60時間超時間外労働時間を含みません。

integer

over45HourOvertimeMinutes

月45時間超時間外労働時間（単位: 分）

integer

over60HourOvertimeMinutes

月60時間超時間外労働時間（単位: 分）

integer

midnightMinutes

深夜労働時間（単位: 分）

integer

breakMinutes

休憩時間（単位: 分）

integer

holidayDeemedWorkingMinutes

休暇みなし労働時間（単位: 分）

integer

tardyMinutes

遅刻時間（単位: 分）

integer

earlyLeavingMinutes

早退時間（単位: 分）

integer

holidayType

休日出勤区分

• none: 通常勤務
• prescribed: 所定休日出勤
• statutory: 法定休日出勤

string

Allowed values: none prescribed statutory

calculated

勤怠・給与情報が確定しているかどうかを示します。
勤怠・給与情報が確定してしない場合、時間外労働時間などの情報が未確定である可能性があります。
参考:
『給与を確定させる』が表示される条件について – スマレジ・タイムカード サポート
給与を再計算する方法 – スマレジ・タイムカード サポート

boolean

Example

{
  "count": 2,
  "page": 1,
  "pageCount": 1,
  "results": [
    {
      "shiftDate": "2022-01-01",
      "staffId": "1",
      "staffName": "スマレジ 太郎",
      "staffCode": "001",
      "staffClassificationId": "1",
      "staffClassificationName": "正社員",
      "staffGroups": [
        {
          "staffGroupCode": "1",
          "staffGroupName": "グループA",
          "positionId": "1",
          "positionName": "課長"
        }
      ],
      "storeId": "2",
      "storeName": "スマレジ 大阪店",
      "attendanceAtRounded": "2022-01-01T09:00:00+09:00",
      "attendanceAt": "2022-01-01T08:59:23+09:00",
      "attendanceLatitude": 34.684206,
      "attendanceLongitude": 135.507926,
      "attendanceHorizontalAccuracy": 20,
      "attendanceAddress": "大阪府大阪市中央区本町四丁目",
      "leavingAtRounded": "2022-01-01T18:00:00+09:00",
      "leavingAt": "2022-01-01T18:00:45+09:00",
      "leavingLatitude": 34.684206,
      "leavingLongitude": 135.507926,
      "leavingHorizontalAccuracy": 20,
      "leavingAddress": "大阪府大阪市中央区本町四丁目",
      "break1StartAtRounded": "2022-01-01T12:00:00+09:00",
      "break1StartAt": "2022-01-01T11:59:15+09:00",
      "break1StartLatitude": 34.684206,
      "break1StartLongitude": 135.507926,
      "break1StartHorizontalAccuracy": 20,
      "break1StartAddress": "大阪府大阪市中央区本町四丁目",
      "break1EndAtRounded": "2022-01-01T13:00:00+09:00",
      "break1EndAt": "2022-01-01T12:59:30+09:00",
      "break1EndLatitude": 34.684206,
      "break1EndLongitude": 135.507926,
      "break1EndHorizontalAccuracy": 20,
      "break1EndAddress": "大阪府大阪市中央区本町四丁目",
      "break2StartAtRounded": "2022-01-01T15:00:00+09:00",
      "break2StartAt": "2022-01-01T14:59:15+09:00",
      "break2StartLatitude": 34.684206,
      "break2StartLongitude": 135.507926,
      "break2StartHorizontalAccuracy": 20,
      "break2StartAddress": "大阪府大阪市中央区本町四丁目",
      "break2EndAtRounded": "2022-01-01T15:00:00+09:00",
      "break2EndAt": "2022-01-01T14:59:30+09:00",
      "break2EndLatitude": 34.684206,
      "break2EndLongitude": 135.507926,
      "break2EndHorizontalAccuracy": 20,
      "break2EndAddress": "大阪府大阪市中央区本町四丁目",
      "workingMinutes": 420,
      "overtimeMinutes": 0,
      "over45HourOvertimeMinutes": 0,
      "over60HourOvertimeMinutes": 0,
      "midnightMinutes": 0,
      "breakMinutes": 120,
      "holidayDeemedWorkingMinutes": 0,
      "tardyMinutes": 0,
      "earlyLeavingMinutes": 0,
      "holidayType": "none",
      "calculated": true
    },
    {
      "shiftDate": "2022-01-02",
      "staffId": "2",
      "staffName": "スマレジ 花子",
      "staffCode": "002",
      "staffClassificationId": "2",
      "staffClassificationName": "パート",
      "staffGroups": [
        {
          "staffGroupCode": "2",
          "staffGroupName": "グループB",
          "positionId": null,
          "positionName": null
        }
      ],
      "storeId": "3",
      "storeName": "スマレジ 東京店",
      "attendanceAtRounded": "2022-01-02T10:00:00+09:00",
      "attendanceAt": "2022-01-02T09:58:10+09:00",
      "attendanceLatitude": 35.680159,
      "attendanceLongitude": 139.761452,
      "attendanceHorizontalAccuracy": 15,
      "attendanceAddress": "東京都千代田区丸の内",
      "leavingAtRounded": "2022-01-02T16:00:00+09:00",
      "leavingAt": "2022-01-02T16:02:30+09:00",
      "leavingLatitude": 35.680159,
      "leavingLongitude": 139.761452,
      "leavingHorizontalAccuracy": 15,
      "leavingAddress": "東京都千代田区丸の内",
      "break1StartAtRounded": "2022-01-02T13:00:00+09:00",
      "break1StartAt": "2022-01-02T13:00:45+09:00",
      "break1StartLatitude": 35.680159,
      "break1StartLongitude": 139.761452,
      "break1StartHorizontalAccuracy": 15,
      "break1StartAddress": "東京都千代田区丸の内",
      "break1EndAtRounded": "2022-01-02T14:00:00+09:00",
      "break1EndAt": "2022-01-02T13:59:20+09:00",
      "break1EndLatitude": 35.680159,
      "break1EndLongitude": 139.761452,
      "break1EndHorizontalAccuracy": 15,
      "break1EndAddress": "東京都千代田区丸の内",
      "break2StartAtRounded": null,
      "break2StartAt": null,
      "break2StartLatitude": null,
      "break2StartLongitude": null,
      "break2StartHorizontalAccuracy": null,
      "break2StartAddress": null,
      "break2EndAtRounded": null,
      "break2EndAt": null,
      "break2EndLatitude": null,
      "break2EndLongitude": null,
      "break2EndHorizontalAccuracy": null,
      "break2EndAddress": null,
      "workingMinutes": 300,
      "overtimeMinutes": 0,
      "over45HourOvertimeMinutes": 0,
      "over60HourOvertimeMinutes": 0,
      "midnightMinutes": 0,
      "breakMinutes": 60,
      "holidayDeemedWorkingMinutes": 0,
      "tardyMinutes": 0,
      "earlyLeavingMinutes": 0,
      "holidayType": "prescribed",
      "calculated": true
    }
  ]
}

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": "勤務時間(下限)は0以上の整数で指定してください"
}