従業員基本情報登録

POST

/staffs

• サンドボックス
• 本番

従業員基本情報を登録します。

activeFlag は登録時点の利用設定です。利用OFFで登録する場合のみ false を指定してください。 activeFlag が true の場合、従業員登録上限に達していると422を返します。

対象

• プラン
  • スタンダード
  • プレミアム
  • プレミアムプラス
  • エンタープライズ

対象ユーザー権限

• 従業員管理編集（全て）
• 従業員管理編集（給与情報除く）

Authorizations

• AppAccessToken
  timecard.staffs:write
• UserAccessToken
  timecard.staffs:write

Request Body ^required

object

staffName

required

従業員名

string

>= 1 characters <= 50 characters

staffKana

required

フリガナ（全角カナ）

string

>= 1 characters <= 50 characters

gender

性別

• 0: 男性
• 1: 女性
• 9: 未選択

string

default: 9

Allowed values: 0 1 9

birthday

生年月日 [YYYY-MM-DD]

string format: date

nullable

postCode

郵便番号

string

0 <= 10 characters

address

住所

string

0 <= 200 characters

phone

電話番号

string

0 <= 15 characters

employeeClassificationId

required

従業員区分ID

string

dashboardType

ログイン直後の画面

• 0: 従業員トップ
• 1: 管理者トップ

integer

0

Allowed values: 0 1

staffCode

社員番号

string

0 <= 255 characters

hireDate

入社日 [YYYY-MM-DD]

string format: date

terminationDate

退職日 [YYYY-MM-DD]

string format: date

nullable

terminationReason

退職事由

string

nullable 0 <= 100 characters

roleInEmployeeList

従事する業務の種類

string

nullable 0 <= 100 characters

career

履歴

string

nullable 0 <= 2000 characters

passCode

出退勤パスコード（半角数字4桁）

string

nullable /^[0-9]{4}$/

displaySequence

表示順

integer

nullable >= -99999999 <= 999999999

memo

備考

string

0 <= 1000 characters

adminMemo

管理者メモ

string

0 <= 1000 characters

activeFlag

利用設定

boolean

default: true

adminFlag

管理者権限の有無

boolean

foreignerFlag

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

boolean

stampScreenDisplayFlag

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

boolean

default: true

personalWebStampScreenDisplayFlag

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

boolean

Examples

最小構成で登録する例

{
  "staffName": "スマレジ太郎",
  "staffKana": "スマレジタロウ",
  "employeeClassificationId": "1"
}

全項目を指定して登録する例

{
  "staffName": "スマレジ太郎",
  "staffKana": "スマレジタロウ",
  "gender": "0",
  "birthday": "1990-01-01",
  "postCode": "111-1111",
  "address": "大阪府大阪市中央区本町",
  "phone": "00-0000-0000",
  "employeeClassificationId": "1",
  "dashboardType": 1,
  "staffCode": "EMP001",
  "hireDate": "2025-02-01",
  "terminationDate": null,
  "terminationReason": null,
  "roleInEmployeeList": "経理",
  "career": "店舗責任者経験あり",
  "passCode": "1234",
  "displaySequence": 1,
  "memo": "備考",
  "adminMemo": "管理者向けメモ",
  "activeFlag": true,
  "adminFlag": false,
  "foreignerFlag": false,
  "stampScreenDisplayFlag": true,
  "personalWebStampScreenDisplayFlag": true
}

Responses

201

登録成功

object

staffId

従業員ID

string

Example

{
  "staffId": "123"
}

400

• リクエスト形式が不正な場合
• 定義外の項目を送信した場合（例: mail）
• バリデーション・整合性チェックに失敗した場合

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "定義外の項目はこのAPIでは指定できません。（例: mail）"
}

422

activeFlag を true で指定し、従業員登録上限に達している場合

object

type

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

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Unprocessable Entity",
  "detail": "従業員登録上限に達しているため、利用ONで登録できません。"
}