利用申し込み

お問い合わせ

概要

このドキュメントでは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
        }
    ]
}

追加用のプロパティ

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

nullのプロパティ

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

Optionalのプロパティ

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

アクセストークン

KING OF TIMEのAPIを利用するには、アクセストークンをリクエストに含める必要があります。アクセストークンは、以下のようにAuthorizationリクエストヘッダに含めてください。 アクセストークンの発行をご希望の場合、本ページ右上の利用申し込みからお願いいたします。

Authorization: Bearer 8j9f7v4893y58rvt7nyfq2893n75tr78937n83

利用禁止時間帯

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

  • 8:30~10:00

  • 17:30~18:30

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

利用申込時に入力していただく連携希望項目とエンドポイントの対応を以下に示します。

連携希望項目 HTTPメソッド エンドポイント
従業員データ(読み取り) GET 従業員データ
所属データ
雇用区分データ
従業員データ(書き込み) POST/PUT/DELETE 従業員データ
日別勤怠データ(読み取り) GET 日別勤怠データ
日別打刻データ
日別費用データ
日別勤怠データ(書き込み) POST 日別打刻データ
月別勤怠データ(読み取り) GET 月別勤怠データ
月別費用データ
月別残休暇データ
月別勤怠データ(書き込み) - -
日別スケジュールデータ(読み取り) GET 日別スケジュールデータ
日別スケジュール費用データ
日別スケジュールデータ(書き込み) PUT/DELETE 日別スケジュールデータ
月別スケジュールデータ(読み取り) GET 月別スケジュール費用データ
月別スケジュールデータ(書き込み) - -

緯度、経度の形式

緯度、経度は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

従業員

従業員データ

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

リクエスト定義

  • divisionCode:required 所属コード

  • gender:required 性別(no_selected: 選択しない male: 男性 female: 女性)

  • typeCode:required 雇用区分コード

  • code:required 従業員コード

  • lastName:required

  • firstName:required

additionalFields

  • lastNamePhonetics: 姓(カナ)

  • firstNamePhonetics: 名(カナ)

  • hiredDate: 入社年月日

  • birthDate: 生年月日

  • resignationDate: 退職年月日

  • emailAddresses: メールアドレス

  • allDayRegardingWorkInMinute: 日の契約労働時間

レスポンス定義

  • divisionCode: 所属コード

  • divisionName: 所属名

  • gender: 性別(no_selected: 選択しない male: 男性 female: 女性)

  • typeCode: 雇用区分コード

  • typeName: 雇用区分名

  • code: 従業員コード

  • key: 従業員識別キー(従業員コードが変更されても不変)

  • lastName:

  • firstName:

additionalFields

  • lastNamePhonetics: 姓(カナ)

  • firstNamePhonetics: 名(カナ)

  • hiredDate: 入社年月日

  • birthDate: 生年月日

  • resignationDate: 退職年月日

  • emailAddresses: メールアドレス

  • allDayRegardingWorkInMinute: 日の契約労働時間

GET https://api.kingtime.jp/v1.0/employees?date=2016-10-10&division=1000&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"
    ]
  },
  {
    "divisionCode": "1000",
    "divisionName": "本社",
    "gender": "female",
    "typeCode": "1",
    "typeName": "正社員",
    "code": "2000",
    "lastName": "勤怠",
    "firstName": "花子",
    "key": "c77a34b32f5de30b6335d141ad714baf6713cd21ca98689efec9fe27352152c4",
    "emailAddresses": [
      "kintaihanako@h-t.co.jp"
    ]
  }
]

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

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

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring{当日}

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

2016-10-10
divisionstring

所属コード

1000
additionalFieldsstring

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

emailAddresses

GET https://api.kingtime.jp/v1.0/employees/1000?date=2016-10-10&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"
  ]
}

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

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

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeCodestring

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

1000
datestring{当日}

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

2016-10-10
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

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


