コンテンツにスキップ
スマレジ・プラットフォームAPI リファレンス

時間別勤怠（事業所別合計）取得

GET
/shifts_summary/{store_id}/hourly
curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/shifts_summary/1/hourly?division=result&year=2020&month=06&day=15&callback_url=https%3A%2F%2Fexample.com%2Fcallback' \
  --header 'Authorization: Bearer <token>'

時間別勤怠（事業所別合計）を取得します

対象

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

対象ユーザー権限

  • シフト閲覧
  • 実績閲覧

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
store_id
required
string

事業所ID

Example
1

Query Parameters

Section titled “Query Parameters”
division
required
string
Allowed values: schedule result

シフト/実績区分

  • schedule: シフト
  • result: 実績
Example
result
year
required
string
/^\d{4}$/

集計年 [YYYY]

Example
2020
month
required
string
/^\d{2}$/

集計月 [MM]

Example
06
day
required
string
/^\d{2}$/

集計日 [DD]

Example
15
callback_url
required
string format: uri

コールバックURL

Example
https://example.com/callback

Callbacks

Section titled “Callbacks”

onDataReceived

Section titled “onDataReceived”
POST
{$request.query.callback_url}

Request Body

Section titled “Request Body”
Media typeapplication/x-www-form-urlencoded
object
year

集計年 [YYYY]

string
/^\d{4}$/
month

集計月 [MM]

string
/^\d{2}$/
day

集計日 [DD]

string
/^\d{2}$/
storeId

事業所ID

string
storeName

事業所名

string
storeAbbr

事業所名略称

string
division

シフト/実績区分

  • schedule: シフト
  • result: 実績
string
Allowed values: schedule result
shiftStoreHourly

時間別勤怠データリスト

Array<object>
object
hour

時間帯

number
hourlyTotalHour

時間別合計労働時間（小数）

number format: double
hourlyTotalMinute

時間別合計労働時間（分）

number
hourlyTotalStaff

時間別合計労働人数

number
staffs

従業員データリスト

Array<object>
object
staffId

従業員ID

number
workingHour

労働時間（小数）

number format: double
workingMinute

労働時間（分）

number
personnelExpenses

給与概算（時給従業員のみ対象となります）

number
totalPersonnelExpenses

給与概算合計（時給従業員のみ対象となります）

