概要

API Endpoint
https://api.kingtime.jp/v1.0

このドキュメントではKING OF TIME WebAPIの仕様について説明します。

リクエスト

APIとの全ての通信にはHTTPSプロトコルを利用します。アクセス先のホストには、api.kingtime.jpを利用します。

データ形式

APIとのデータの送受信にはJSONを利用します。

Content-Type:application/json; charset=utf-8

日時表現

日時を表現する場合には、ISO 8601形式の下記文字列を利用します。ただし、時(HH)は 00 から 23 とします。（APIは日本国内での利用のみを想定しています。海外の従業員もご利用の場合はご相談下さい。）

打刻時刻の書式

2016-05-10T10:00:00+09:00

打刻時刻以外の書式

2016-05-10T10:00+09:00

エラーレスポンス

エラーが発生した場合、エラーを表現するオブジェクトを含んだエラーレスポンスが返却されます。

{
    "errors": [
        {
            "message": "Bad Authentication.",
            "code": 111
        },
        {
            "message": "Id is empty.",
            "code": 222
        }
    ]
}

エラーレスポンスについて以下の構造で返却される場合もあります。

{"code":"303", "message": "Too Many Requests"}

追加用のプロパティ

レスポンス定義のadditionalFieldsには追加用のプロパティが定義されています。 定義されたプロパティの名前をadditionalFieldsに指定することで、レスポンスに追加することができます。 定義されている追加用のプロパティがオブジェクトや配列の場合、その配下のプロパティは指定できません。 オブジェクトや配列の名前を指定してください。

/employees?additionalFields=lastNamePhonetics,firstNamePhonetics,hiredDate,birthDate,resignationDate

nullのプロパティ

プロパティの値がnullの場合は、レスポンスに含まれません。

Optionalのプロパティ

リクエスト定義でoptionalのマークが付いているプロパティは省略可能です。 記述の無い場合は、妥当な値を推定いたします。

アクセストークン

KING OF TIMEのAPIを利用するには、アクセストークンをリクエストに含める必要があります。アクセストークンは、以下のようにAuthorizationリクエストヘッダに含めてください。 アクセストークンの発行をご希望の場合、各サポートセンターへお問い合わせください。

Authorization: Bearer 8j9f7v4893y58rvt7nyfq2893n75tr78937n83

利用禁止時間帯

以下の時間帯（JST）はアクセストークン、打刻登録以外のAPIの利用ができません。

  • 8:30～10:00

  • 17:30～18:30

WebAPIのお問い合わせについて

WebAPIの動作に関するお問合せは受け付けしておりません。
リクエストに必要な情報や、ご利用可能な項目については各エンドポイントをご参照ください。

連携希望項目とエンドポイントの対応

連携希望項目とエンドポイントの対応を以下に示します。

連携希望項目 HTTPメソッド エンドポイント
従業員データ（読み取り） GET 従業員データ
所属データ
雇用区分データ
従業員グループデータ
従業員データ（書き込み） POST/PUT/DELETE 従業員データ
日別勤怠データ（読み取り） GET 日別勤怠データ
日別打刻データ
日別費用データ
日別勤怠データ（書き込み） POST 日別打刻データ
月別勤怠データ（読み取り） GET 月別勤怠データ
月別費用データ
月別残休暇データ
月別勤怠データ（書き込み） - -
年別勤怠データ（読み取り） GET 年別休暇データ
日別スケジュールデータ（読み取り） GET 日別スケジュールデータ
日別スケジュール費用データ
休暇区分データ
日別スケジュールデータ（書き込み） PUT/DELETE 日別スケジュールデータ
月別スケジュールデータ（読み取り） GET 月別スケジュール費用データ
月別スケジュールデータ（書き込み） - -
管理者データ（読み取り） GET 管理者データ
企業データ（読み取り） GET 企業情報データ
申請データ（読み取り） GET 時間外勤務申請データ
スケジュール申請データ
打刻申請データ
残業上限申請データ
申請データ（書き込み） PUT 申請データ

緯度、経度の形式

緯度、経度はDEG形式(10進表記)です。緯度の範囲は -90°～ 0 ～ +90° 、経度の範囲は -180°～ 0 ～ +180° となっており、登録時にその範囲外の数値が指定された場合はエラーとなります。

改訂履歴

トークン

アクセストークンの再発行、利用停止を管理する。

アクセストークン

POST https://api.kingtime.jp/v1.0/tokens/XXXXXXXXXXXXXXXXXX
Responses201
Headers
Content-Type: application/json; charset=utf-8
Body
{
  "token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

再発行
POST/tokens/{token}

指定されたアクセストークンを利用停止し、新たに同じ設定でアクセストークンを発行する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
tokenstring○

処理対象のトークン

XXXXXXXXXXXXXXXXXX
DELETE https://api.kingtime.jp/v1.0/tokens/XXXXXXXXXXXXXXXXXX
Responses204
This response has no content.

利用停止
DELETE/tokens/{token}

指定されたアクセストークンを利用停止する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
tokenstring○

処理対象のトークン

XXXXXXXXXXXXXXXXXX
GET https://api.kingtime.jp/v1.0/tokens/XXXXXXXXXXXXXXXXXX/available
Responses200
Body
{
  "available": true
}

有効確認
GET/tokens/{token}/available

指定されたアクセストークンが有効か確認する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
tokenstring○

処理対象のトークン

XXXXXXXXXXXXXXXXXX

企業情報

企業情報データ

企業情報のデータを取得する。

レスポンス定義

  • key: 企業識別キー

  • code： 企業コード

  • name： 企業名

  • host： ホスト名

  • businessYearStartDate: 事業年度開始日

  • settings： 企業設定情報

    • timeDisplayFormat： 表示形式（decimal： 10進法　sexagesimal： 60進法）
    • decimalTreatType： 10進表示の小数第3位の扱い（roundDown： 切下げ　roundUp： 切上げ　round： 四捨五入）
    • halfDayWorkingCount: 半休取得時の出勤日数の計上方法 (oneDay： 1日として計上する　halfDay： 0.5日として計上する)
GET https://api.kingtime.jp/v1.0/company
Responses200
Headers
Content-Type: application/json
Body
{
  "key": "1qazxsw23edc....",
  "code": "cmp",
  "name": "企業名",
  "host": "s2.kingtime.jp",
  "businessYearStartDate": "04/01",
  "settings": {
    "timeDisplayFormat": "decimal",
    "decimalTreatType": "roundUp",
    "halfDayWorkingCount": "oneDay"
  }
}

一覧
GET/company

企業情報データを取得する。

管理者

管理者データ

管理者のデータを取得する。

レスポンス定義

  • code： 管理者コード

  • key： 管理者識別キー（管理者コードが変更されても不変）

  • name： 管理者名

additionalFields

  • emailAddresses： メールアドレス

  • associatedEmployees： 割当従業員

    • code： 従業員コード
    • key： 従業員識別キー（従業員コードが変更されても不変）
    • lastName： 姓
    • firstName： 名
GET https://api.kingtime.jp/v1.0/administrators?additionalFields=associatedEmployees
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "code": "admin",
    "key": "4888a97dd7bbc6a26a18743f4697a1de4b38b6ee646a9620b286499c3df6918c",
    "name": "全権管理者"
  },
  {
    "code": "2000",
    "key": "6713cd21ca98689efec9fe27352152c4c77a34b32f5de30b6335d141ad714baf",
    "name": "エリアマネージャー",
    "associatedEmployees": [
      {
        "code": "1000",
        "key": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
        "lastName": "勤怠",
        "firstName": "太郎"
      },
      {
        "code": "2000",
        "key": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe27352152c4",
        "lastName": "勤怠",
        "firstName": "花子"
      }
    ]
  }
]

一覧
GET/administrators{?additionalFields}

管理者データの一覧を取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
additionalFieldsstring

指定されたプロパティをレスポンスに追加

associatedEmployees

従業員

従業員データ

従業員のデータを取得する。

リクエスト定義

  • divisionCode：required 所属コード

  • gender:required 性別（male： 男性　female： 女性）

  • typeCode：required 雇用区分コード

  • code：required 従業員コード

  • lastName：required 姓

  • firstName：required 名

  • lastNamePhonetics： 姓（カナ）

  • firstNamePhonetics： 名（カナ）

  • hiredDate： 入社年月日

  • birthDate： 生年月日

  • resignationDate： 退職年月日

  • emailAddresses： メールアドレス

  • allDayRegardingWorkInMinute: 日の契約労働時間

レスポンス定義

  • divisionCode： 所属コード

  • divisionName： 所属名

  • gender: 性別（male： 男性　female： 女性）

  • typeCode： 雇用区分コード

  • typeName： 雇用区分名

  • code： 従業員コード

  • key： 従業員識別キー（従業員コードが変更されても不変）

  • lastName： 姓

  • firstName： 名

  • employeeGroups： 従業員グループ情報

    • code： 従業員グループコード
    • name： 従業員グループ名

additionalFields

  • lastNamePhonetics： 姓（カナ）

  • firstNamePhonetics： 名（カナ）

  • hiredDate： 入社年月日

  • birthDate： 生年月日

  • resignationDate： 退職年月日

  • emailAddresses： メールアドレス

  • allDayRegardingWorkInMinute: 日の契約労働時間

GET https://api.kingtime.jp/v1.0/employees?date=2016-10-10&division=1000&includeResigner=true&additionalFields=emailAddresses
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "divisionCode": "1000",
    "divisionName": "本社",
    "gender": "male",
    "typeCode": "1",
    "typeName": "正社員",
    "code": "1000",
    "lastName": "勤怠",
    "firstName": "太郎",
    "key": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
    "emailAddresses": [
      "kintaitarou@h-t.co.jp"
    ],
    "employeeGroups": [
      {
        "code": "0001",
        "name": "人事部"
      },
      {
        "code": "0002",
        "name": "総務部"
      }
    ]
  },
  {
    "divisionCode": "1000",
    "divisionName": "本社",
    "gender": "female",
    "typeCode": "1",
    "typeName": "正社員",
    "code": "2000",
    "lastName": "勤怠",
    "firstName": "花子",
    "key": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe27352152c4",
    "emailAddresses": [
      "kintaihanako@h-t.co.jp"
    ],
    "employeeGroups": [
      {
        "code": "0003",
        "name": "営業部"
      }
    ]
  }
]

一覧
GET/employees{?date,division,includeResigner,additionalFields}

従業員データの一覧を取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring{当日}

指定された年月日時点での従業員のデータを表示
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-10-10
divisionstring

所属コード

1000
includeResignerbooleanfalse

指定された年月日時点で退職済みの従業員を含む場合 True

true
additionalFieldsstring

指定されたプロパティをレスポンスに追加

emailAddresses
GET https://api.kingtime.jp/v1.0/employees/1000?date=2016-10-10&includeResigner=true&additionalFields=emailAddresses
Responses200
Headers
Content-Type: application/json
Body
{
  "divisionCode": "1000",
  "divisionName": "本社",
  "gender": "male",
  "typeCode": "1",
  "typeName": "正社員",
  "code": "1000",
  "lastName": "勤怠",
  "firstName": "太郎",
  "key": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
  "emailAddresses": [
    "kintaitarou@h-t.co.jp"
  ],
  "employeeGroups": [
    {
      "code": "0001",
      "name": "人事部"
    },
    {
      "code": "0002",
      "name": "総務部"
    }
  ]
}

