コンテンツにスキップ

従業員取得

GET
/staffs/{staff_id}

従業員詳細を取得します

対象

  • プラン
    • スタンダード、旧無料
    • プレミアム
    • プレミアムプラス
    • エンタープライズ、旧有料

対象ユーザー権限

  • 従業員管理閲覧(全て)
staff_id
required
string

従業員ID

Example
1

取得成功

object
staffId

従業員ID

string
staffName

従業員名

string
>= 1 characters <= 50 characters
staffKana

フリガナ

string
>= 1 characters <= 50 characters
staffCode

社員番号

string
0 <= 255 characters
initial

イニシャル(カナ1文字)
(アカサタナハマヤラワ A-Z -)

string
>= 1 characters <= 1 characters
gender

性別

  • 0: 男性
  • 1: 女性
  • 9: 未選択
string
Allowed values: 0 1 9
birthday

生年月日 [YYYY-MM-DD]

string
0
postCode

郵便番号

string
0 <= 10 characters
address

住所

string
0 <= 200 characters
phone

電話番号

string
0 <= 20 characters
mail

メールアドレス

string
0 <= 255 characters
hireDate

入社日 [YYYY-MM-DD]

string
0
terminationDate

退職日 [YYYY-MM-DD]

string
0
terminationFlag

退職済みかどうか

  • 0: 未退職
  • 1: 退職済み
string
Allowed values: 0 1
terminationReason

退職事由(労働者名簿の必須記載事項)

string
0 <= 100 characters
retirementIncome

退職所得(円)

integer
activeFlag

利用可能なユーザーかどうか

  • 0: 利用不可
  • 1: 利用可能
string
Allowed values: 0 1
adminFlag

管理者権限の有無

  • 0: 一般
  • 1: 管理者
string
Allowed values: 0 1
estimateIncome

合計所得見積額(円)

string
foreignerFlag

外国人に該当するかどうか

  • 0: 該当しない
  • 1: 該当する
string
Allowed values: 0 1
handicappedDivision

障害者に該当するかどうか

  • 1: 該当しない
  • 2: 一般障害者
  • 3: 特別障害者
string
Allowed values: 1 2 3
studentFlag

勤労学生に該当するかどうか

  • 0: 該当しない
  • 1: 該当する
string
Allowed values: 0 1
paidHolidayInitialTargetDate

有給休暇付与基準日(通常は入社半年後)[YYYY-MM-DD]

string
0
displaySequence

表示順

string
0
employeeClassificationId

従業員区分ID

string
dashboardType

ログイン直後の画面

  • 0: 従業員トップ
  • 1: 管理者トップ
integer
Allowed values: 0 1
roleInEmployeeList

従事する業務の種類

string
0 <= 100 characters
career

履歴 改行を含む

string
0 <= 2000 characters
householdHeaderName

世帯主

string
0 <= 32 characters
householdHeaderRelationship

世帯主との続柄

  • 0: 本人
  • 1: 配偶者
  • 2: 息子
  • 3: 娘
  • 4: 父
  • 5: 母
  • 6: 兄
  • 7: 姉
  • 8: 弟
  • 9: 妹
  • 10: 祖父
  • 11: 祖母
  • 12: 孫
  • 13: 義父
  • 14: 義母
  • 99: その他
integer
nullable
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 99
spouseFlag

配偶者の有無

boolean
widowDivision

(旧)寡婦/寡夫 2019年以前の源泉徴収票の登録項目

  • 1: 該当しない
  • 2: 一般の寡婦
  • 3: 特別の寡婦
  • 4: 寡夫
integer
Allowed values: 1 2 3 4
widowDivision2

寡婦/ひとり親 2020年以降の源泉徴収票の登録項目

  • 1: 該当しない
  • 2: 寡婦
  • 3: ひとり親
integer
Allowed values: 1 2 3
passCode

出退勤パスコード 数字4桁

string
nullable >= 4 characters <= 4 characters
stampScreenDisplayFlag

出退勤画面への表示フラグ

boolean
personalWebStampScreenDisplayFlag

個別WEB出退勤画面表示フラグ

boolean
personalWebStatementScreenDisplayFlag

給与明細個別表示フラグ

boolean
maximumAnnualSalary

年収目安(円)

integer
nullable
socialInsuranceStaffCode

被保険者整理番号

