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

GET

/shifts_summary/{store_id}/daily

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/shifts_summary/1/daily?division=result&year=2020&month=06&date=15&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/daily?division=result&year=2020&month=06&date=15&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

division

required

string

Allowed values: schedule result

シフト/実績区分

schedule: シフト
result: 実績

Example

result

year

required

string

/^\d{4}$/

集計年 [YYYY]

Example

month

required

string

/^\d{2}$/

集計月 [MM]

Example

date

string

/^\d{2}$/

集計日 [DD]

Example

callback_url

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}$/

month

集計月 [MM]

string

/^\d{2}$/

storeId

事業所ID

string

storeName

事業所名

string

storeAbbr

事業所名略称

string

division

シフト/実績区分

schedule: シフト
result: 実績

string

Allowed values: schedule result

shiftStoreDaily

日別勤怠データ

object

key

additional properties

勤怠データ（キー day: 日付 [YYYYMMDD]）

object

dailyTotalStaff

日合計労働人数

number

dailyTotalHour

日合計労働時間（小数）

number format: double

dailyTotalMinute

日合計労働時間（分）

number

staffs

従業員データリスト

Array<object>

object

staffId

従業員ID

number

workingHour

労働時間（小数）

number format: double

workingMinute

労働時間（分）

number

personnelExpenses

給与概算

string

shifts

シフト/実績情報リスト

Array<object>

object

shiftResultId

シフト実績ID

string

staffId

従業員ID

string

staffName

従業員名

string

shiftDate

シフト/実績日

string format: date

attendance

出勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

leaving

退勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakStartTime1

休憩1 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakEndTime1

休憩1 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakStartTime2

休憩2 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakEndTime2

休憩2 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

totalPersonnelExpenses

給与概算合計

number

Example

