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

GET

/shifts_summary/{store_id}/monthly

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/shifts_summary/1/monthly?staff_id=1%2C2&division=result&year=2020&month=06&callback_url=https%3A%2F%2Fexample.com%2Fcallback';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

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

対象

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

対象ユーザー権限

シフト閲覧
実績閲覧

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

application/x-www-form-urlencoded

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=%E3%82%B9%E3%83%9E%E3%83%AC%E3%82%B8%E6%9C%AC%E7%A4%BE&storeAbbr=%E6%9C%AC%E7%A4%BE&division=result&202001=%7B%22monthlyTotalStaff%22%3A%225%22%2C%22monthlyTotalHour%22%3A800%2C%22monthlyTotalMinute%22%3A48000%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A160%2C%22workingMinute%22%3A9600%2C%22personnelExpenses%22%3A200000%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A160%2C%22workingMinute%22%3A9600%2C%22personnelExpenses%22%3A180000%7D%2C%7B%22staffId%22%3A3%2C%22workingHour%22%3A160%2C%22workingMinute%22%3A9600%2C%22personnelExpenses%22%3A160000%7D%5D%2C%22totalPersonnelExpenses%22%3A%22540000%22%7D&202002=%7B%22monthlyTotalStaff%22%3A%224%22%2C%22monthlyTotalHour%22%3A640%2C%22monthlyTotalMinute%22%3A38400%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A160%2C%22workingMinute%22%3A9600%2C%22personnelExpenses%22%3A200000%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A160%2C%22workingMinute%22%3A9600%2C%22personnelExpenses%22%3A180000%7D%5D%2C%22totalPersonnelExpenses%22%3A%22380000%22%7D

Responses

200

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

Responses

201

リクエスト成功

application/json

object

message

メッセージ

string

Example

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

400

パラメータが不正な場合

application/json

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

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