integer
nullable >= 1 <= 999999999
applyOver70WelfareInsuranceFlag

70歳以上での厚生年金の適用フラグ

boolean
socialInsuranceDivision

社会保険区分(従業員の職業) ※厚生年金保険の計算時に使用します。

  • 1: 一般
  • 2: 坑内員・船員 社会保険を適用しない設定の場合はnull
integer
nullable
Allowed values: 1 2
specificInsurerFlag

特定被保険者フラグ

boolean
memo

備考 改行を含む

string
0 <= 1000 characters
adminMemo

管理者メモ 改行を含む

string
0 <= 1000 characters
staffStore

所属事業所

Array<object>
unique items
object
storeId

事業所ID

string
roleId

役割ID

string
roleName

役割名

string
>= 1 characters <= 20 characters
applicationDisplayFlag

アプリ表示設定

boolean
mailFlag

事業所からのメール

boolean
staffGroup

従業員グループ

Array<object>
unique items
object
code

従業員グループコード

string
name

従業員グループ名

string
>= 1 characters <= 255 characters
positions

役職一覧

Array<object>
unique items

役職

object
positionId

役職ID

string
positionName

役職名

string
>= 1 characters <= 32 characters
prescribedWorkTimes

所定労働時間

Array<object>
unique items
object
prescribedWorkTimeId

所定労働時間ID

string
applicationYm

適用開始年月[YYYY-MM] 初期設定の場合はnull

string
nullable
prescribedWorkDayMonthly

1ヶ月の平均所定労働日数

integer
prescribedWorkTimeDaily

1日の所定労働時間(分)

integer
prescribedWorkTimeMonthly

1ヶ月の平均所定労働時間(分)

integer
holidayWeekSettings

週休日設定 全曜日の7件もしくは未登録の0件

Array<object>
unique items
object
holidayDivision

休日区分

  • 0: 通常勤務
  • 1: 所定休日
  • 2: 法定休日
integer
Allowed values: 0 1 2
weekDay

曜日

  • 0: 日
  • 1: 月
  • 2: 火
  • 3: 水
  • 4: 木
  • 5: 金
  • 6: 土
integer
Allowed values: 0 1 2 3 4 5 6
wageApply

賃金設定

Array<object>
unique items
object
storeId

事業所ID

string
0
businessHourId

営業時間帯ID

string
0
division

給与形態区分

  • 0: 時給
  • 1: 日給
  • 2: 月給
  • 3: 時給(営業時間帯別時給)
string
Allowed values: 0 1 2 3
effectiveDate

適用開始時期 [YYYY-MM-DD]

string format: date
wage

賃金

string
holidayWage

休日賃金

string
fixedOvertimeWageFlag

固定残業代を適用するかどうか

  • 0: 適用しない
  • 1: 適用する
string
Allowed values: 0 1
fixedOvertimeWage

固定残業代

string
fixedWageStatutoryOvertimeFlag

固定残業代に法定内残業を含めるかどうか

  • 0: 法定内残業を含めない
  • 1: 法定内残業を含める
string
Allowed values: 0 1
fixedWageMidnightFlag

固定残業代に深夜労働を含めるかどうか

  • 0: 深夜労働を含めない
  • 1: 深夜労働を含める
string
Allowed values: 0 1
fixedWagePrescribedHolidayFlag

固定残業代に所定休日労働を含めるかどうか

  • 0: 所定休日労働を含めない
  • 1: 所定休日労働を含める
string
Allowed values: 0 1
fixedWageStatutoryHolidayFlag

固定残業代に法定休日労働を含めるかどうか

  • 0: 法定休日労働を含めない
  • 1: 法定休日労働を含める
string
Allowed values: 0 1
fixedWageMonth45HourOvertimeFlag

固定残業代に45時間超時間外労働を含めるかどうか

  • 0: 月45時間超 時間外労働を含めない
  • 1: 月45時間超 時間外労働を含める
string
Allowed values: 0 1
fixedWageMonth60HourOvertimeFlag

固定残業代に60時間超時間外労働を含めるかどうか

  • 0: 月60時間超 時間外労働を含めない
  • 1: 月60時間超 時間外労働を含める
string
Allowed values: 0 1
autoAllowance

手当の自動付与設定

Array<object>
unique items
object
paymentDivision

支給区分

  • 0: 支給
  • 1: 控除
