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

日報一覧取得

GET
/daily_reports/store/{store_id}
curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/daily_reports/store/1?year=2020&month=05&staff_group_code=1' \
  --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”
year
required
string
/^\d{4}$/

対象年 [YYYY]

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

対象月 [MM]

Example
05
staff_group_code
string

従業員グループコード（カンマ区切りで複数指定可）

Examples

単一指定

1

Responses

Section titled “Responses”

200

Section titled “200”

取得成功

Media typeapplication/json
object
fromDate

取得開始日 [YYYY-MM-DD]

string format: date
toDate

取得終了日 [YYYY-MM-DD]

string format: date
dailyReportList

日報一覧

object
key
additional properties

従業員別日報一覧（キー staffId: 従業員ID）

object
key
additional properties

日報データリスト（キー day: 日付 [YYYY-MM-DD]）

Array<object>
object
storeId

事業所ID

string
dailyReportId

日報ID

string
shiftResultId

シフト実績ID

string
attendance

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

string format: date-time
leaving

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

string format: date-time
Example
{
  "fromDate": "2024-05-01",
  "toDate": "2024-05-31",
  "dailyReportList": {
    "123": {
      "2024-05-01": [
        {
          "storeId": "1",
          "dailyReportId": "1001",
          "shiftResultId": "2001",
          "attendance": "2020-05-01T09:00:00+09:00",
          "leaving": "2020-05-01T18:00:00+09:00"
        },
        {
          "storeId": "1",
          "dailyReportId": "1002",
          "shiftResultId": "2002",
          "attendance": "2020-05-01T19:00:00+09:00",
          "leaving": "2020-05-01T22:00:00+09:00"
        }
      ],
      "2024-05-02": [
        {
          "storeId": "1",
          "dailyReportId": "1003",
          "shiftResultId": "2003",
          "attendance": "2020-05-02T10:00:00+09:00",
          "leaving": "2020-05-02T17:00:00+09:00"
        }
      ]
    },
    "456": {
      "2024-05-01": [
        {
          "storeId": "1",
          "dailyReportId": "1004",
          "shiftResultId": "2004",
          "attendance": "2020-05-01T08:30:00+09:00",
          "leaving": "2020-05-01T17:30:00+09:00"
        }
      ],
      "2024-05-03": [
        {
          "storeId": "1",
          "dailyReportId": "",
          "shiftResultId": "2005",
          "attendance": "2020-05-03T09:00:00+09:00",
          "leaving": "2020-05-03T18:00:00+09:00"
        }
      ]
    }
  }
}

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

404

Section titled “404”
  • 指定したIDのデータが存在しない場合
Media typeapplication/json
object
type

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

string
title

エラーの概要

string
detail

エラーの詳細

string
Example
{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "データが確認できませんでした。事業所ID: 999"
}