勤怠

日別勤怠データ

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

レスポンス定義

  • 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: 日数 3: 数値)
    • calculationResult: 計算結果

additionalFields

  • currentDateEmployee 今日時点の従業員データ
    • divisionCode: 所属コード
    • divisionName: 所属名
    • gender: 性別(no_selected: 選択しない male: 男性 female: 女性)
    • typeCode: 雇用区分コード
    • typeName: 雇用区分名
    • code: 従業員コード
    • lastName:
    • firstName:
    • lastNamePhonetics: 姓(カナ)
    • firstNamePhonetics: 名(カナ)
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": "タロウ"
        },
        "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": 10
          },
          {
            "code": "dCus2",
            "name": "日別カスタム2",
            "calculationUnitCode": 2,
            "calculationResult": 1
          },
          {
            "code": "dCus3",
            "name": "日別カスタム3",
            "calculationUnitCode": 3,
            "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{当日}

取得したい期間の終了年月日
startendは同時に指定
・期間は最大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": "タロウ"
      },
      "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": 10
        },
        {
          "code": "dCus2",
          "name": "日別カスタム2",
          "calculationUnitCode": 2,
          "calculationResult": 1
        },
        {
          "code": "dCus3",
          "name": "日別カスタム3",
          "calculationUnitCode": 3,
          "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 打刻時間

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

    • 省略時は、KING OF TIMEの処理に従って打刻種別を決定します。
  • divisionCode: 打刻先所属コード

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

  • credentialCode: 打刻認証コード

  • credentialName: 打刻認証名

    • 打刻認証コード、打刻認証名を利用する場合、事前に登録が必要となります。(お問い合わせ先
  • latitude: 緯度

  • longitude: 経度

レスポンス定義

  • date: 日時

  • employeeKey: 従業員識別キー(従業員コードが変更されても不変)

  • timeRecord: 打刻

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

additionalFields

  • currentDateEmployee: 今日時点の従業員データ
    • divisionCode: 所属コード
    • divisionName: 所属名
    • gender: 性別(no_selected: 選択しない male: 男性 female: 女性)
    • typeCode: 雇用区分コード
    • typeName: 雇用区分名
    • code: 従業員コード
    • lastName:
    • firstName:
    • lastNamePhonetics: 姓(カナ)
    • firstNamePhonetics: 名(カナ)
POST https://api.kingtime.jp/v1.0/daily-workings/timerecord/8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3
Requestsexample 1example 2
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "time": "2016-05-01T09:00:00+09:00",
  "divisionCode": "1000",
  "credentialCode": 300,
  "latitude": 35.6672237,
  "longitude": 139.7422207
}
Responses201
Headers
Content-Type: application/json
Body
{
  "date": "2016-05-01",
  "time": "2016-05-01T09:00:00+09:00",
  "code": 1,
  "divisionCode": "1000",
  "credentialCode": 300,
  "credentialName": "KOTSL",
  "latitude": 35.6672237,
  "longitude": 139.7422207
}
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",
  "time": "2016-05-01T09:00:00+09:00",
  "code": 1,
  "divisionCode": "1000"
}

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

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

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeKeystring

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

8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3