string
Allowed values: 0 1
label

手当名

string
division

区分

  • 0: 勤務ごと
  • 1: 月額
  • 2: 休憩ごと
string
Allowed values: 0 1 2
amount

金額

string
fromDate

適用開始時期 [YYYY-MM-DD]

string format: date
toDate

適用終了時期 [YYYY-MM-DD]

string
0
storeId

対象事業所ID(0: 全事業所)

string
wageFlag

雇用保険の計算対象とするかどうか

  • 0: 対象外
  • 1: 対象
string
Allowed values: 0 1
taxable

課税とするかどうか

  • 0: 非課税の支給/支給額合計から差し引く控除
  • 1: 課税の支給/一般的な控除
string
Allowed values: 0 1
extraPayFlag

割増計算に含めるかどうか

  • 0: 割増計算に含めない
  • 1: 割増計算に含める
string
Allowed values: 0 1
transportationCostApply

交通費設定

Array<object>
unique items
object
storeId

事業所ID

string
0
division

交通費支給形態

  • 0: 勤務回数ごと
  • 1: 月額
  • 2: 勤務日数ごと
string
Allowed values: 0 1 2
effectiveDate

適用開始時期 [YYYY-MM-DD]

string format: date
transportationCost

交通費

string
transportationCostLimit

交通費上限

integer
nullable <= 999999999
transportationCostLimitByStore

交通費上限(事業所ごと)

integer
nullable <= 999999999
standardRemunerationMonthlies

標準報酬月額

Array<object>
unique items
object
storeId

保険資格取得事業所ID

string
applicationYm

適用開始月 [YYYY-MM]

string
healthInsuranceValue

健康保険・介護保険の標準報酬月額

integer
welfareInsuranceValue

厚生年金の標準報酬月額

integer
employmentInsurances

雇用保険

Array<object>
unique items
object
storeId

保険資格取得事業所ID

string
applicationYm

適用開始月 [YYYY-MM]

string
withholdingIncomeTaxes

源泉所得税

Array<object>
unique items
object
type

源泉徴収税額表欄の区分

  • 1: 甲
  • 2: 乙
integer
Allowed values: 1 2
spouseDeductionDivision

源泉控除対象配偶者区分

  • 0: 対象でない
  • 1: 源泉控除対象(配偶者控除対象)
  • 2: 源泉控除対象(配偶者特別控除対象)
integer
Allowed values: 0 1 2
dependent

控除対象扶養親族の人数

integer
applicationYm

適用開始月 [YYYY-MM]

string
residenceTaxes

住民税

Array<object>
unique items
object
localGovernmentCode

市町村コード 0から始まる場合がある

string
residenceTaxAdjustmentsValue

6月の税額

integer
residenceTaxAverageValue

7月以降の税額 residenceTaxMonthValuesとどちらか一方が必ず存在し、他方は必ずnullとなる。

integer
nullable
residenceTaxMonthValues

7月以降の各月の税額

Array<object>
nullable unique items

7月以降の各月の税額

object
month

対象の月 1〜5月は翌年の月

integer
>= 1 <= 12
taxValue

税額

integer
applicationYm

適用開始月 [YYYY-MM]

string
dependents

扶養親族

Array<object>
unique items
object
name

名前

string
>= 1 characters <= 50 characters
kana

フリガナ

string
>= 1 characters <= 50 characters
initial

イニシャル(カナ1文字)
(アカサタナハマヤラワ A-Z -)

string
>= 1 characters <= 1 characters
relationship

続柄

  • 1: 配偶者
  • 2: 息子
  • 3: 娘
  • 4: 父
  • 5: 母
  • 6: 兄
  • 7: 姉
  • 8: 弟
  • 9: 妹
  • 10: 祖父
  • 11: 祖母
  • 12: 孫
  • 13: 義父
  • 14: 義母
  • 99: その他
integer
Allowed values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 99
birthday

生年月日 [YYYY-MM-DD]

string format: date
nullable
postCode

郵便番号

string
0 <= 10 characters
address

住所

string
0 <= 200 characters
estimateIncome

合計所得見積額(円)

integer
retirementIncome

退職所得(円)

integer
handicappedDivision

障害者に該当するかどうか

  • 1: 該当しない
  • 2: 一般障害者
  • 3: 特別障害者
integer
Allowed values: 1 2 3
livingTogetherDivision