year=2020&month=01&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&20200106=%7B%22dailyTotalStaff%22%3A3%2C%22dailyTotalHour%22%3A22.5%2C%22dailyTotalMinute%22%3A1350%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A8%2C%22workingMinute%22%3A480%2C%22personnelExpenses%22%3A%2212000%22%2C%22shifts%22%3A%5B%7B%22shiftResultId%22%3A%22101%22%2C%22staffId%22%3A%221%22%2C%22staffName%22%3A%22%E3%82%B9%E3%83%9E%E3%83%AC%E3%82%B8%E5%A4%AA%E9%83%8E%22%2C%22shiftDate%22%3A%222020-01-06%22%2C%22attendance%22%3A%222020-01-06T09%3A00%3A00%2B09%3A00%22%2C%22leaving%22%3A%222020-01-06T18%3A00%3A00%2B09%3A00%22%2C%22breakStartTime1%22%3A%222020-01-06T12%3A00%3A00%2B09%3A00%22%2C%22breakEndTime1%22%3A%222020-01-06T13%3A00%3A00%2B09%3A00%22%2C%22breakStartTime2%22%3A%22%22%2C%22breakEndTime2%22%3A%22%22%7D%5D%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A7.5%2C%22workingMinute%22%3A450%2C%22personnelExpenses%22%3A%229000%22%2C%22shifts%22%3A%5B%7B%22shiftResultId%22%3A%22102%22%2C%22staffId%22%3A%222%22%2C%22staffName%22%3A%22%E3%82%B9%E3%83%9E%E3%83%AC%E3%82%B8%E8%8A%B1%E5%AD%90%22%2C%22shiftDate%22%3A%222020-01-06%22%2C%22attendance%22%3A%222020-01-06T10%3A00%3A00%2B09%3A00%22%2C%22leaving%22%3A%222020-01-06T18%3A00%3A00%2B09%3A00%22%2C%22breakStartTime1%22%3A%222020-01-06T12%3A30%3A00%2B09%3A00%22%2C%22breakEndTime1%22%3A%222020-01-06T13%3A00%3A00%2B09%3A00%22%2C%22breakStartTime2%22%3A%22%22%2C%22breakEndTime2%22%3A%22%22%7D%5D%7D%2C%7B%22staffId%22%3A3%2C%22workingHour%22%3A7%2C%22workingMinute%22%3A420%2C%22personnelExpenses%22%3A%228400%22%2C%22shifts%22%3A%5B%7B%22shiftResultId%22%3A%22103%22%2C%22staffId%22%3A%223%22%2C%22staffName%22%3A%22%E3%82%B9%E3%83%9E%E3%83%AC%E3%82%B8%E6%AC%A1%E9%83%8E%22%2C%22shiftDate%22%3A%222020-01-06%22%2C%22attendance%22%3A%222020-01-06T11%3A00%3A00%2B09%3A00%22%2C%22leaving%22%3A%2220250-01-06T18%3A30%3A00%2B09%3A00%22%2C%22breakStartTime1%22%3A%222020-01-06T13%3A00%3A00%2B09%3A00%22%2C%22breakEndTime1%22%3A%222020-01-06T13%3A30%3A00%2B09%3A00%22%2C%22breakStartTime2%22%3A%22%22%2C%22breakEndTime2%22%3A%22%22%7D%5D%7D%5D%2C%22totalPersonnelExpenses%22%3A29400%7D&20200107=%7B%22dailyTotalStaff%22%3A2%2C%22dailyTotalHour%22%3A15%2C%22dailyTotalMinute%22%3A900%2C%22staffs%22%3A%5B%7B%22staffId%22%3A1%2C%22workingHour%22%3A8%2C%22workingMinute%22%3A480%2C%22personnelExpenses%22%3A%2212000%22%2C%22shifts%22%3A%5B%7B%22shiftResultId%22%3A%22104%22%2C%22staffId%22%3A%221%22%2C%22staffName%22%3A%22%E3%82%B9%E3%83%9E%E3%83%AC%E3%82%B8%E5%A4%AA%E9%83%8E%22%2C%22shiftDate%22%3A%222020-01-07%22%2C%22attendance%22%3A%222020-01-07T09%3A00%3A00%2B09%3A00%22%2C%22leaving%22%3A%222020-01-07T18%3A00%3A00%2B09%3A00%22%2C%22breakStartTime1%22%3A%222020-01-07T12%3A00%3A00%2B09%3A00%22%2C%22breakEndTime1%22%3A%222020-01-07T13%3A00%3A00%2B09%3A00%22%2C%22breakStartTime2%22%3A%22%22%2C%22breakEndTime2%22%3A%22%22%7D%5D%7D%2C%7B%22staffId%22%3A2%2C%22workingHour%22%3A7%2C%22workingMinute%22%3A420%2C%22personnelExpenses%22%3A%228400%22%2C%22shifts%22%3A%5B%7B%22shiftResultId%22%3A%22105%22%2C%22staffId%22%3A%222%22%2C%22staffName%22%3A%22%E3%82%B9%E3%83%9E%E3%83%AC%E3%82%B8%E8%8A%B1%E5%AD%90%22%2C%22shiftDate%22%3A%222020-01-07%22%2C%22attendance%22%3A%222020-01-07T10%3A00%3A00%2B09%3A00%22%2C%22leaving%22%3A%222020-01-07T17%3A30%3A00%2B09%3A00%22%2C%22breakStartTime1%22%3A%222020-01-07T12%3A30%3A00%2B09%3A00%22%2C%22breakEndTime1%22%3A%222020-01-07T13%3A00%3A00%2B09%3A00%22%2C%22breakStartTime2%22%3A%22%22%2C%22breakEndTime2%22%3A%22%22%7D%5D%7D%5D%2C%22totalPersonnelExpenses%22%3A20400%7D

Responses

200

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

Responses

200

取得成功（コールバックURLを指定しなかった場合）

application/json

object

year

集計年 [YYYY]

string

/^\d{4}$/

month

集計月 [MM]

string

/^\d{2}$/

storeId

事業所ID

string

storeName

事業所名

string

storeAbbr

事業所名略称

string

division

シフト/実績区分

schedule: シフト
result: 実績

string

Allowed values: schedule result

shiftStoreDaily

日別勤怠データ

object

key

additional properties

勤怠データ（キー day: 日付 [YYYYMMDD]）

object

dailyTotalStaff

日合計労働人数

number

dailyTotalHour

日合計労働時間（小数）

number format: double

dailyTotalMinute

日合計労働時間（分）

number

staffs

従業員データリスト

Array<object>

object

staffId

従業員ID

number

workingHour

労働時間（小数）

number format: double

workingMinute

労働時間（分）

number

personnelExpenses

給与概算

string

shifts

シフト/実績情報リスト

Array<object>

object

shiftResultId

シフト実績ID

string

staffId

従業員ID

string

staffName

従業員名

string

shiftDate

シフト/実績日

string format: date

attendance

出勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