number
Example
year=2020&month=01&day=01&storeId=1&storeName=%E3%82%B9%E3%83%9E%E3%83%AC%E3%82%B8%E4%BA%8B%E6%A5%AD%E6%89%80&storeAbbr=%E3%82%B9%E3%83%9E%E3%83%AC%E3%82%B8&division=schedule&shiftStoreHourly=%7B%22hour%22%3A0%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A1%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A2%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A3%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A4%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A5%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A6%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A7%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A8%2C%22hourlyTotalHour%22%3A0.5%2C%22hourlyTotalMinute%22%3A30%2C%22hourlyTotalStaff%22%3A1%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A0.5%2C%22workingMinute%22%3A30%2C%22personnelExpenses%22%3A500.5%7D%5D%2C%22totalPersonnelExpenses%22%3A500.5%7D&shiftStoreHourly=%7B%22hour%22%3A9%2C%22hourlyTotalHour%22%3A3.75861111111111%2C%22hourlyTotalMinute%22%3A225.51666666666668%2C%22hourlyTotalStaff%22%3A2%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A1.25861111111111%2C%22workingMinute%22%3A75.51666666666668%2C%22personnelExpenses%22%3A1258.611111111111%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A2.5%2C%22workingMinute%22%3A150%2C%22personnelExpenses%22%3A2500%7D%5D%2C%22totalPersonnelExpenses%22%3A3758.6111111111113%7D&shiftStoreHourly=%7B%22hour%22%3A10%2C%22hourlyTotalHour%22%3A5.25%2C%22hourlyTotalMinute%22%3A315%2C%22hourlyTotalStaff%22%3A3%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1000%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A1.25%2C%22workingMinute%22%3A75%2C%22personnelExpenses%22%3A1250.75%7D%2C%7B%22staffId%22%3A3%2C%22workingHour%22%3A3%2C%22workingMinute%22%3A180%2C%22personnelExpenses%22%3A2700%7D%5D%2C%22totalPersonnelExpenses%22%3A4950.75%7D&shiftStoreHourly=%7B%22hour%22%3A11%2C%22hourlyTotalHour%22%3A4%2C%22hourlyTotalMinute%22%3A240%2C%22hourlyTotalStaff%22%3A3%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1000%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1200%7D%2C%7B%22staffId%22%3A3%2C%22workingHour%22%3A2%2C%22workingMinute%22%3A120%2C%22personnelExpenses%22%3A1800%7D%5D%2C%22totalPersonnelExpenses%22%3A4000%7D&shiftStoreHourly=%7B%22hour%22%3A12%2C%22hourlyTotalHour%22%3A2.5%2C%22hourlyTotalMinute%22%3A150%2C%22hourlyTotalStaff%22%3A2%2C%22staffs%22%3A%5B%7B%22staffId%22%3A2%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1200%7D%2C%7B%22staffId%22%3A3%2C%22workingHour%22%3A1.5%2C%22workingMinute%22%3A90%2C%22personnelExpenses%22%3A900.5%7D%5D%2C%22totalPersonnelExpenses%22%3A2100.5%7D&shiftStoreHourly=%7B%22hour%22%3A13%2C%22hourlyTotalHour%22%3A3%2C%22hourlyTotalMinute%22%3A180%2C%22hourlyTotalStaff%22%3A3%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1000%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1200%7D%2C%7B%22staffId%22%3A3%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A900%7D%5D%2C%22totalPersonnelExpenses%22%3A3100%7D&shiftStoreHourly=%7B%22hour%22%3A14%2C%22hourlyTotalHour%22%3A3.83333333333333%2C%22hourlyTotalMinute%22%3A230.00000000000003%2C%22hourlyTotalStaff%22%3A3%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1000%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1200%7D%2C%7B%22staffId%22%3A3%2C%22workingHour%22%3A1.83333333333333%2C%22workingMinute%22%3A110.00000000000001%2C%22personnelExpenses%22%3A1650%7D%5D%2C%22totalPersonnelExpenses%22%3A3850%7D&shiftStoreHourly=%7B%22hour%22%3A15%2C%22hourlyTotalHour%22%3A2%2C%22hourlyTotalMinute%22%3A120%2C%22hourlyTotalStaff%22%3A2%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1000%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1200%7D%5D%2C%22totalPersonnelExpenses%22%3A2200%7D&shiftStoreHourly=%7B%22hour%22%3A16%2C%22hourlyTotalHour%22%3A2%2C%22hourlyTotalMinute%22%3A120%2C%22hourlyTotalStaff%22%3A2%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1000%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1200%7D%5D%2C%22totalPersonnelExpenses%22%3A2200%7D&shiftStoreHourly=%7B%22hour%22%3A17%2C%22hourlyTotalHour%22%3A1%2C%22hourlyTotalMinute%22%3A60%2C%22hourlyTotalStaff%22%3A1%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A1%2C%22workingMinute%22%3A60%2C%22personnelExpenses%22%3A1000%7D%5D%2C%22totalPersonnelExpenses%22%3A1000%7D&shiftStoreHourly=%7B%22hour%22%3A18%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A19%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A20%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A21%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A22%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D&shiftStoreHourly=%7B%22hour%22%3A23%2C%22hourlyTotalHour%22%3A0%2C%22hourlyTotalMinute%22%3A0%2C%22hourlyTotalStaff%22%3A0%2C%22totalPersonnelExpenses%22%3A0%7D

Responses

Section titled “Responses”
200
Section titled “200”

コールバックに成功した場合

Responses

Section titled “Responses”

201

Section titled “201”

リクエスト成功

Media typeapplication/json
object
message

メッセージ

string
Example
{
  "message": "実行中です"
}

400

Section titled “400”

パラメータが不正な場合

Media typeapplication/json
object
type

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

string
title

エラーの概要

string
detail

エラーの詳細

string
Example
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "日は2桁で入力してください。"
}