従業員指定
GET/employees/{employeeCode}{?date,includeResigner,additionalFields}

指定した従業員のデータを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeCodestring○

詳細を取得したい従業員コード

1000
datestring{当日}

指定された年月日時点での従業員のデータを表示
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-10-10
includeResignerbooleanfalse

指定された年月日時点で退職済みの従業員を含む場合 True

true
additionalFieldsstring

指定されたプロパティをレスポンスに追加

emailAddresses
POST https://api.kingtime.jp/v1.0/employees
Requestsexample 1
Headers
Content-Type: application/json
Body
{
  "divisionCode": "1000",
  "gender": "male",
  "typeCode": "1",
  "code": "1000",
  "lastName": "勤怠",
  "firstName": "太郎",
  "emailAddresses": [
    "kintaitarou@h-t.co.jp"
  ]
}
Responses201
Headers
Content-Type: application/json
Body
{
  "divisionCode": "1000",
  "gender": "male",
  "typeCode": "1",
  "code": "1000",
  "lastName": "勤怠",
  "firstName": "太郎",
  "key": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe27352152c4",
  "emailAddresses": [
    "kintaitarou@h-t.co.jp"
  ]
}

登録
POST/employees

従業員のデータを登録する。(1件)

PUT https://api.kingtime.jp/v1.0/employees/8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3?updateDate=2016-05-01
Requestsexample 1
Headers
Content-Type: application/json
Body
{
  "divisionCode": "1000",
  "gender": "male",
  "typeCode": "1",
  "code": "1000",
  "lastName": "勤怠",
  "firstName": "太郎",
  "emailAddresses": [
    "kintaitarou@h-t.co.jp"
  ]
}
Responses200
Headers
Content-Type: application/json
Body
{
  "divisionCode": "1000",
  "divisionName": "本社",
  "gender": "male",
  "typeCode": "1",
  "typeName": "正社員",
  "code": "1000",
  "lastName": "勤怠",
  "firstName": "太郎",
  "key": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe27352152c4",
  "lastNamePhonetics": "キンタイ",
  "firstNamePhonetics": "タロウ",
  "birthDate": "1990-09-01",
  "hiredDate": "2013-04-01",
  "resignationDate": "2017-12-12",
  "emailAddresses": [
    "kintaitarou@h-t.co.jp"
  ],
  "allDayRegardingWorkInMinute": 480
}

更新
PUT/employees/{employeeKey}{?updateDate}

従業員のデータを更新する。(1件)

Request Bodyにて指定された項目のみ更新する。

項目が指定され、値が無いまたは空文字列の場合は、該当項目をNULLで更新する。

レスポンスには、AdditionalFieldを含むすべての従業員データを含める。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeKeystring○

従業員識別キー（従業員コードが変更されても不変）

8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3
updateDatestring{当日}

所属、雇用区分を更新したい年月日

2016-05-01
DELETE https://api.kingtime.jp/v1.0/employees/8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3
Responses204
This response has no content.

削除
DELETE/employees/{employeeKey}

従業員のデータを削除する。(1件)

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeKeystring○

従業員識別キー（従業員コードが変更されても不変）

8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3

所属データ

所属のデータを取得する。

レスポンス定義

  • code： 所属コード

  • name： 所属名

  • dayBorderTime: 日付変更時間

GET https://api.kingtime.jp/v1.0/divisions
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "code": "1000",
    "name": "本社",
    "dayBorderTime": "00:00"
  },
  {
    "code": "2000",
    "name": "支社",
    "dayBorderTime": "05:00"
  }
]

一覧
GET/divisions

所属データの一覧を取得する。

雇用区分データ

雇用区分のデータを取得する。

レスポンス定義

  • code： 雇用区分コード

  • name： 雇用区分名

GET https://api.kingtime.jp/v1.0/working-types
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "code": "1",
    "name": "正社員"
  }
]

一覧
GET/working-types

雇用区分データの一覧を取得する。

従業員グループデータ

従業員グループのデータを取得する。

レスポンス定義

  • code： 従業員グループコード

  • name： 従業員グループ名

additionalFields

  • category： 従業員グループカテゴリ
    • code： 従業員グループカテゴリコード
    • name： 従業員グループカテゴリ名
GET https://api.kingtime.jp/v1.0/employee-groups?additionalFields=category
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "code": "0001",
    "name": "人事部",
    "category": {
      "code": "KEIKAN",
      "name": "経営管理本部"
    }
  }
]

一覧
GET/employee-groups{?additionalFields}

従業員グループのデータを取得する。

※対象企業が従業員グループ機能を利用できない場合にはデータを取得できません。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
additionalFieldsstring

指定されたプロパティをレスポンスに追加

category

勤怠

日別勤怠データ

日別勤務データを取得する。

レスポンス定義

  • date： 日時

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • workPlaceDivisionCode： 出勤先所属コード

  • workPlaceDivisionName： 出勤先所属名

  • isClosing： 締め状況

  • isHelp： ヘルプ勤務状況

  • isError： エラー勤務状況

  • workdayTypeName： 勤務日種別名

  • assigned： 所定時間（分）

  • unassigned： 所定外時間（分）

  • overtime： 残業時間（分）

  • lateNight： 深夜時間（分）

  • lateNightUnassigned： 深夜所定外時間（分）

  • lateNightOvertime： 深夜残業時間（分）

  • breakTime： 休憩時間（分）

  • late： 遅刻時間（分）

  • earlyLeave： 早退時間（分）

  • totalWork： 労働合計時間（分）

  • holidaysObtained： 休暇取得

    • fulltimeHoliday
      • code： 休暇区分コード
      • name： 休暇区分名
    • halfdayHolidays
      • typeName： 半休種別名
      • code： 休暇区分コード
      • name： 休暇区分名
    • hourHolidays
      • start： 休暇開始時間
      • end： 休暇終了時間
      • minutes： 休暇取得時間
      • code： 休暇区分コード
      • name： 休暇区分名

  • autoBreakOff： 自動休憩無効（null： 休憩を無効化しない 1：　雇用区分休憩無効　2： スケジュール休憩無効　3： 全ての自動休憩無効）

  • discretionaryVacation： 休暇みなし勤務時間（分）

  • customDailyWorkings： 日別カスタム勤怠項目

    • code： 日別カスタム表示コード
    • name： 日別カスタム表示名
    • calculationUnitCode： 計算単位コード（1： 日数　2： 時間　4： 数値）
    • calculationResult： 計算結果(※1)

※1 レスポンス例は整数表記ですが、実際のレスポンスは小数第一位まで表示されます。

additionalFields

  • currentDateEmployee 今日時点の従業員データ
    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
GET https://api.kingtime.jp/v1.0/daily-workings?division=1000&ondivision=true&start=2016-05-01&end=2016-05-10&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "date": "2016-05-01",
    "dailyWorkings": [
      {
        "date": "2016-05-01",
        "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
        "currentDateEmployee": {
          "divisionCode": "1000",
          "divisionName": "本社",
          "gender": "male",
          "typeCode": "1",
          "typeName": "正社員",
          "code": "1000",
          "lastName": "勤怠",
          "firstName": "太郎",
          "lastNamePhonetics": "キンタイ",
          "firstNamePhonetics": "タロウ",
          "employeeGroups": [
            {
              "code": "0001",
              "name": "人事部"
            },
            {
              "code": "0002",
              "name": "総務部"
            }
          ]
        },
        "workPlaceDivisionCode": "1000",
        "workPlaceDivisionName": "本社",
        "isClosing": true,
        "isHelp": false,
        "isError": false,
        "workdayTypeName": "平日",
        "assigned": 480,
        "unassigned": 135,
        "overtime": 135,
        "lateNight": 0,
        "lateNightUnassigned": 0,
        "lateNightOvertime": 0,
        "breakTime": 60,
        "late": 0,
        "earlyLeave": 0,
        "totalWork": 615,
        "holidaysObtained": {
          "fulltimeHoliday": {
            "code": 1,
            "name": "有休"
          },
          "halfdayHolidays": [
            {
              "typeName": "PM休",
              "code": 1,
              "name": "有休"
            }
          ],
          "hourHolidays": [
            {
              "start": "2016-05-01T10:00:00+09:00",
              "end": "2016-05-01T11:00:00+09:00",
              "minutes": 60,
              "code": 1,
              "name": "有休"
            }
          ]
        },
        "autoBreakOff": 1,
        "discretionaryVacation": 0,
        "customDailyWorkings": [
          {
            "code": "dCus1",
            "name": "日別カスタム1",
            "calculationUnitCode": 1,
            "calculationResult": 1
          },
          {
            "code": "dCus2",
            "name": "日別カスタム2",
            "calculationUnitCode": 2,
            "calculationResult": 10
          },
          {
            "code": "dCus3",
            "name": "日別カスタム3",
            "calculationUnitCode": 4,
            "calculationResult": 100
          }
        ]
      }
    ]
  }
]

一覧
GET/daily-workings{?division,ondivision,start,end,additionalFields}

日別勤務データの一覧を取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
divisionstring

所属コード

1000
ondivisionbooleantrue

・true:所属に基づいた勤務データ
・false:出勤先に基づいた勤務データ
・divisionが指定されている場合のみ使用可能

true
startstring{当日}

取得したい期間の開始年月日
・過去日は最大3年前まで

2016-05-01
endstring{当日}

取得したい期間の終了年月日
・startとendは同時に指定
・期間は最大62日
・未来日は最大1年後まで

2016-05-10
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee
GET https://api.kingtime.jp/v1.0/daily-workings/2016-05-01?division=1000&ondivision=true&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "dailyWorkings": [
    {
      "date": "2016-05-01",
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "currentDateEmployee": {
        "divisionCode": "1000",
        "divisionName": "本社",
        "gender": "male",
        "typeCode": "1",
        "typeName": "正社員",
        "code": "1000",
        "lastName": "勤怠",
        "firstName": "太郎",
        "lastNamePhonetics": "キンタイ",
        "firstNamePhonetics": "タロウ",
        "employeeGroups": [
          {
            "code": "0001",
            "name": "人事部"
          },
          {
            "code": "0002",
            "name": "総務部"
          }
        ]
      },
      "workPlaceDivisionCode": "1000",
      "workPlaceDivisionName": "本社",
      "isClosing": true,
      "isHelp": false,
      "isError": false,
      "workdayTypeName": "平日",
      "assigned": 480,
      "unassigned": 135,
      "overtime": 135,
      "lateNight": 0,
      "lateNightUnassigned": 0,
      "lateNightOvertime": 0,
      "breakTime": 60,
      "late": 0,
      "earlyLeave": 0,
      "totalWork": 615,
      "holidaysObtained": {
        "fulltimeHoliday": {
          "code": 1,
          "name": "有休"
        },
        "halfdayHolidays": [
          {
            "typeName": "PM休",
            "code": 1,
            "name": "有休"
          }
        ],
        "hourHolidays": [
          {
            "start": "2016-05-01T10:00:00+09:00",
            "end": "2016-05-01T11:00:00+09:00",
            "minutes": 60,
            "code": 1,
            "name": "有休"
          }
        ]
      },
      "autoBreakOff": 1,
      "discretionaryVacation": 0,
      "customDailyWorkings": [
        {
          "code": "dCus1",
          "name": "日別カスタム1",
          "calculationUnitCode": 1,
          "calculationResult": 1
        },
        {
          "code": "dCus2",
          "name": "日別カスタム2",
          "calculationUnitCode": 2,
          "calculationResult": 10
        },
        {
          "code": "dCus3",
          "name": "日別カスタム3",
          "calculationUnitCode": 4,
          "calculationResult": 100
        }
      ]
    }
  ]
}