GET https://api.kingtime.jp/v1.0/daily-workings/timerecord?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": "タロウ"
        },
        "timeRecord": [
          {
            "time": "2016-05-01T09:00:00+09:00",
            "code": 1,
            "name": "出勤",
            "divisionCode": "1000",
            "divisionName": "本社",
            "latitude": 35.6672237,
            "longitude": 139.7422207
          },
          {
            "time": "2015-05-01T18:00:00+09:00",
            "code": 2,
            "name": "退勤",
            "divisionCode": "1000",
            "divisionName": "本社",
            "credentialCode": 300,
            "credentialName": "KOTSL",
            "latitude": 35.6672237,
            "longitude": 139.7422207
          },
          {
            "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{?division,ondivision,start,end,additionalFields}

日別打刻データの一覧を取得する。

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
divisionstring

所属コード

1000
ondivisionbooleantrue

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

true
startstring{当日}

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

2016-05-01
endstring{当日}

取得したい期間の終了年月日
startendは同時に指定
・期間は最大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": "タロウ"
      },
      "timeRecord": [
        {
          "time": "2016-05-01T09:00:00+09:00",
          "code": 1,
          "name": "出勤",
          "divisionCode": "1000",
          "divisionName": "本社",
          "latitude": 35.6672237,
          "longitude": 139.7422207
        },
        {
          "time": "2015-05-01T18:00:00+09:00",
          "code": 2,
          "name": "退勤",
          "divisionCode": "1000",
          "divisionName": "本社",
          "credentialCode": 300,
          "credentialName": "KOTSL",
          "latitude": 35.6672237,
          "longitude": 139.7422207
        },
        {
          "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: 名(カナ)
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": "タロウ"
        },
        "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{当日}

取得したい期間の終了年月日
startendは同時に指定
・期間は最大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": "タロウ"
      },
      "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: 総勤務日数

  • weekdayWorkingdayCount: 平日勤務日数

  • absentdayCount: 欠勤日数

  • holidaysObtained: 休暇取得

    • dayCount: 休暇取得日数
    • minutes: 時間休暇取得時間(分)
    • code: 休暇種別コード(1 または 2 の休暇はデフォルトで設定されている休暇)
    • name: 休暇種別名
  • assigned: 所定時間(分)

  • unassigned: 所定外時間(分)

  • overtime: 残業時間(分)

  • night: 深夜労働時間(分)

  • nightUnassigned: 深夜所定外時間(分)

  • nightOvertime: 深夜残業時間(分)

  • breakSum: 休憩時間(分)

  • late: 遅刻時間(分)

  • earlyLeave: 早退時間(分)

  • holidayWork: 休日労働

    • normal: 所定労働時間(分)
    • night: 深夜労働時間(分)
    • overtime: 残業時間(分)
    • nightOvertime: 深夜残業時間(分)
    • extra: 所定外時間(分)
    • nightExtra: 深夜所定外時間(分)
  • premiumWork: 割増労働

    • overtime1: 残業時間1(分)
    • nightOvertime1: 深夜残業時間1(分)
    • overtime2: 残業時間2(分)
    • nightOvertime2: 深夜残業時間2(分)
  • legalHolidayWork: 法定休日労働

    • normal: 所定労働時間(分)
    • night: 深夜労働時間(分)
    • overtime: 残業時間(分)
    • nightOvertime: 深夜残業時間(分)
    • extra: 所定外時間(分)
    • nightExtra: 深夜所定外時間(分)
    • count: 勤務回数
    • dayCount: 勤務日数
  • generalHolidayWork: 法定外休日労働

    • normal: 所定労働時間(分)
    • night: 深夜労働時間(分)
    • overtime: 残業時間(分)
    • nightOvertime: 深夜残業時間(分)
    • extra: 所定外時間(分)
    • nightExtra: 深夜所定外時間(分)
    • count: 勤務回数
    • dayCount: 勤務日数
  • bind: 拘束時間(分)

  • regarding: 休暇みなし時間(分)

  • isClose: 締め状況

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

    • code: 月別カスタム表示コード
    • name: 月別カスタム表示名
    • calculationUnitCode: 計算単位コード
    • calculationUnitName: 計算単位名
    • calculationResult: 計算結果
  • intervalShortageCount: インターバル不足回数

additionalFields

  • variationalWork: 変形労働

    • monthlyOvertime: 月の残業時間(分)
    • monthlyNightOvertime: 月の深夜残業時間(分)
    • weeklyOvertime: 週の残業時間(分)
    • weeklyNightOvertime: 週の深夜残業時間(分)
  • isConfirmation: 確認状況

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

    • divisionCode: 所属コード
    • divisionName: 所属名
    • gender: 性別(no_selected: 選択しない male: 男性 female: 女性)
    • typeCode: 雇用区分コード
    • typeName: 雇用区分名
    • code: 従業員コード
    • lastName:
    • firstName:
    • lastNamePhonetics: 姓(カナ)
    • firstNamePhonetics: 名(カナ)
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": "タロウ"
    },
    "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": 10
      },
      {
        "code": "mCus2",
        "name": "月別カスタム2",
        "calculationUnitCode": 2,
        "calculationUnitName": "日",
        "calculationResult": 1
      },
      {
        "code": "mCus3",
        "name": "月別カスタム3",
        "calculationUnitCode": 3,
        "calculationUnitName": "数値",
        "calculationResult": 100
      }
    ],
    "intervalShortageCount": 1
  }
]

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

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

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring{当月}

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

