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

GET

/shifts_summary/{store_id}/monthly

サンドボックス
本番

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

対象

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

対象ユーザー権限

シフト閲覧
実績閲覧

Authorizations

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

Parameters

Path Parameters

store_id

required

string

事業所ID

Example

Query Parameters

staff_id

string

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

Example

1,2

division

required

string

Allowed values: schedule result

シフト/実績区分

schedule: シフト
result: 実績

Example

result

year

required

string

/^\d{4}$/

集計年 [YYYY]

Example

month

string

/^\d{2}$/

集計月 [MM]

Example

callback_url

required

string format: uri

コールバックURL

Example

https://example.com/callback

Callbacks

`onDataReceived`

POST

{$request.query.callback_url}

Request Body

object

year

集計年 [YYYY]

string

/^\d{4}$/

storeId

事業所ID

string

storeName

事業所名

string

storeAbbr

事業所名略称

string

division

シフト/実績区分

schedule: シフト
result: 実績

string

Allowed values: schedule result

shiftStoreMonthly

月別勤怠データリスト

object

key

additional properties

勤怠データ（キー month: 月 [YYYYMM]）

object

monthlyTotalStaff

月合計労働人数

string

monthlyTotalHour

月合計労働時間（小数）

number format: double

monthlyTotalMinute

月合計労働時間（分）

number

staffs

従業員データリスト

Array<object>

object

staffId

従業員ID

number

workingHour

労働時間（小数）

number format: double

workingMinute

労働時間（分）

number

personnelExpenses

給与概算

number

totalPersonnelExpenses

給与概算合計

string

/^[1-9]\d*$/

Example

{
  "year": "2020",
  "storeId": "1",
  "storeName": "スマレジ本社",
  "storeAbbr": "本社",
  "division": "result",
  "shiftStoreMonthly": {
    "202001": {
      "monthlyTotalStaff": "5",
      "monthlyTotalHour": 800,
      "monthlyTotalMinute": 48000,
      "staffs": [
        {
          "staffId": 1,
          "workingHour": 160,
          "workingMinute": 9600,
          "personnelExpenses": 200000
        },
        {
          "staffId": 2,
          "workingHour": 160,
          "workingMinute": 9600,
          "personnelExpenses": 180000
        },
        {
          "staffId": 3,
          "workingHour": 160,
          "workingMinute": 9600,
          "personnelExpenses": 160000
        }
      ],
      "totalPersonnelExpenses": "540000"
    },
    "202002": {
      "monthlyTotalStaff": "4",
      "monthlyTotalHour": 640,
      "monthlyTotalMinute": 38400,
      "staffs": [
        {
          "staffId": 1,
          "workingHour": 160,
          "workingMinute": 9600,
          "personnelExpenses": 200000
        },
        {
          "staffId": 2,
          "workingHour": 160,
          "workingMinute": 9600,
          "personnelExpenses": 180000
        }
      ],
      "totalPersonnelExpenses": "380000"
    }
  }
}

Responses

200

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

Responses

201

リクエスト成功

object

message

メッセージ

string

Example

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

400

パラメータが不正な場合

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "区分が正しくありません。区分：xxxxx"
}