年月日指定
GET/daily-workings/{date}{?division,ondivision,additionalFields}

指定した年月日の日別勤務データを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring○

詳細を取得したい年月日
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-05-01
divisionstring

詳細を取得したい所属コード

1000
ondivisionbooleantrue

・true:所属に基づいた勤務データ
・false:出勤先に基づいた勤務データ
・divisionが指定されている場合のみ使用可能

true
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

日別打刻データ

日別打刻データを登録・取得する。

リクエスト定義

  • time：required 打刻時間

  • isOmittedWorkingDay： 勤務日省略フラグ（true： 勤務日省略可能　 false： 勤務日省略不可）

    • trueの場合、勤務日の省略を可能としますが、打刻種別コードは必須とします。
    • falseおよび省略した場合、打刻種別コードの省略を可能とします。

  • code： 打刻種別コード（1： 出勤　2： 退勤　3： 休憩開始　4： 休憩終了　7： 外出入　8： 外出戻）

    • 省略時は、KING OF TIMEの処理に従って打刻種別を決定します。
    • 勤務日省略フラグがtrueの場合、必須項目です。

  • divisionCode： 打刻先所属コード

    • 省略時は、該当従業員が所属している所属を打刻先所属として扱います。

  • date： 勤務日

    • 勤務日を指定した場合は、指定された勤務日に打刻データが紐づきます。
    • 勤務日省略フラグがfalseおよび省略した場合、必須項目です。
    • 省略時は、KING OF TIMEの処理に従って打刻データが勤務日に紐づきます。

  • latitude： 緯度

  • longitude： 経度

※こちらで登録可能な打刻日時は、勤務日の翌日23時59分59秒までとなります。
　勤務日省略時は、出勤打刻登録日の翌日23時59分59秒までとなります。

レスポンス定義

  • date： 日時

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • timeRecord： 打刻

    • time： 打刻時間
    • code： 打刻種別コード
    • name： 打刻種別名
    • divisionCode： 打刻所属コード
    • divisionName： 打刻所属名
    • latitude： 緯度
    • longitude： 経度

additionalFields

  • currentDateEmployee： 今日時点の従業員データ
    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
POST https://api.kingtime.jp/v1.0/daily-workings/timerecord/8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3
Requestsexample 1example 2example 3
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "time": "2016-05-01T09:00:00+09:00",
  "latitude": 35.667224,
  "longitude": 139.742221
}
Responses201
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
  "timeRecord": {
    "time": "2016-05-01T09:00:00+09:00",
    "code": "1",
    "name": "出勤",
    "divisionName": "正社員",
    "divisionCode": "1000",
    "latitude": 35.667224,
    "longitude": 139.742221
  }
}
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "time": "2016-05-01T09:00:00+09:00",
  "code": "1",
  "divisionCode": "1000"
}
Responses201
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
  "timeRecord": {
    "time": "2016-05-01T09:00:00+09:00",
    "code": "1",
    "name": "出勤",
    "divisionName": "正社員",
    "divisionCode": "1000"
  }
}
Headers
Content-Type: application/json
Body
{
  "isOmittedWorkingDay": "true",
  "time": "2016-05-01T09:00:00+09:00",
  "code": "1",
  "divisionCode": "1000"
}
Responses201
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
  "timeRecord": {
    "time": "2016-05-01T09:00:00+09:00",
    "code": "1",
    "name": "出勤",
    "divisionName": "正社員",
    "divisionCode": "1000"
  }
}

従業員指定登録
POST/daily-workings/timerecord/{employeeKey}

指定した従業員の打刻データを登録する。(1件)

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeKeystring○

従業員識別キー（従業員コードが変更されても不変）

8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3
GET https://api.kingtime.jp/v1.0/daily-workings/timerecord?employeeKeys=8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3&division=1000&ondivision=true&start=2016-05-01&end=2016-05-10&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "date": "2016-05-01",
    "dailyWorkings": [
      {
        "date": "2016-05-01",
        "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
        "currentDateEmployee": {
          "divisionCode": "1000",
          "divisionName": "本社",
          "gender": "male",
          "typeCode": "1",
          "typeName": "正社員",
          "code": "1000",
          "lastName": "勤怠",
          "firstName": "太郎",
          "lastNamePhonetics": "キンタイ",
          "firstNamePhonetics": "タロウ",
          "employeeGroups": [
            {
              "code": "0001",
              "name": "人事部"
            },
            {
              "code": "0002",
              "name": "総務部"
            }
          ]
        },
        "timeRecord": [
          {
            "time": "2016-05-01T09:00:00+09:00",
            "code": "1",
            "name": "出勤",
            "divisionCode": "1000",
            "divisionName": "本社",
            "latitude": 35.667224,
            "longitude": 139.742221
          },
          {
            "time": "2015-05-01T18:00:00+09:00",
            "code": "2",
            "name": "退勤",
            "divisionCode": "1000",
            "divisionName": "本社",
            "credentialCode": 300,
            "credentialName": "KOTSL",
            "latitude": 35.667224,
            "longitude": 139.742221
          },
          {
            "time": "2016-05-01T10:00:00+09:00",
            "code": "3",
            "name": "休憩開始",
            "divisionCode": "1000",
            "divisionName": "本社"
          },
          {
            "time": "2016-05-01T11:00:00+09:00",
            "code": "4",
            "name": "休憩終了",
            "divisionCode": "1000",
            "divisionName": "本社"
          }
        ]
      }
    ]
  }
]

一覧
GET/daily-workings/timerecord{?employeeKeys,division,ondivision,start,end,additionalFields}

日別打刻データの一覧を取得する。 従業員を指定した場合、対象従業員の日別打刻データを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeKeysstring

従業員識別キー（従業員コードが変更されても不変）
,区切りで複数従業員の指定可能
divisionが指定されていない場合のみ使用可能

8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3
divisionstring

所属コード
employeeKeysが指定されていない場合のみ使用可能

1000
ondivisionbooleantrue

・true:所属に基づいた打刻データ
・false:出勤先に基づいた打刻データ
・divisionが指定されている場合のみ使用可能

true
startstring{当日}

取得したい期間の開始年月日
・過去日は最大3年前まで

2016-05-01
endstring{当日}

取得したい期間の終了年月日
・startとendは同時に指定
・期間は最大62日
・未来日は最大1年後まで

2016-05-10
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee
GET https://api.kingtime.jp/v1.0/daily-workings/timerecord/2016-05-01?division=1000&ondivision=true&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "dailyWorkings": [
    {
      "date": "2016-05-01",
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "currentDateEmployee": {
        "divisionCode": "1000",
        "divisionName": "本社",
        "gender": "male",
        "typeCode": "1",
        "typeName": "正社員",
        "code": "1000",
        "lastName": "勤怠",
        "firstName": "太郎",
        "lastNamePhonetics": "キンタイ",
        "firstNamePhonetics": "タロウ",
        "employeeGroups": [
          {
            "code": "0001",
            "name": "人事部"
          },
          {
            "code": "0002",
            "name": "総務部"
          }
        ]
      },
      "timeRecord": [
        {
          "time": "2016-05-01T09:00:00+09:00",
          "code": "1",
          "name": "出勤",
          "divisionCode": "1000",
          "divisionName": "本社",
          "latitude": 35.667224,
          "longitude": 139.742221
        },
        {
          "time": "2015-05-01T18:00:00+09:00",
          "code": "2",
          "name": "退勤",
          "divisionCode": "1000",
          "divisionName": "本社",
          "credentialCode": 300,
          "credentialName": "KOTSL",
          "latitude": 35.667224,
          "longitude": 139.742221
        },
        {
          "time": "2016-05-01T10:00:00+09:00",
          "code": "3",
          "name": "休憩開始",
          "divisionCode": "1000",
          "divisionName": "本社"
        },
        {
          "time": "2016-05-01T11:00:00+09:00",
          "code": "4",
          "name": "休憩終了",
          "divisionCode": "1000",
          "divisionName": "本社"
        }
      ]
    }
  ]
}

年月日指定
GET/daily-workings/timerecord/{date}{?division,ondivision,additionalFields}

指定した年月日の日別打刻データを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring○

詳細を取得したい年月日
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-05-01
divisionstring

詳細を取得したい所属コード

1000
ondivisionbooleantrue

・true:所属に基づいた打刻データ
・false:出勤先に基づいた打刻データ
・divisionが指定されている場合のみ使用可能

true
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

日別費用データ

日別費用データを取得する。

レスポンス定義

  • date： 日時

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • laborCostEstimate 人件費概算

  • transportationExpense 交通費

additionalFields

  • currentDateEmployee： 今日時点の従業員データ
    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
GET https://api.kingtime.jp/v1.0/daily-workings/cost?division=1000&ondivision=true&start=2016-05-01&end=2016-05-10&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "date": "2016-05-01",
    "dailyWorkings": [
      {
        "date": "2016-05-01",
        "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
        "currentDateEmployee": {
          "divisionCode": "1000",
          "divisionName": "本社",
          "gender": "male",
          "typeCode": "1",
          "typeName": "正社員",
          "code": "1000",
          "lastName": "勤怠",
          "firstName": "太郎",
          "lastNamePhonetics": "キンタイ",
          "firstNamePhonetics": "タロウ",
          "employeeGroups": [
            {
              "code": "0001",
              "name": "人事部"
            },
            {
              "code": "0002",
              "name": "総務部"
            }
          ]
        },
        "laborCostEstimate": 8000,
        "transportationExpense": 1000
      }
    ]
  }
]

一覧
GET/daily-workings/cost{?division,ondivision,start,end,additionalFields}

日別費用データの一覧を取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
divisionstring

所属コード

1000
ondivisionbooleantrue

・true:所属に基づいた費用データ
・false:出勤先に基づいた費用データ
・divisionが指定されている場合のみ使用可能

true
startstring{当日}

取得したい期間の開始年月日
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-05-01
endstring{当日}

取得したい期間の終了年月日
・startとendは同時に指定
・期間は最大62日
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-05-10
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee
GET https://api.kingtime.jp/v1.0/daily-workings/cost/2016-05-01?division=1000&ondivision=true&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "dailyWorkings": [
    {
      "date": "2016-05-01",
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "currentDateEmployee": {
        "divisionCode": "1000",
        "divisionName": "本社",
        "gender": "male",
        "typeCode": "1",
        "typeName": "正社員",
        "code": "1000",
        "lastName": "勤怠",
        "firstName": "太郎",
        "lastNamePhonetics": "キンタイ",
        "firstNamePhonetics": "タロウ",
        "employeeGroups": [
          {
            "code": "0001",
            "name": "人事部"
          },
          {
            "code": "0002",
            "name": "総務部"
          }
        ]
      },
      "laborCostEstimate": 8000,
      "transportationExpense": 1000
    }
  ]
}