leaving

退勤時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakStartTime1

休憩1 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakEndTime1

休憩1 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakStartTime2

休憩2 開始時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

breakEndTime2

休憩2 終了時刻 [YYYY-MM-DDThh:mm:ssTZD]

string format: date-time

totalPersonnelExpenses

給与概算合計

number

Example

{
  "year": "2020",
  "month": "01",
  "storeId": "1",
  "storeName": "スマレジ本社",
  "storeAbbr": "本社",
  "division": "result",
  "shiftStoreDaily": {
    "20200106": {
      "dailyTotalStaff": 3,
      "dailyTotalHour": 22.5,
      "dailyTotalMinute": 1350,
      "staffs": [
        {
          "staffId": 1,
          "workingHour": 8,
          "workingMinute": 480,
          "personnelExpenses": "12000",
          "shifts": [
            {
              "shiftResultId": "101",
              "staffId": "1",
              "staffName": "スマレジ太郎",
              "shiftDate": "2020-01-06",
              "attendance": "2020-01-06T09:00:00+09:00",
              "leaving": "2020-01-06T18:00:00+09:00",
              "breakStartTime1": "2020-01-06T12:00:00+09:00",
              "breakEndTime1": "2020-01-06T13:00:00+09:00",
              "breakStartTime2": "",
              "breakEndTime2": ""
            }
          ]
        },
        {
          "staffId": 2,
          "workingHour": 7.5,
          "workingMinute": 450,
          "personnelExpenses": "9000",
          "shifts": [
            {
              "shiftResultId": "102",
              "staffId": "2",
              "staffName": "スマレジ花子",
              "shiftDate": "2020-01-06",
              "attendance": "2020-01-06T10:00:00+09:00",
              "leaving": "2020-01-06T18:00:00+09:00",
              "breakStartTime1": "2020-01-06T12:30:00+09:00",
              "breakEndTime1": "2020-01-06T13:00:00+09:00",
              "breakStartTime2": "",
              "breakEndTime2": ""
            }
          ]
        },
        {
          "staffId": 3,
          "workingHour": 7,
          "workingMinute": 420,
          "personnelExpenses": "8400",
          "shifts": [
            {
              "shiftResultId": "103",
              "staffId": "3",
              "staffName": "スマレジ次郎",
              "shiftDate": "2020-01-06",
              "attendance": "2020-01-06T11:00:00+09:00",
              "leaving": "20250-01-06T18:30:00+09:00",
              "breakStartTime1": "2020-01-06T13:00:00+09:00",
              "breakEndTime1": "2020-01-06T13:30:00+09:00",
              "breakStartTime2": "",
              "breakEndTime2": ""
            }
          ]
        }
      ],
      "totalPersonnelExpenses": 29400
    },
    "20200107": {
      "dailyTotalStaff": 2,
      "dailyTotalHour": 15,
      "dailyTotalMinute": 900,
      "staffs": [
        {
          "staffId": 1,
          "workingHour": 8,
          "workingMinute": 480,
          "personnelExpenses": "12000",
          "shifts": [
            {
              "shiftResultId": "104",
              "staffId": "1",
              "staffName": "スマレジ太郎",
              "shiftDate": "2020-01-07",
              "attendance": "2020-01-07T09:00:00+09:00",
              "leaving": "2020-01-07T18:00:00+09:00",
              "breakStartTime1": "2020-01-07T12:00:00+09:00",
              "breakEndTime1": "2020-01-07T13:00:00+09:00",
              "breakStartTime2": "",
              "breakEndTime2": ""
            }
          ]
        },
        {
          "staffId": 2,
          "workingHour": 7,
          "workingMinute": 420,
          "personnelExpenses": "8400",
          "shifts": [
            {
              "shiftResultId": "105",
              "staffId": "2",
              "staffName": "スマレジ花子",
              "shiftDate": "2020-01-07",
              "attendance": "2020-01-07T10:00:00+09:00",
              "leaving": "2020-01-07T17:30:00+09:00",
              "breakStartTime1": "2020-01-07T12:30:00+09:00",
              "breakEndTime1": "2020-01-07T13:00:00+09:00",
              "breakStartTime2": "",
              "breakEndTime2": ""
            }
          ]
        }
      ],
      "totalPersonnelExpenses": 20400
    }
  }
}

201

成功（コールバックURLを指定した場合）

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": "月は2桁で入力してください。"
}