同居区分

  • 1: 同居
  • 2: 別居(国内)
  • 3: 別居(海外)
integer
Allowed values: 1 2 3
isInternationalStudent

留学生かどうか

boolean
totalForeignTransfer

海外送金額(円)

integer
nullable
Example
{
"staffId": "1",
"staffName": "スマレジ太郎",
"staffKana": "スマレジタロウ",
"staffCode": "xx1",
"initial": "",
"gender": "0",
"birthday": "1990-01-01",
"postCode": "111-1111",
"address": "大阪府大阪市中央区本町",
"phone": "00-0000-0000",
"mail": "taro@example.jp",
"hireDate": "2020-01-01",
"terminationDate": "2020-07-01",
"terminationFlag": "1",
"terminationReason": "一身上の都合",
"retirementIncome": 0,
"activeFlag": "1",
"adminFlag": "1",
"estimateIncome": "3000000",
"foreignerFlag": "0",
"handicappedDivision": "1",
"studentFlag": "0",
"paidHolidayInitialTargetDate": "2020-07-01",
"displaySequence": "1",
"employeeClassificationId": "1",
"dashboardType": 1,
"roleInEmployeeList": "経理",
"career": "履歴。\n異動や配置換えの記録など。\n",
"householdHeaderName": "スマレジ太郎",
"householdHeaderRelationship": 0,
"spouseFlag": true,
"widowDivision": 1,
"widowDivision2": 1,
"passCode": "1234",
"stampScreenDisplayFlag": true,
"personalWebStampScreenDisplayFlag": true,
"personalWebStatementScreenDisplayFlag": true,
"maximumAnnualSalary": 4000000,
"socialInsuranceStaffCode": 123,
"applyOver70WelfareInsuranceFlag": false,
"socialInsuranceDivision": 1,
"specificInsurerFlag": false,
"memo": "備考。\n自由入力欄。\n",
"adminMemo": "管理者メモ。\nシステム管理者のみ閲覧可能な自由入力欄。\n",
"staffStore": [
{
"storeId": "1",
"roleId": "1",
"roleName": "店長",
"applicationDisplayFlag": true,
"mailFlag": true
},
{
"storeId": "2",
"roleId": "2",
"roleName": "一般",
"applicationDisplayFlag": true,
"mailFlag": false
}
],
"staffGroup": [
{
"code": "1",
"name": "従業員グループA",
"positions": [
{
"positionId": "1",
"positionName": "部長"
}
]
},
{
"code": "2",
"name": "従業員グループB",
"positions": [
{
"positionId": "2",
"positionName": "課長"
}
]
}
],
"prescribedWorkTimes": [
{
"prescribedWorkTimeId": "1",
"applicationYm": null,
"prescribedWorkDayMonthly": 20,
"prescribedWorkTimeDaily": 480,
"prescribedWorkTimeMonthly": 9600
},
{
"prescribedWorkTimeId": "2",
"applicationYm": "2021-04",
"prescribedWorkDayMonthly": 22,
"prescribedWorkTimeDaily": 450,
"prescribedWorkTimeMonthly": 9900
}
],
"holidayWeekSettings": [
{
"holidayDivision": 2,
"weekDay": 0
},
{
"holidayDivision": 0,
"weekDay": 1
},
{
"holidayDivision": 0,
"weekDay": 2
},
{
"holidayDivision": 0,
"weekDay": 3
},
{
"holidayDivision": 0,
"weekDay": 4
},
{
"holidayDivision": 0,
"weekDay": 5
},
{
"holidayDivision": 1,
"weekDay": 6
}
],
"wageApply": [
{
"storeId": "",
"businessHourId": "",
"division": "0",
"effectiveDate": "1970-01-01",
"wage": "1200",
"holidayWage": "",
"fixedOvertimeWageFlag": "0",
"fixedOvertimeWage": "0",
"fixedWageStatutoryOvertimeFlag": "0",
"fixedWageMidnightFlag": "0",
"fixedWagePrescribedHolidayFlag": "0",
"fixedWageStatutoryHolidayFlag": "0",
"fixedWageMonth45HourOvertimeFlag": "0",
"fixedWageMonth60HourOvertimeFlag": "0"
},
{
"storeId": "",
"businessHourId": "",
"division": "2",
"effectiveDate": "2024-01-01",
"wage": "200000",
"holidayWage": "",
"fixedOvertimeWageFlag": "1",
"fixedOvertimeWage": "50000",
"fixedWageStatutoryOvertimeFlag": "1",
"fixedWageMidnightFlag": "1",
"fixedWagePrescribedHolidayFlag": "1",
"fixedWageStatutoryHolidayFlag": "1",
"fixedWageMonth45HourOvertimeFlag": "1",
"fixedWageMonth60HourOvertimeFlag": "1"
}
],
"autoAllowance": [
{
"paymentDivision": "0",
"label": "役職手当",
"division": "1",
"amount": "10000",
"fromDate": "2020-01-01",
"toDate": "2024-12-31",
"storeId": "0",
"wageFlag": "1",
"taxable": "1",
"extraPayFlag": "1"
}
],
"transportationCostApply": [
{
"storeId": "",
"division": "0",
"effectiveDate": "1970-01-01",
"transportationCost": "900",
"transportationCostLimit": 30000,
"transportationCostLimitByStore": null
},
{
"storeId": "1",
"division": "2",
"effectiveDate": "2020-01-01",
"transportationCost": "620",
"transportationCostLimit": 40000,
"transportationCostLimitByStore": null
},
{
"storeId": "2",
"division": "2",
"effectiveDate": "2020-01-01",
"transportationCost": "720",
"transportationCostLimit": 40000,
"transportationCostLimitByStore": 30000
}
],
"standardRemunerationMonthlies": [
{
"storeId": "1",
"applicationYm": "2020-01",
"healthInsuranceValue": 58000,
"welfareInsuranceValue": 58000
},
{
"storeId": "2",
"applicationYm": "2024-01",
"healthInsuranceValue": 68000,
"welfareInsuranceValue": 88000
}
],
"employmentInsurances": [
{
"storeId": "1",
"applicationYm": "2020-01"
},
{
"storeId": "2",
"applicationYm": "2024-04"
}
],
"withholdingIncomeTaxes": [
{
"type": 1,
"spouseDeductionDivision": 0,
"dependent": 0,
"applicationYm": "2020-01"
},
{
"type": 1,
"spouseDeductionDivision": 1,
"dependent": 2,
"applicationYm": "2025-01"
}
],
"residenceTaxes": [
{
"localGovernmentCode": "271004",
"residenceTaxAdjustmentsValue": 15000,
"residenceTaxAverageValue": 12000,
"residenceTaxMonthValues": null,
"applicationYm": "2023-06"
},
{
"localGovernmentCode": "271004",
"residenceTaxAdjustmentsValue": 500,
"residenceTaxAverageValue": null,
"residenceTaxMonthValues": [
{
"month": 7,
"taxValue": 1007
},
{
"month": 8,
"taxValue": 1008
},
{
"month": 9,
"taxValue": 1009
},
{
"month": 10,
"taxValue": 1010
},
{
"month": 11,
"taxValue": 1011
},
{
"month": 12,
"taxValue": 1012
},
{
"month": 1,
"taxValue": 1001
},
{
"month": 2,
"taxValue": 1002
},
{
"month": 3,
"taxValue": 1003
},
{
"month": 4,
"taxValue": 1004
},
{
"month": 5,
"taxValue": 1005
}
],
"applicationYm": "2024-06"
}
],
"dependents": [
{
"name": "スマレジ花子",
"kana": "スマレジハナコ",
"initial": "",
"relationship": 1,
"birthday": "1992-05-15",
"postCode": "111-1111",
"address": "大阪府大阪市中央区本町",
"estimateIncome": 1000000,
"retirementIncome": 0,
"handicappedDivision": 1,
"livingTogetherDivision": 1,
"isInternationalStudent": false,
"totalForeignTransfer": null
},
{
"name": "スマレジ一郎",
"kana": "スマレジイチロウ",
"initial": "",
"relationship": 2,
"birthday": "2015-03-10",
"postCode": "111-1111",
"address": "大阪府大阪市中央区本町",
"estimateIncome": 0,
"retirementIncome": 0,
"handicappedDivision": 1,
"livingTogetherDivision": 1,
"isInternationalStudent": false,
"totalForeignTransfer": null
}
]
}
  • 指定したIDのデータが存在しない場合
object
type

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

string
title

エラーの概要

string
detail

エラーの詳細

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