年月日指定
GET/daily-workings/cost/{date}{?division,ondivision,additionalFields}

指定した年月日の日別費用データを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring○

詳細を取得したい年月日
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-05-01
divisionstring

詳細を取得したい所属コード

1000
ondivisionbooleantrue

・true:所属に基づいた費用データ
・false:出勤先に基づいた費用データ
・divisionが指定されている場合のみ使用可能

true
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

月別勤怠データ

月別勤務データを取得する。

レスポンス定義

  • year： 年

  • month： 月

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • startDate： 集計開始日

  • endDate： 集計終了日

  • workingCount： 総勤務回数

  • weekdayWorkingCount： 平日勤務回数

  • lateCount： 遅刻回数

  • earlyLeaveCount： 早退回数

  • workingdayCount： 総勤務日数(※1)

  • weekdayWorkingdayCount： 平日勤務日数(※1)

  • absentdayCount： 欠勤日数(※1)

  • holidaysObtained： 休暇取得

    • dayCount： 休暇取得日数(※1)
    • minutes： 時間休暇取得時間（分）
    • code： 休暇区分コード（1 または 2 の休暇はデフォルトで設定されている休暇）
    • name： 休暇区分名

  • assigned： 所定時間（分）

  • unassigned： 所定外時間（分）

  • overtime： 残業時間（分）

  • night： 深夜労働時間（分）

  • nightUnassigned： 深夜所定外時間（分）

  • nightOvertime： 深夜残業時間（分）

  • breakSum： 休憩時間（分）

  • late： 遅刻時間（分）

  • earlyLeave： 早退時間（分）

  • holidayWork： 休日労働

    • normal： 所定労働時間（分）
    • night： 深夜労働時間（分）
    • overtime： 残業時間（分）
    • nightOvertime： 深夜残業時間（分）
    • extra： 所定外時間（分）
    • nightExtra： 深夜所定外時間（分）

  • premiumWork： 割増労働

    • overtime1： 残業時間１（分）
    • nightOvertime1： 深夜残業時間１（分）
    • overtime2： 残業時間２（分）
    • nightOvertime2： 深夜残業時間２（分）

  • legalHolidayWork： 法定休日労働

    • normal： 所定労働時間（分）
    • night： 深夜労働時間（分）
    • overtime： 残業時間（分）
    • nightOvertime： 深夜残業時間（分）
    • extra： 所定外時間（分）
    • nightExtra： 深夜所定外時間（分）
    • count： 勤務回数
    • dayCount： 勤務日数(※1)

  • generalHolidayWork： 法定外休日労働

    • normal： 所定労働時間（分）
    • night： 深夜労働時間（分）
    • overtime： 残業時間（分）
    • nightOvertime： 深夜残業時間（分）
    • extra： 所定外時間（分）
    • nightExtra： 深夜所定外時間（分）
    • count： 勤務回数
    • dayCount： 勤務日数(※1)

  • bind： 拘束時間（分）

  • regarding： 休暇みなし勤務時間（分）

  • isClosing： 締め状況

  • customMonthlyWorkings： 月別カスタム勤怠項目

    • code： 月別カスタム表示コード
    • name： 月別カスタム表示名
    • calculationUnitCode： 計算単位コード
    • calculationUnitName： 計算単位名
    • calculationResult： 計算結果(※2)

  • intervalShortageCount： インターバル不足回数

※1 レスポンス例は整数表記ですが、実際のレスポンスは小数第一位まで表示されます。
※2 レスポンス例は整数表記ですが、実際のレスポンスはcalculationUnitCodeが1もしくは4であれば小数第三位まで表示されます。
また、calculationUnitCodeが2であれば小数第二位まで表示されます。

additionalFields

  • weeklyWork： 週の残業時間

    • overtime： 残業時間（分）
    • nightOvertime： 深夜残業時間（分）
    • generalHolidayOvertime： 法定外休日残業時間（分）
    • generalHolidayNightOvertime： 法定外休日深夜残業時間（分）

  • variationalWork： 変形労働

    • yearlyOvertime： 年の残業時間（分）
    • yearlyNightOvertime： 年の深夜残業時間（分）
    • monthlyOvertime： 月の残業時間（分）
    • monthlyNightOvertime： 月の深夜残業時間（分）
    • weeklyOvertime： 週の残業時間（分）
    • weeklyNightOvertime： 週の深夜残業時間（分）
    • monthlyLegalHolidayOvertime： 月の法定休日残業時間（分）
    • monthlyLegalHolidayNightOvertime： 月の法定休日深夜残業時間（分）
    • weeklyLegalHolidayOvertime： 週の法定休日残業時間（分）
    • weeklyLegalHolidayNightOvertime： 週の法定休日深夜残業時間（分）
    • yearlyGeneralHolidayOvertime： 年の法定外休日残業時間（分）
    • yearlyGeneralHolidayNightOvertime： 年の法定外休日深夜残業時間（分）
    • monthlyGeneralHolidayOvertime： 月の法定外休日残業時間（分）
    • monthlyGeneralHolidayNightOvertime： 月の法定外休日深夜残業時間（分）
    • weeklyGeneralHolidayOvertime： 週の法定外休日残業時間（分）
    • weeklyGeneralHolidayNightOvertime： 週の法定外休日深夜残業時間（分）

  • flexWork： フレックスタイム集計

    • flexMonthlyBasedWorkingAmount： フレックス労働基準時間（分）
    • flexBasicWorkMinute： フレックス基準内労働時間（分）
    • totalFlexOvertimeWorkMinute： フレックス基準外労働時間（分）
    • totalFlexPremiumOvertimeWorkMinute： フレックス割増対象時間（分）
    • flexMonthlyFixedWorkingAmount： フレックス所定労働時間（分）
    • flexFixedWorkMinute： フレックス基準内所定労働時間（分）
    • totalFlexExtraWorkMinute： フレックス基準内所定外時間（分）
    • flexFixedWorkLackMinute： フレックス所定労働不足時間（分）

  • isConfirmation： 確認状況

  • currentDateEmployee： 今日時点の従業員データ

    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
GET https://api.kingtime.jp/v1.0/monthly-workings/2016-06?division=1000&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "year": 2016,
    "month": 6,
    "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
    "currentEmployee": {
      "divisionCode": "1000",
      "divisionName": "本社",
      "gender": "male",
      "typeCode": "1",
      "typeName": "正社員",
      "code": "1000",
      "lastName": "勤怠",
      "firstName": "太郎",
      "lastNamePhonetics": "キンタイ",
      "firstNamePhonetics": "タロウ",
      "employeeGroups": [
        {
          "code": "0001",
          "name": "人事部"
        },
        {
          "code": "0002",
          "name": "総務部"
        }
      ]
    },
    "startDate": "2016-06-01",
    "endDate": "2016-06-21",
    "workingCount": 14,
    "weekdayWorkingCount": 14,
    "lateCount": 0,
    "earlyLeaveCount": 0,
    "workingDayCount": 14,
    "weekdayWorkingdayCount": 14,
    "absentdayCount": 0,
    "holidaysObtained": [
      {
        "dayCount": 0,
        "minutes": 0,
        "code": 1,
        "name": "有休"
      }
    ],
    "assigned": 0,
    "unassigned": 0,
    "overtime": 0,
    "night": 0,
    "nightOvertime": 0,
    "breakSum": 840,
    "late": 0,
    "earlyLeave": 0,
    "holidayWork": {
      "normal": 0,
      "night": 0,
      "overtime": 0,
      "nightOvertime": 0,
      "extra": 0
    },
    "premiumWork": {
      "overtime1": 0,
      "nightOvertime1": 0,
      "overtime2": 0,
      "nightOvertime2": 0
    },
    "legalHolidayWork": {
      "normal": 0,
      "night": 0,
      "overtime": 0,
      "nightOvertime": 0,
      "extra": 0,
      "count": 0,
      "dayCount": 0
    },
    "generalHolidayWork": {
      "normal": 0,
      "night": 0,
      "overtime": 0,
      "nightOvertime": 0,
      "extra": 0,
      "count": 0,
      "dayCount": 0
    },
    "bind": 0,
    "regarding": 0,
    "isClosing": false,
    "customMonthlyWorkings": [
      {
        "code": "mCus3",
        "name": "月別カスタム1",
        "calculationUnitCode": 1,
        "calculationUnitName": "日",
        "calculationResult": 1
      },
      {
        "code": "mCus2",
        "name": "月別カスタム2",
        "calculationUnitCode": 2,
        "calculationUnitName": "時間",
        "calculationResult": 10
      },
      {
        "code": "mCus3",
        "name": "月別カスタム3",
        "calculationUnitCode": 4,
        "calculationUnitName": "数値",
        "calculationResult": 100
      }
    ],
    "intervalShortageCount": 1
  }
]

年月指定
GET/monthly-workings/{date}{?division,additionalFields}

指定した年月の月別勤務データを取得する。

※出勤日数関連の項目ついて
管理画面上の出勤日数関連項目と値を合わせたい場合、半休取得時の出勤日数の計上方法によって使用するプロパティが変わります。
企業情報データAPIで半休取得時の出勤日数の計上方法を参照の上、使用するプロパティを選択してください。

対象勤怠項目 半休取得時の出勤日数の計上方法
oneDay		 半休取得時の出勤日数の計上方法
halfDay
総勤務日数 workingCount workingdayCount
平日勤務日数 weekdayWorkingCount weekdayWorkingdayCount
法定休日勤務日数 legalHolidayWork.count legalHolidayWork.dayCount
法定外休日勤務日数 generalHolidayWork.count generalHolidayWork.dayCount
URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring{当月}

詳細を取得したい年月
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-06
divisionstring

所属コード

1000
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

月別費用データ

月別費用データを取得する。

レスポンス定義

  • year： 年

  • month： 月

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • startDate： 集計開始日

  • endDate： 集計終了日

  • laborCostEstimate： 人件費概算

  • transportationExpense： 交通費

additionalFields

  • currentDateEmployee： 今日時点の従業員データ
    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
GET https://api.kingtime.jp/v1.0/monthly-workings/cost/2016-06?division=1000&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "year": 2016,
    "month": 6,
    "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
    "currentEmployee": {
      "divisionCode": "1000",
      "divisionName": "本社",
      "gender": "male",
      "typeCode": "1",
      "typeName": "正社員",
      "code": "1000",
      "lastName": "勤怠",
      "firstName": "太郎",
      "lastNamePhonetics": "キンタイ",
      "firstNamePhonetics": "タロウ",
      "employeeGroups": [
        {
          "code": "0001",
          "name": "人事部"
        },
        {
          "code": "0002",
          "name": "総務部"
        }
      ]
    },
    "startDate": "2016-06-01",
    "endDate": "2016-06-30",
    "laborCostEstimate": 200000,
    "transportationExpense": 20000
  }
]

年月指定
GET/monthly-workings/cost/{date}{?division,additionalFields}