2016-06
divisionstring

所属コード

1000
additionalFieldsstring

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

currentDateEmployee

月別費用データ

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

レスポンス定義

  • date: 日時

  • employeeKey: 従業員識別キー(従業員コードが変更されても不変)

  • laborCostEstimate 人件費概算

  • transportationExpense 交通費

additionalFields

  • currentDateEmployee: 今日時点の従業員データ
    • divisionCode: 所属コード
    • divisionName: 所属名
    • gender: 性別(no_selected: 選択しない male: 男性 female: 女性)
    • typeCode: 雇用区分コード
    • typeName: 雇用区分名
    • code: 従業員コード
    • lastName:
    • firstName:
    • lastNamePhonetics: 姓(カナ)
    • firstNamePhonetics: 名(カナ)
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": "タロウ"
    },
    "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: 名(カナ)
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": "タロウ"
    },
    "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

日別スケジュールデータ

リクエスト定義

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

  • clockInSchedule: 出勤予定時間

  • clockOutSchedule: 退勤予定時間

  • workFixedStart: 勤務開始刻限

  • workFixedEnd: 勤務終了刻限

  • startEndBreakSchedule: 休憩開始終了予定

    • start: 休憩開始予定
    • end: 休憩終了予定
  • 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: 名(カナ)
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"
    }
  ],
  "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": {
        "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}

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

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
employeeKeystring

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

8b6ee646a9620b286499c3df6918c4888a97dd7bbc6a26a18743f4697a1de4b3
datestring

登録・更新したい年月日

2016-05-01

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

削除
DELETE/daily-schedules/{employeeKey}/{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",
        "employee": {
          "divisionCode": "1000",
          "divisionName": "本社",
          "gender": "male",
          "typeCode": "1",
          "typeName": "正社員",
          "code": "1000",
          "lastName": "勤怠",
          "firstName": "太郎",
          "lastNamePhonetics": "キンタイ",
          "firstNamePhonetics": "タロウ"
        },
        "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{本日日付}

取得したい期間の終了日
startendは同時に指定する
・期間は最大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",
      "employee": {
        "divisionCode": "1000",
        "divisionName": "本社",
        "gender": "male",
        "typeCode": "1",
        "typeName": "正社員",
        "code": "1000",
        "lastName": "勤怠",
        "firstName": "太郎",
        "lastNamePhonetics": "キンタイ",
        "firstNamePhonetics": "タロウ"
      },
      "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: 名(カナ)
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": "タロウ"
        },
        "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{当日}

取得したい期間の終了年月日
startendは同時に指定
・期間は最大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": "タロウ"
      },
      "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: 名(カナ)
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": "タロウ"
    },
    "laborCostEstimate": 200000,
    "transportationExpense": 20000
  }
]

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

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

URI Parameters
PropertyTypeRequiredDefaultDescriptionExample
datestring{当月}

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

2016-06
divisionstring

所属コード

1000
additionalFieldsstring

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

currentDateEmployee

Generated by aglio on 15 Oct 2018