指定した年月の月別費用データを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring{当月}

詳細を取得したい年月
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-06
divisionstring

所属コード

1000
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

月別残休暇データ

月別残休暇データを取得する。

レスポンス定義

  • date： 年月日(残休暇取得時点)

  • closeDate： 締日

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • holidayRemained： 残休暇

    • day： 残休暇日数
    • minutes： 残休暇時間
    • code： 休暇区分コード（1 または 2 の休暇はデフォルトで設定されている休暇）
    • name： 休暇区分名

additionalFields

  • currentDateEmployee： 今日時点の従業員データ
    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
GET https://api.kingtime.jp/v1.0/monthly-workings/holiday-remained/1000/2016-06?additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "date": "2016-06-30",
    "closeDate": 30,
    "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
    "currentDateEmployee": {
      "divisionCode": "1000",
      "divisionName": "本社",
      "gender": "male",
      "typeCode": "1",
      "typeName": "正社員",
      "code": "1000",
      "lastName": "勤怠",
      "firstName": "太郎",
      "lastNamePhonetics": "キンタイ",
      "firstNamePhonetics": "タロウ",
      "employeeGroups": [
        {
          "code": "0001",
          "name": "人事部"
        },
        {
          "code": "0002",
          "name": "総務部"
        }
      ]
    },
    "holidayRemained": [
      {
        "day": 0,
        "minutes": 0,
        "code": 1,
        "name": "有休"
      },
      {
        "day": 0,
        "minutes": 0,
        "code": 2,
        "name": "代休"
      }
    ]
  }
]

年月指定
GET/monthly-workings/holiday-remained/{employeeTypeCode}/{date}{?additionalFields}

指定した年月の残休暇データを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeTypeCodestring○

詳細を取得したい雇用区分コード

1000
datestring○

詳細を取得したい年月
・過去日は最大3年前まで
・未来月は指定できません

2016-06
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

年別休暇データ

年度内で行った休暇付与、取得を一覧で取得する。

レスポンス定義

  • year： 年度

  • startDate： 年度開始日

  • endDate： 年度終了日

  • closeDate： 締日

  • employees： 従業員別の休暇情報

    • employeeKey： 従業員識別キー（従業員コードが変更されても不変）
    • holidays： 付与・取得一覧
      • code： 休暇区分コード
      • name： 休暇区分名
      • granted： 付与一覧
        • date： 付与日
        • days： 付与日数
        • minutes： 付与時間(分)
        • effectivePeriod： 有効期限
      • obtained： 取得一覧
        • date： 取得日
        • days： 取得日数
        • minutes： 取得時間(分)
      • remained： 繰越一覧
        • date： 繰越日
        • days： 繰越日数
        • minutes： 繰越時間(分)
      • expired： 失効一覧
        • date： 失効日
        • days： 失効日数
        • minutes： 失効時間(分)

additionalFields

  • currentDateEmployee： 今日時点の従業員データ
    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
GET https://api.kingtime.jp/v1.0/yearly-workings/holidays/1000/2019?additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
{
  "year": "2019",
  "startDate": "2019-01-01",
  "endDate": "2019-12-31",
  "closeDate": 30,
  "employees": [
    {
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "currentDateEmployee": {
        "divisionCode": "1000",
        "divisionName": "本社",
        "gender": "male",
        "typeCode": "1",
        "typeName": "正社員",
        "code": "1000",
        "lastName": "勤怠",
        "firstName": "太郎",
        "lastNamePhonetics": "キンタイ",
        "firstNamePhonetics": "タロウ",
        "employeeGroups": [
          {
            "code": "0001",
            "name": "人事部"
          },
          {
            "code": "0002",
            "name": "総務部"
          }
        ]
      },
      "holidays": [
        {
          "code": 1,
          "name": "有休",
          "granted": [
            {
              "date": "2019-01-01",
              "days": 5,
              "minutes": 120,
              "effectivePeriod": "2019-04-01"
            },
            {
              "date": "2019-04-01",
              "minutes": 180,
              "effectivePeriod": "2019-07-01"
            }
          ],
          "obtained": [
            {
              "date": "2019-02-02",
              "days": 1
            },
            {
              "date": "2019-05-10",
              "minutes": 180
            }
          ],
          "remained": [
            {
              "date": "2019-04-01",
              "days": 2,
              "minutes": 120
            }
          ],
          "expired": [
            {
              "date": "2019-06-01",
              "days": 2
            },
            {
              "date": "2019-03-01",
              "minutes": 120
            }
          ]
        },
        {
          "code": 2,
          "name": "代休",
          "granted": [
            {
              "date": "2019-01-01",
              "days": 5,
              "minutes": 120,
              "effectivePeriod": "2019-04-01"
            },
            {
              "date": "2019-04-01",
              "minutes": 180,
              "effectivePeriod": "2019-07-01"
            }
          ],
          "obtained": [
            {
              "date": "2019-02-02",
              "days": 1
            },
            {
              "date": "2019-05-10",
              "minutes": 180
            }
          ],
          "remained": [
            {
              "date": "2019-04-01",
              "days": 2,
              "minutes": 120
            }
          ],
          "expired": [
            {
              "date": "2019-06-01",
              "days": 2
            },
            {
              "date": "2019-03-01",
              "minutes": 120
            }
          ]
        }
      ]
    }
  ]
}

年度指定
GET/yearly-workings/holidays/{employeeTypeCode}/{year}{?additionalFields}

指定した年度にて行った休暇付与、取得を一覧で取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeTypeCodestring○

詳細を取得したい雇用区分コード

1000
yearstring○

詳細を取得したい年度

2019
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

日別スケジュールデータ

リクエスト定義

登録・更新

  • workPlaceDivisionCode： 出勤先所属コード(※未指定の場合：指定した従業員の所属コード)

  • clockInSchedule： 出勤予定時間

  • clockOutSchedule： 退勤予定時間

  • workFixedStart： 勤務開始刻限

  • workFixedEnd： 勤務終了刻限

  • startEndBreakSchedule： 休憩開始終了予定

    • start： 休憩開始予定
    • end： 休憩終了予定

  • fulltimeHoliday 全日休暇

    • code： 休暇区分コード

  • halfdayHolidays 半日休暇

    • typeName： (AM半休,PM半休)
    • code： 休暇区分コード

  • hourHolidays　時間休暇

    • start： 休暇開始予定
    • end： 休暇終了予定
    • code： 休暇区分コード

  • workDayTypeCode： 勤務日種別コード(1:平日,2:法定休日,3:法定外休日)(※未指定の場合：1:平日)

  • note： 備考

登録・更新（一括）
  • employeeScheduleRequests： 従業員識別キー、スケジュール情報を配列で指定する
    • employeeKey： 従業員識別キー
    • dailySchedules： 従業員のスケジュール情報を配列で指定する
      • workingDate： 勤務日
      • workPlaceDivisionCode： 出勤先所属コード(※未指定の場合：指定した従業員の所属コード)
      • clockInSchedule： 出勤予定時間
      • clockOutSchedule： 退勤予定時間
      • workFixedStart： 勤務開始刻限
      • workFixedEnd： 勤務終了刻限
      • startEndBreakSchedule： 休憩開始終了予定
        • start： 休憩開始予定
        • end： 休憩終了予定
      • fulltimeHoliday 全日休暇
        • code： 休暇区分コード
      • halfdayHolidays 半日休暇
        • typeName： (AM半休,PM半休)
        • code： 休暇区分コード
      • hourHolidays　時間休暇
        • start： 休暇開始予定
        • end： 休暇終了予定
        • code： 休暇区分コード
      • workDayTypeCode： 勤務日種別コード(1:平日,2:法定休日,3:法定外休日)(※未指定の場合：1:平日)
      • note： 備考

レスポンス定義

  • date： 年月日

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • clockInSchedule： 出勤予定時間

  • clockOutSchedule： 退勤予定時間

  • breakSchedule： 休憩予定時間(分)

  • startEndBreakSchedule： 休憩開始終了予定

    • start： 休憩開始予定
    • end： 休憩終了予定

  • holidaysObtained： 休暇取得

    • fulltimeHoliday
      • code： 休暇区分コード
      • name： 休暇区分名
    • halfdayHolidays
      • typeName： 半休種別名
      • code： 休暇区分コード
      • name： 休暇区分名
    • hourHolidays
      • start： 休暇開始予定
      • end： 休暇終了予定
      • minutes： 休暇取得時間
      • code： 休暇区分コード
      • name： 休暇区分名

  • workDayTypeName： 勤務日種別名

  • halfDayVacationTypeCode： 半休種別コード

  • halfDayVacationTypeName： 半休種別名

  • overtimeUpperLimit： 残業上限時間（分）

  • workPlaceDivisionCode： 出勤先所属コード

  • workPlaceDivisionName： 出勤先所属名

  • substitutionClockInName： 振替出勤

  • scheduleTypeName： スケジュール種別

additionalFields

  • schedulePatternCode： スケジュールパターンコード

  • schedulePatternName： スケジュールパターン名

  • workFixedStart： 勤務開始刻限

  • workFixedEnd： 勤務終了刻限

  • note： 備考

  • currentDateEmployee： 今日時点の従業員データ

    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
PUT https://api.kingtime.jp/v1.0/daily-schedules/8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3/2016-05-01
Requestsexample 1
Headers
Content-Type: application/json
Body
{
  "workPlaceDivisionCode": "1000",
  "clockInSchedule": "2016-05-01T09:00+09:00",
  "clockOutSchedule": "2016-05-01T18:00+09:00",
  "workFixedStart": "2016-05-01T08:00+09:00",
  "workFixedEnd": "2016-05-01T19:00+09:00",
  "startEndBreakSchedule": [
    {
      "start": "2016-05-01T11:00+09:00",
      "end": "2016-05-01T12:00+09:00"
    }
  ],
  "fulltimeHoliday": {
    "code": 1
  },
  "halfdayHolidays": [
    {
      "typeName": "PM半休",
      "code": 1
    }
  ],
  "hourHolidays": [
    {
      "start": "2016-05-01T10:00+09:00",
      "end": "2016-05-01T11:00+09:00",
      "code": 1
    }
  ],
  "workDayTypeCode": "1",
  "note": "午後半休を取得します。"
}
Responses200
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "dailySchedules": [
    {
      "date": "2016-05-01",
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "workPlaceDivisionCode": "1000",
      "workPlaceDivisionName": "本社",
      "clockInSchedule": "2016-05-01T09:00+09:00",
      "clockOutSchedule": "2016-05-01T18:00+09:00",
      "workFixedStart": "2016-05-01T08:00+09:00",
      "workFixedEnd": "2016-05-01T19:00+09:00",
      "startEndBreakSchedule": [
        {
          "start": "2016-05-01T11:00+09:00",
          "end": "2016-05-01T12:00+09:00"
        }
      ],
      "holidaysObtained": {
        "fulltimeHoliday": {
          "code": 1,
          "name": "有休"
        },
        "halfdayHolidays": [
          {
            "typeName": "PM休",
            "code": 1,
            "name": "有休"
          }
        ],
        "hourHolidays": [
          {
            "start": "2016-05-01T10:00+09:00",
            "end": "2016-05-01T11:00+09:00",
            "minutes": 60,
            "code": 1,
            "name": "有休"
          }
        ]
      },
      "workDayTypeName": "平日",
      "note": "午後半休を取得します。"
    }
  ]
}

登録・更新
PUT/daily-schedules/{employeeKey}/{date}

日別スケジュールデータを登録・更新(既存スケジュールを削除後に登録)する。

※dateで指定された勤務日に対して、既に打刻・勤怠補助項目が存在する場合にはエラーとなります。
※全日休暇の登録・更新について、企業の全日休暇の取得方法がパターン使用の場合には対応していません。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeKeystring○

従業員識別キー（従業員コードが変更されても不変）

8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3
datestring○

登録・更新したい年月日

2016-05-01
PUT https://api.kingtime.jp/v1.0/daily-schedules
Requestsexample 1
Headers
Content-Type: application/json
Body
{
  "employeeScheduleRequests": [
    {
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "dailySchedules": [
        {
          "workingDate": "2024-04-01",
          "workPlaceDivisionCode": "1000",
          "clockInSchedule": "2024-04-01T09:00+09:00",
          "clockOutSchedule": "2024-04-01T18:00+09:00"
        },
        {
          "workingDate": "2024-04-02",
          "workPlaceDivisionCode": "1000",
          "clockInSchedule": "2024-04-02T09:00+09:00",
          "clockOutSchedule": "2024-04-02T18:00+09:00"
        }
      ]
    },
    {
      "employeeKey": "2b953df43e63bb6d6c01a5bbe4e90c398f7e1b4a12423c3082d3a012da002230",
      "dailySchedules": [
        {
          "workingDate": "2024-04-01",
          "workPlaceDivisionCode": "2000",
          "clockInSchedule": "2024-04-01T09:00+09:00",
          "clockOutSchedule": "2024-04-01T18:00+09:00"
        },
        {
          "workingDate": "2024-04-02",
          "workPlaceDivisionCode": "2000",
          "clockInSchedule": "2024-04-02T09:00+09:00",
          "clockOutSchedule": "2024-04-02T18:00+09:00"
        }
      ]
    }
  ]
}
Responses200
Headers
Content-Type: application/json
Body
{
  "successRequest": [
    {
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "dailySchedules": [
        {
          "date": "Mon Apr 01 00:00:00 JST 2024",
          "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
          "workPlaceDivisionCode": "1000",
          "workPlaceDivisionName": "本社",
          "clockInSchedule": "2024-04-01T09:00+09:00",
          "clockOutSchedule": "2024-04-01T18:00+09:00",
          "workDayTypeName": "平日"
        },
        {
          "date": "Tue Apr 02 00:00:00 JST 2024",
          "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
          "workPlaceDivisionCode": "1000",
          "workPlaceDivisionName": "本社",
          "clockInSchedule": "2024-04-02T09:00+09:00",
          "clockOutSchedule": "2024-04-02T18:00+09:00",
          "workDayTypeName": "平日"
        }
      ]
    },
    {
      "employeeKey": "2b953df43e63bb6d6c01a5bbe4e90c398f7e1b4a12423c3082d3a012da002230",
      "dailySchedules": [
        {
          "date": "Mon Apr 01 00:00:00 JST 2024",
          "employeeKey": "2b953df43e63bb6d6c01a5bbe4e90c398f7e1b4a12423c3082d3a012da002230",
          "workPlaceDivisionCode": "2000",
          "workPlaceDivisionName": "支社",
          "clockInSchedule": "2024-04-01T09:00+09:00",
          "clockOutSchedule": "2024-04-01T18:00+09:00",
          "workDayTypeName": "平日"
        },
        {
          "date": "Tue Apr 02 00:00:00 JST 2024",
          "employeeKey": "2b953df43e63bb6d6c01a5bbe4e90c398f7e1b4a12423c3082d3a012da002230",
          "workPlaceDivisionCode": "2000",
          "workPlaceDivisionName": "支社",
          "clockInSchedule": "2024-04-02T09:00+09:00",
          "clockOutSchedule": "2024-04-02T18:00+09:00",
          "workDayTypeName": "平日"
        }
      ]
    }
  ],
  "errorRequest": [
    {
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "errors": [
        {
          "date": "Mon Apr 01 00:00:00 JST 2024",
          "code": "111",
          "message": "Bad Authentication."
        },
        {
          "date": "Tue Apr 02 00:00:00 JST 2024",
          "code": "222",
          "message": "Id is empty."
        }
      ]
    },
    {
      "employeeKey": "2b953df43e63bb6d6c01a5bbe4e90c398f7e1b4a12423c3082d3a012da002230",
      "errors": [
        {
          "date": "Mon Apr 01 00:00:00 JST 2024",
          "code": "552",
          "message": "Bad fulltimeHoliday code does not exist."
        },
        {
          "date": "Tue Apr 02 00:00:00 JST 2024",
          "code": "273",
          "message": "workPlaceDivision does not exist"
        }
      ]
    }
  ]
}

登録・更新（一括）
PUT/daily-schedules

日別スケジュールデータを一括で登録・更新(既存スケジュールを削除後に登録)する。

※1リクエストのスケジュール登録数上限は1,000件までとなります。
※workingDateで指定された勤務日に対して、既に打刻・勤怠補助項目が存在する場合にはエラーとなります。
※全日休暇の登録・更新について、企業の全日休暇の取得方法がパターン使用の場合には対応していません。

DELETE https://api.kingtime.jp/v1.0/daily-schedules/8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3/2016-05-01
Responses204
This response has no content.

削除
DELETE/daily-schedules/{employeeKey}/{date}

日別スケジュールデータを削除する。

※dateで指定された勤務日に対して、既に打刻・勤怠補助項目が存在する場合にはエラーとなります。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeKeystring○

従業員識別キー（従業員コードが変更されても不変）

8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3
datestring○

削除したい年月日

2016-05-01
GET https://api.kingtime.jp/v1.0/daily-schedules/?division=1000&ondivision=true&start=2016-05-01&end=2016-05-10&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "date": "2016-05-01",
    "dailySchedules": [
      {
        "date": "2016-05-01",
        "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
        "currentDateEmployee": {
          "divisionCode": "1000",
          "divisionName": "本社",
          "gender": "male",
          "typeCode": "1",
          "typeName": "正社員",
          "code": "1000",
          "lastName": "勤怠",
          "firstName": "太郎",
          "lastNamePhonetics": "キンタイ",
          "firstNamePhonetics": "タロウ",
          "employeeGroups": [
            {
              "code": "0001",
              "name": "人事部"
            },
            {
              "code": "0002",
              "name": "総務部"
            }
          ]
        },
        "clockInSchedule": "2016-05-01T09:00+09:00",
        "clockOutSchedule": "2016-05-01T18:00+09:00",
        "breakSchedule": 60,
        "startEndBreakSchedule": [
          {
            "start": "2016-05-01T11:00+09:00",
            "end": "2016-05-01T12:00+09:00"
          }
        ],
        "workDayTypeName": "平日",
        "holidaysObtained": {
          "fulltimeHoliday": {
            "code": 1,
            "name": "有休"
          },
          "halfdayHolidays": [
            {
              "typeName": "PM休",
              "code": 1,
              "name": "有休"
            }
          ],
          "hourHolidays": [
            {
              "start": "2016-05-01T10:00+09:00",
              "end": "2016-05-01T11:00+09:00",
              "minutes": 60,
              "code": 1,
              "name": "有休"
            }
          ]
        },
        "overtimeUpperLimit": 120,
        "workPlaceDivisionCode": "1000",
        "workPlaceDivisionName": "本社",
        "substitutionClockInName": "振休",
        "scheduleTypeName": "通常勤務"
      }
    ]
  }
]

一覧
GET/daily-schedules/{?division,ondivision,start,end,additionalFields}

日別スケジュールデータの一覧を取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
divisionstring

所属コード

1000
ondivisionbooleantrue

・true:所属に基づいた勤務データ
・false:出勤先に基づいた勤務データ
・divisionが指定されている場合のみ使用可能

true
startstring{本日日付}

取得したい期間の開始日

2016-05-01
endstring{本日日付}

取得したい期間の終了日
・startとendは同時に指定する
・期間は最大62日までとする

2016-05-10
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee
GET https://api.kingtime.jp/v1.0/daily-schedules/2016-05-01?division=1000&ondivision=true&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "dailySchedules": [
    {
      "date": "2016-05-01",
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "currentDateEmployee": {
        "divisionCode": "1000",
        "divisionName": "本社",
        "gender": "male",
        "typeCode": "1",
        "typeName": "正社員",
        "code": "1000",
        "lastName": "勤怠",
        "firstName": "太郎",
        "lastNamePhonetics": "キンタイ",
        "firstNamePhonetics": "タロウ",
        "employeeGroups": [
          {
            "code": "0001",
            "name": "人事部"
          },
          {
            "code": "0002",
            "name": "総務部"
          }
        ]
      },
      "clockInSchedule": "2016-05-01T09:00+09:00",
      "clockOutSchedule": "2016-05-01T18:00+09:00",
      "breakSchedule": 60,
      "startEndBreakSchedule": [
        {
          "start": "2016-05-01T11:00+09:00",
          "end": "2016-05-01T12:00+09:00"
        }
      ],
      "workDayTypeName": "平日",
      "holidaysObtained": {
        "fulltimeHoliday": {
          "code": 1,
          "name": "有休"
        },
        "halfdayHolidays": [
          {
            "typeName": "PM休",
            "code": 1,
            "name": "有休"
          }
        ],
        "hourHolidays": [
          {
            "start": "2016-05-01T10:00+09:00",
            "end": "2016-05-01T11:00+09:00",
            "minutes": 60,
            "code": 1,
            "name": "有休"
          }
        ]
      },
      "overtimeUpperLimit": 120,
      "workPlaceDivisionCode": "1000",
      "workPlaceDivisionName": "本社",
      "substitutionClockInName": "振休",
      "scheduleTypeName": "通常勤務"
    }
  ]
}

年月日指定
GET/daily-schedules/{date}{?division,ondivision,additionalFields}

指定した年月日の日別スケジュールデータを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring○

詳細を取得したい年月日

2016-05-01
divisionstring

所属コード

1000
ondivisionbooleantrue

・true:所属に基づいた勤務データ
・false:出勤先に基づいた勤務データ
・divisionが指定されている場合のみ使用可能

true
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

日別スケジュール費用データ

日別スケジュール費用データを取得する。

レスポンス定義

  • date： 日時

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • laborCostEstimate 人件費概算

  • transportationExpense 交通費

additionalFields

  • currentDateEmployee： 今日時点の従業員データ
    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
GET https://api.kingtime.jp/v1.0/daily-schedules/cost?division=1000&ondivision=true&start=2016-05-01&end=2016-05-10&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "date": "2016-05-01",
    "dailySchedules": [
      {
        "date": "2016-05-01",
        "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
        "currentDateEmployee": {
          "divisionCode": "1000",
          "divisionName": "本社",
          "gender": "male",
          "typeCode": "1",
          "typeName": "正社員",
          "code": "1000",
          "lastName": "勤怠",
          "firstName": "太郎",
          "lastNamePhonetics": "キンタイ",
          "firstNamePhonetics": "タロウ",
          "employeeGroups": [
            {
              "code": "0001",
              "name": "人事部"
            },
            {
              "code": "0002",
              "name": "総務部"
            }
          ]
        },
        "laborCostEstimate": 8000,
        "transportationExpense": 1000
      }
    ]
  }
]

一覧
GET/daily-schedules/cost{?division,ondivision,start,end,additionalFields}

日別スケジュール費用データの一覧を取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
divisionstring

所属コード

1000
ondivisionbooleantrue

・true:所属に基づいた費用データ
・false:出勤先に基づいた費用データ
・divisionが指定されている場合のみ使用可能

true
startstring{当日}

取得したい期間の開始年月日
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-05-01
endstring{当日}

取得したい期間の終了年月日
・startとendは同時に指定
・期間は最大62日
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-05-10
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee
GET https://api.kingtime.jp/v1.0/daily-schedules/cost/2016-05-01?division=1000&ondivision=true&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "dailySchedules": [
    {
      "date": "2016-05-01",
      "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
      "currentDateEmployee": {
        "divisionCode": "1000",
        "divisionName": "本社",
        "gender": "male",
        "typeCode": "1",
        "typeName": "正社員",
        "code": "1000",
        "lastName": "勤怠",
        "firstName": "太郎",
        "lastNamePhonetics": "キンタイ",
        "firstNamePhonetics": "タロウ",
        "employeeGroups": [
          {
            "code": "0001",
            "name": "人事部"
          },
          {
            "code": "0002",
            "name": "総務部"
          }
        ]
      },
      "laborCostEstimate": 8000,
      "transportationExpense": 1000
    }
  ]
}

年月日指定
GET/daily-schedules/cost/{date}{?division,ondivision,additionalFields}

指定した年月日の日別スケジュール費用データを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring○

詳細を取得したい年月日
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-05-01
divisionstring

詳細を取得したい所属コード

1000
ondivisionbooleantrue

・true:所属に基づいた費用データ
・false:出勤先に基づいた費用データ
・divisionが指定されている場合のみ使用可能

true
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

月別スケジュール費用データ

月別スケジュール費用データを取得する。

レスポンス定義

  • date： 日時

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • laborCostEstimate 人件費概算

  • transportationExpense 交通費

additionalFields

  • currentDateEmployee： 今日時点の従業員データ
    • divisionCode： 所属コード
    • divisionName： 所属名
    • gender： 性別（no_selected： 選択しない　male： 男性　female： 女性）
    • typeCode： 雇用区分コード
    • typeName： 雇用区分名
    • code： 従業員コード
    • lastName： 姓
    • firstName： 名
    • lastNamePhonetics： 姓（カナ）
    • firstNamePhonetics： 名（カナ）
    • employeeGroups： 従業員グループ情報
      • code： 従業員グループコード
      • name： 従業員グループ名
GET https://api.kingtime.jp/v1.0/monthly-schedules/cost/2016-06?division=1000&additionalFields=currentDateEmployee
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "year": 2016,
    "month": 6,
    "employeeKey": "8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3",
    "currentEmployee": {
      "divisionCode": "1000",
      "divisionName": "本社",
      "gender": "male",
      "typeCode": "1",
      "typeName": "正社員",
      "code": "1000",
      "lastName": "勤怠",
      "firstName": "太郎",
      "lastNamePhonetics": "キンタイ",
      "firstNamePhonetics": "タロウ",
      "employeeGroups": [
        {
          "code": "0001",
          "name": "人事部"
        },
        {
          "code": "0002",
          "name": "総務部"
        }
      ]
    },
    "laborCostEstimate": 200000,
    "transportationExpense": 20000
  }
]

年月指定
GET/monthly-schedules/cost/{date}{?division,additionalFields}

指定した年月の月別スケジュール費用データを取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring{当月}

詳細を取得したい年月
・過去日は最大3年前まで
・未来日は最大1年後まで

2016-06
divisionstring

所属コード

1000
additionalFieldsstring

指定されたプロパティをレスポンスに追加

currentDateEmployee

休暇区分データ

休暇区分データを取得する。

レスポンス定義

  • code： 休暇区分コード

  • name： 休暇区分名

GET https://api.kingtime.jp/v1.0/holiday-types
Responses200
Headers
Content-Type: application/json
Body
[
  {
    "code": "1",
    "name": "有休"
  },
  {
    "code": "2",
    "name": "代休"
  }
]

一覧
GET/holiday-types

休暇区分データ一覧を取得する。

申請

スケジュール申請データ

スケジュール申請のデータを取得する。

レスポンス定義

  • year： 年

  • month： 月

  • requests： スケジュール申請データ

    • date： 対象日
    • requestedDate： 申請日
    • employeeKey： 従業員識別キー（従業員コードが変更されても不変）
    • requestKey： 申請識別キー
    • applicant： 申請者
      • type： 種別（employee： 従業員　administrator： 管理者)
      • key： 識別キー（従業員 または 管理者）
    • status： 申請ステータス（applying 申請中　rejected： 棄却　approved： 承認）
    • currentFlow： 現在の承認フローレベル（１～５）
    • lastModifiedAdministratorKey： 最終更新管理者識別キー
    • message： 申請メッセージ
    • adminComment： 管理者コメント
    • requested： 申請内容
      • clockInSchedule： 出勤予定時間
      • clockOutSchedule： 退勤予定時間
      • breakSchedule： 休憩予定時間(分)
      • startEndBreakSchedule： 休憩開始終了予定
      • start： 休憩開始予定
      • end： 休憩終了予定
      • holidaysObtained： 休暇取得
        • fulltimeHoliday
          • code： 休暇区分コード
          • name： 休暇区分名
        • halfdayHolidays
          • typeName： 半休種別名
          • code： 休暇区分コード
          • name： 休暇区分名
        • hourHolidays
          • start： 休暇開始予定
          • end： 休暇終了予定
          • minutes： 休暇取得時間
          • code： 休暇区分コード
          • name： 休暇区分名
      • workDayTypeName： 勤務日種別名
      • workPlaceDivisionCode： 出勤先所属コード
      • workPlaceDivisionName： 出勤先所属名
      • substitutionClockInName： 振替出勤
      • scheduleTypeName： スケジュール種別
    • current： 現在のスケジュール
      • clockInSchedule： 出勤予定時間
      • clockOutSchedule： 退勤予定時間
      • breakSchedule： 休憩予定時間(分)
      • startEndBreakSchedule： 休憩開始終了予定
      • start： 休憩開始予定
      • end： 休憩終了予定
      • holidaysObtained： 休暇取得
        • fulltimeHoliday
          • code： 休暇区分コード
          • name： 休暇区分名
        • halfdayHolidays
          • typeName： 半休種別名
          • code： 休暇区分コード
          • name： 休暇区分名
        • hourHolidays
          • start： 休暇開始予定
          • end： 休暇終了予定
          • minutes： 休暇取得時間
          • code： 休暇区分コード
          • name： 休暇区分名
      • workDayTypeName： 勤務日種別名
      • overtimeUpperLimit： 残業上限時間（分）
      • workPlaceDivisionCode： 出勤先所属コード
      • workPlaceDivisionName： 出勤先所属名
      • substitutionClockInName： 振替出勤
      • scheduleTypeName： スケジュール種別

    additionalFields

    • schedulePatternCode： スケジュールパターンコード
    • schedulePatternName： スケジュールパターン名
    • workFixedStart： 勤務開始刻限
    • workFixedEnd： 勤務終了刻限
    • note： 備考
    • flow： 承認フロー
      • level： 承認フローレベル（１～５）
      • administratorKeys： 管理者識別キー（管理者コードが変更されても不変）
GET https://api.kingtime.jp/v1.0/requests/schedules/2018-08?administratorKey=c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222&additionalFields=flow
Responses200
Headers
Content-Type: application/json
Body
{
  "year": 2018,
  "month": 8,
  "requests": [
    {
      "date": "2018-08-01",
      "requestedDate": "2018-08-10",
      "employeeKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe2735215201",
      "requestKey": "59d25f49d4dce8b6e6658cc6b5c3b89b34c617916f90f6e27e9a9fa6cca576a4",
      "applicant": {
        "type": "employee",
        "key": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe2735215201"
      },
      "status": "applying",
      "currentFlow": 2,
      "flow": [
        {
          "level": 1,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff"
          ]
        },
        {
          "level": 2,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222"
          ]
        },
        {
          "level": 3,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac111"
          ]
        }
      ],
      "message": "申請いたします",
      "adminComment": "第1承認者承認済",
      "lastModifiedAdministratorKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff",
      "requested": {
        "clockInSchedule": "2018-08-01T09:00+09:00",
        "clockOutSchedule": "2018-08-01T18:00+09:00",
        "breakSchedule": 60,
        "startEndBreakSchedule": [
          {
            "start": "2018-08-01T11:00+09:00",
            "end": "2018-08-01T12:00+09:00"
          }
        ],
        "workDayTypeName": "平日",
        "holidaysObtained": {
          "fulltimeHoliday": {
            "code": 1,
            "name": "有休"
          },
          "halfdayHolidays": [
            {
              "typeName": "PM休",
              "code": 1,
              "name": "有休"
            }
          ],
          "hourHolidays": [
            {
              "start": "2018-08-01T10:00+09:00",
              "end": "2018-08-01T11:00+09:00",
              "minutes": 60,
              "code": 1,
              "name": "有休"
            }
          ]
        },
        "workPlaceDivisionCode": "1000",
        "workPlaceDivisionName": "本社",
        "substitutionClockInName": "振休",
        "scheduleTypeName": "通常勤務"
      },
      "current": {
        "clockInSchedule": "2018-08-01T10:00+09:00",
        "clockOutSchedule": "2018-08-01T20:00+09:00",
        "breakSchedule": 60,
        "startEndBreakSchedule": [
          {
            "start": "2018-08-01T11:00+09:00",
            "end": "2018-08-01T12:00+09:00"
          }
        ],
        "workDayTypeName": "平日",
        "holidaysObtained": {
          "fulltimeHoliday": {
            "code": 1,
            "name": "有休"
          },
          "halfdayHolidays": [
            {
              "typeName": "PM休",
              "code": 1,
              "name": "有休"
            }
          ],
          "hourHolidays": [
            {
              "start": "2018-08-01T10:00+09:00",
              "end": "2018-08-01T11:00+09:00",
              "minutes": 60,
              "code": 1,
              "name": "有休"
            }
          ]
        },
        "overtimeUpperLimit": 120,
        "workPlaceDivisionCode": "1000",
        "workPlaceDivisionName": "本社",
        "substitutionClockInName": "振休",
        "scheduleTypeName": "シフト"
      }
    }
  ]
}

年月指定
GET/requests/schedules/{date}{?administratorKey,additionalFields}

指定した年月のスケジュール申請データを取得する。

※対象企業がスケジュール申請を利用できない場合にはエラーとなります。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring○

詳細を取得したい年月
・過去日は最大3年前まで
・未来日は最大1年後まで

2018-08
administratorKeystring

管理者識別キー（管理者コードが変更されても不変）

c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222
additionalFieldsstring

指定されたプロパティをレスポンスに追加

flow

時間外勤務申請データ

時間外勤務申請のデータを取得する。

レスポンス定義

  • year： 年

  • month： 月

  • requests： 時間外勤務申請データ

    • date： 対象日
    • requestedDate： 申請日
    • employeeKey： 従業員識別キー（従業員コードが変更されても不変）
    • requestKey： 申請識別キー
    • applicant： 申請者
      • type： 種別（employee： 従業員　administrator： 管理者)
      • key： 識別キー（従業員 または 管理者）
    • status： 申請ステータス（applying 申請中　rejected： 棄却　approved： 承認）
    • currentFlow： 現在の承認フローレベル（１～５）
    • lastModifiedAdministratorKey： 最終更新管理者識別キー
    • message： 申請メッセージ
    • adminComment： 管理者コメント
    • requested： 申請内容
      • isBeforeSchedule： 勤務予定前の時間外申請か（true 予定前　false： 予定後）
      • start： 開始時刻
      • end： 終了時刻
    • current： 現在のスケジュール
      • isBeforeSchedule： 勤務予定前の時間外申請か（true 予定前　false： 予定後）
      • start： 開始時刻
      • end： 終了時刻

    additionalFields

    • flow： 承認フロー
      • level： 承認フローレベル（１～５）
      • administratorKeys： 管理者識別キー（管理者コードが変更されても不変）
GET https://api.kingtime.jp/v1.0/requests/overtimes/2018-08?administratorKey=c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222&additionalFields=flow
Responses200
Headers
Content-Type: application/json
Body
{
  "year": 2018,
  "month": 8,
  "requests": [
    {
      "date": "2018-08-01",
      "requestedDate": "2018-08-10",
      "employeeKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe2735215201",
      "requestKey": "59d25f49d4dce8b6e6658cc6b5c3b89b34c617916f90f6e27e9a9fa6cca576a4",
      "applicant": {
        "type": "employee",
        "key": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe2735215201"
      },
      "status": "applying",
      "currentFlow": 2,
      "flow": [
        {
          "level": 1,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff"
          ]
        },
        {
          "level": 2,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222"
          ]
        },
        {
          "level": 3,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac111"
          ]
        }
      ],
      "message": "申請いたします",
      "adminComment": "第1承認者承認済",
      "lastModifiedAdministratorKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff",
      "requested": {
        "isBeforeSchedule": true,
        "start": "2018-08-01T08:00+09:00",
        "end": "2018-08-01T10:00+09:00"
      },
      "current": {
        "isBeforeSchedule": true,
        "start": "2018-08-01T09:00+09:00",
        "end": "2018-08-01T10:00+09:00"
      }
    }
  ]
}

年月指定
GET/requests/overtimes/{date}{?administratorKey,additionalFields}

指定した年月の時間外勤務申請データを取得する。

※対象企業が時間外勤務申請を利用できない場合にはエラーとなります。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring○

詳細を取得したい年月
・過去日は最大3年前まで
・未来日は最大1年後まで

2018-08
administratorKeystring

管理者識別キー（管理者コードが変更されても不変）

c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222
additionalFieldsstring

指定されたプロパティをレスポンスに追加

flow

打刻申請データ

打刻申請のデータを取得する。

レスポンス定義

  • year： 年

  • month： 月

  • requests： 打刻申請データ

    • date： 対象日
    • requestedDate： 申請日
    • employeeKey： 従業員識別キー（従業員コードが変更されても不変）
    • requestKey： 申請識別キー
    • applicant： 申請者
      • type： 種別（employee： 従業員　administrator： 管理者)
      • key： 識別キー（従業員 または 管理者）
    • status： 申請ステータス（applying 申請中　rejected： 棄却　approved： 承認）
    • currentFlow： 現在の承認フローレベル（１～５）
    • lastModifiedAdministratorKey： 最終更新管理者識別キー
    • message： 申請メッセージ
    • adminComment： 管理者コメント
    • requested： 申請内容
      • time： 打刻時刻
      • code： 打刻種別コード
      • name： 打刻種別名
      • divisionCode： 打刻所属コード
      • divisionName： 打刻所属名
      • isDelete： 削除申請か（true 削除　false： 新規、変更）
    • current： 現在の打刻
      • time： 打刻時刻
      • code： 打刻種別コード
      • name： 打刻種別名
      • divisionCode： 打刻所属コード
      • divisionName： 打刻所属名
      • credentialCode： 打刻認証コード

    additionalFields

    • flow： 承認フロー
      • level： 承認フローレベル（１～５）
      • administratorKeys： 管理者識別キー（管理者コードが変更されても不変）
GET https://api.kingtime.jp/v1.0/requests/timerecords/2018-08?administratorKey=c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222&additionalFields=flow
Responses200
Headers
Content-Type: application/json
Body
{
  "year": 2018,
  "month": 8,
  "requests": [
    {
      "date": "2018-08-01",
      "requestedDate": "2018-08-10",
      "employeeKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe2735215201",
      "requestKey": "59d25f49d4dce8b6e6658cc6b5c3b89b34c617916f90f6e27e9a9fa6cca576a4",
      "applicant": {
        "type": "employee",
        "key": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe2735215201"
      },
      "status": "applying",
      "currentFlow": 2,
      "flow": [
        {
          "level": 1,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff"
          ]
        },
        {
          "level": 2,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222"
          ]
        },
        {
          "level": 3,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac111"
          ]
        }
      ],
      "message": "申請いたします",
      "adminComment": "第1承認者承認済",
      "lastModifiedAdministratorKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff",
      "requested": {
        "time": "2018-08-01T08:00+09:00",
        "code": "1",
        "name": "出勤",
        "divisionCode": "1000",
        "divisionName": "本社",
        "isDelete": false
      },
      "current": {
        "time": "2018-08-01T09:00+09:00",
        "code": "1",
        "name": "出勤",
        "divisionCode": "1000",
        "divisionName": "本社",
        "credentialCode": 300
      }
    }
  ]
}

年月指定
GET/requests/timerecords/{date}{?administratorKey,additionalFields}

指定した年月の打刻申請データを取得する。

※対象企業が打刻申請を利用できない場合にはエラーとなります。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring○

詳細を取得したい年月
・過去日は最大3年前まで
・未来日は最大1年後まで

2018-08
administratorKeystring

管理者識別キー（管理者コードが変更されても不変）

c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222
additionalFieldsstring

指定されたプロパティをレスポンスに追加

flow

残業上限申請データ

残業上限申請の状況を取得する。

レスポンス定義

  • date： 対象日

  • requestedDate： 申請日

  • employeeKey： 従業員識別キー（従業員コードが変更されても不変）

  • requestKey： 申請識別キー

  • applicant： 申請者

    • type： 種別（employee： 従業員　administrator： 管理者)
    • key： 識別キー（従業員 または 管理者）

  • status： 申請ステータス（applying 申請中　rejected： 棄却　approved： 承認）

  • currentFlow： 現在の承認フローレベル（１～５）

  • lastModifiedAdministratorKey： 最終更新管理者識別キー

  • message： 申請メッセージ

  • adminComment： 管理者コメント

  • requested： 申請内容

    • overtimeUpperLimit： 残業上限時間（分）

  • current： 現在の内容

    • overtimeUpperLimit： 残業上限時間（分）

additionalFields

  • flow： 承認フロー
    • level： 承認フローレベル（１～５）
    • administratorKeys： 管理者識別キー（管理者コードが変更されても不変）
GET https://api.kingtime.jp/v1.0/requests/overtime-limits/2018-08?administratorKey=c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222&additionalFields=flow
Responses200
Headers
Content-Type: application/json
Body
{
  "year": 2018,
  "month": 8,
  "overtimeLimitsRequests": [
    {
      "date": "2018-08-01",
      "requestedDate": "2018-08-10",
      "employeeKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe2735215201",
      "requestKey": "59d25f49d4dce8b6e6658cc6b5c3b89b34c617916f90f6e27e9a9fa6cca576a4",
      "applicant": {
        "type": "employee",
        "key": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe2735215201"
      },
      "status": "applying",
      "currentFlow": 2,
      "flow": [
        {
          "level": 1,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff"
          ]
        },
        {
          "level": 2,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222"
          ]
        },
        {
          "level": 3,
          "administratorKeys": [
            "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac111"
          ]
        }
      ],
      "message": "申請いたします",
      "adminComment": "第1承認者承認済",
      "lastModifiedAdministratorKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff",
      "requested": {
        "overtimeUpperLimit": "180"
      },
      "current": {
        "overtimeUpperLimit": "0"
      }
    }
  ]
}

年月指定
GET/requests/overtime-limits/{date}{?administratorKey,additionalFields}

指定した年月の残業上限申請データを取得する。

※対象企業が残業上限申請を利用できない場合にはエラーとなります。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring○

詳細を取得したい年月
・過去日は最大3年前まで
・未来日は最大1年後まで

2018-08
administratorKeystring

管理者識別キー（管理者コードが変更されても不変）

c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222
additionalFieldsstring

指定されたプロパティをレスポンスに追加

flow

申請データ

承認・棄却データを更新する。

リクエスト定義

  • administratorKey：required 管理者識別キー

  • approve：required 処理（true： 承認　false： 棄却）

  • adminComment： 管理者コメント

レスポンス定義

  • requestKey： 申請識別キー

  • status： 申請ステータス（applying： 申請中　rejected： 棄却　approved： 承認）

  • currentFlow： 現在の承認フローレベル（１～５）

  • flow： 承認フロー

    • level： 承認フローレベル（１～５）
    • administratorKeys： 管理者識別キー（管理者コードが変更されても不変）

  • adminComment： 管理者コメント

  • lastModifiedAdministratorKey： 最終更新管理者識別キー

PUT https://api.kingtime.jp/v1.0/requests/59d25f49d4dce8b6e6658cc6b5c3b89b34c617916f90f6e27e9a9fa6cca576a4
Requestsexample 1
Headers
Content-Type: application/json
Body
{
  "administratorKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe27352152c4",
  "approve": true,
  "adminComment": "第1承認者承認済"
}
Responses200
Headers
Content-Type: application/json
Body
{
  "requestKey": "59d25f49d4dce8b6e6658cc6b5c3b89b34c617916f90f6e27e9a9fa6cca576a4",
  "status": "applying",
  "currentFlow": 2,
  "flow": [
    {
      "level": 1,
      "administratorKeys": [
        "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff"
      ]
    },
    {
      "level": 2,
      "administratorKeys": [
        "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac222"
      ]
    },
    {
      "level": 3,
      "administratorKeys": [
        "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac111"
      ]
    }
  ],
  "adminComment": "第1承認者承認済",
  "lastModifiedAdministratorKey": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe273526fac6ff"
}

承認・棄却
PUT/requests/{requestKey}

対象従業員の申請を承認または棄却する。

※管理者識別キーで指定した管理者が対象の申請の承認フローに存在しない、または承認レベルが異なる場合にはエラーとなります。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
requestKeystring○

対象の申請識別キー

59d25f49d4dce8b6e6658cc6b5c3b89b34c617916f90f6e27e9a9fa6cca576a4

Generated by aglio on 12 Jun 2024