SmartHR
概要
SmartHRは、株式会社SmartHRが提供する人事労務手続きのDXを推進するクラウド型人事労務ソフトです。
従業員情報の管理、入退社手続き、年末調整、労務手続きの電子申請などの人事業務をオンラインで効率化するサービスです。
サービス仕様
SmartHRでは従業員という概念でメンバーを管理します。他にもSmartHRにはアカウントという概念も存在しますが、2025年8月時点のYESODでは従業員が唯一の管理対象です。
従業員とは
従業員情報は［従業員リスト］で管理される従業員の情報です。 参照：従業員情報とアカウントの違い｜SmartHR
アカウントとは
アカウントは、SmartHRにログインして、サービスを利用するための権利のことです。 参照 :
コネクタ仕様
業務アセットの作成
アクセストークンの発行方法
公式ドキュメントをご確認ください
アクセストークンには有効期限はありませんが、発行後に一度しか表示されませんので必ず記録してください。紛失した場合は新たに発行してください。
YESODでの業務アセットの作成
- 事前にSmartHRのサブドメインをメモしてください。
- 業務アセット>SmartHRでサブドメインと環境に対応するドメインを選択してください
- メモしたアクセストークンを貼り付けてください
アカウント管理
YESODのアカウントはSmartHRの従業員に相当します。
パスワードの設定
パスワードの作成は対応していません。
SmartHRのAPIではパスワードを設定することができないため、アカウント作成後にSmartHR側からユーザーにメールが送信され、そこからユーザー自身が設定する方式になります。
アカウントの作成
アカウント作成タスクを実行するとき、YESOD から SmartHR に一意の識別子として「メールアドレス」または「社員番号」を渡します。
識別子が SmartHR 側にすでに登録されているかどうかによって挙動が変わります。
| 状況 | 結果 |
|---|---|
| 同一の識別子を持つ従業員がSmartHRに存在しない | 従業員を新規作成する |
| 同一の識別子を持つ在籍中の従業員がSmartHRに存在する | 従業員の情報を更新する |
| 同一の識別子を持つ退職済みの従業員がSmartHRに存在する | 退職日を空にして、在籍状況を「在籍中」にして、情報を更新する |
- アカウント作成時に、SmartHR上に同一の識別子を持つ従業員が複数存在する場合、在職中と退職済みが混在していれば在職中の従業員情報の更新が優先されます。
- すべての従業員が同一の在籍状況である場合は、どの従業員情報が更新対象となるかは取得順に依存します。
- その順序に関する明確な定義はありません。
- 新規作成時は、YESOD側の在籍状況の設定値に関係なく必ず「在籍中」として作成されます。
アカウントの削除
従業員の在籍状況を「退職済み」にします。
YESODで同期する項目の に値が設定されているメンバーは、在籍状況を「退職済み」にしたうえで、SmartHRの「退職年月日」にその値が設定されます。
従業員を完全に削除したい場合はSmartHRの従業員情報画面から直接削除してください。
削除タスクを前倒し実行した場合、SmartHR側では削除タスクを実行した時点で在籍状況が「退職済み」に変わります。YESOD側との在籍状況に差が生じるので注意が必要です。
割当種別
対応していません。
同期する項目
| 必須 | 属性名 | key | デフォルト値 | 型 | 備考 | |
|---|---|---|---|---|---|---|
| ユーザーID | - | ユーザアカウントとの紐付けに使用する項目です | ||||
| 事業所ID | - | |||||
| △ | 社員番号 | - | 社員番号もしくはメールアドレスのいずれかが必須項目です。 | |||
| 雇用形態 | - | SmartHRのAPIでは、下記の7種類＋カスタム値しか受け付けません。
・board_member（役員）
・full_timer（正社員）
・contract_worker（契約社員）
・permatemp（派遣社員）
・part_timer（アルバイト・パート）
・outsourcing_contractor（業務委託）
・etc（その他）
YESOD側の雇用形態を属性式でマッピングさせます。
属性式の例： 追加が必要な場合は、最後のetcに落ちる前に1行追加してください。 例：「特別顧問」を役員扱いにする場合： 参考： | ||||
| ○ | 姓 | |||||
| ○ | 名 | |||||
| ○ | 姓（カタカナ） | カタカナのみ許可 | ||||
| ○ | 名（カタカナ） | カタカナのみ許可 | ||||
| ビジネスネーム：姓 | - | |||||
| ビジネスネーム：名 | - | |||||
| ビジネスネーム：姓（カタカナ） | - | カタカナのみ許可 | ||||
| ビジネスネーム：名（カタカナ） | - | カタカナのみ許可 | ||||
| 生年月日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| ○ | 戸籍上の性別 | 使用できる値：male, female | ||||
| 電話番号 | - | 個人電話番号 | ||||
| 現住所の国コード | - | |||||
| 現住所の郵便番号 | - | |||||
| 現住所の都道府県 | - | |||||
| △ | 現住所の市区町村 | - | addressが存在する場合は必須 | |||
| 現住所の丁目・番地 | - | |||||
| 現住所の建物名・部屋番号 | - | |||||
| 現住所のヨミガナ | - | |||||
| 世帯主 | - | |||||
| 世帯主の続柄 | - | |||||
| △ | メールアドレス | 社員番号もしくはメールアドレスのいずれかが必須項目です。 | ||||
| 緊急連絡先の続柄 | - | |||||
| 緊急連絡先の姓 | - | |||||
| 緊急連絡先の名 | - | |||||
| 緊急連絡先の姓（カタカナ） | - | カタカナのみ許可 | ||||
| 緊急連絡先の名（カタカナ） | - | カタカナのみ許可 | ||||
| 緊急連絡先の電話番号 | - | |||||
| 緊急連絡先住所の国コード | - | |||||
| 緊急連絡先住所の郵便番号 | - | |||||
| 緊急連絡先住所の都道府県 | - | |||||
| △ | 緊急連絡先住所の市区町村 | - | emergency_addressが存在する場合は必須 | |||
| 緊急連絡先住所の丁目・番地 | - | |||||
| 緊急連絡先住所の建物名・部屋番号 | - | |||||
| 緊急連絡先住所のヨミガナ | - | |||||
| 住民票住所の国コード | - | |||||
| 住民票住所の郵便番号 | - | |||||
| 住民票住所の都道府県 | - | |||||
| △ | 住民票住所の市区町村 | - | resident_card_addressが存在する場合は必須 | |||
| 住民票住所の丁目・番地 | - | |||||
| 住民票住所の建物名・部屋番号 | - | |||||
| 住民票住所のヨミガナ | - | |||||
| 住民票住所の世帯主 | - | |||||
| 続柄（住民票住所の世帯主） | - | |||||
| 役職 | - | |||||
| 役職名リスト | - | 0個以上の役職名配列 | ||||
| 等級名 | - | |||||
| 職種名 | - | |||||
| 業務内容 | - | |||||
| 入社年月日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 退職年月日 | - | 形式の文字列を指定してください。マッピングが設定されていない場合、削除タスクを実行してもSmartHR側に退職日が設定されることはありません。
以下の属性式を使い、どの会社の退職日を反映させるかを利用者に指定してもらう運用を想定しています。 | ||||
| 退職事由 | - | |||||
| 雇用保険の被保険者番号 | - | |||||
| 雇用保険の被保険者番号がない場合の理由 | - | 使用できる値：no_work_experience, never_joined, unknown | ||||
| 雇用保険の資格取得年月日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 雇用保険の資格喪失年月日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 雇用保険に加入していた会社名 | - | |||||
| 雇用保険に加入していた会社の在籍開始日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 雇用保険に加入していた会社の在籍終了日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 厚生年金保険の被保険者整理番号 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 健康保険の被保険者整理番号 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 基礎年金番号 | - | |||||
| 厚生年金初加入フラグ | - | |||||
| 基礎年金番号が不明な場合の理由 | - | 使用できる値：non_pensionable, unknown | ||||
| 最初に厚生年金へ加入した会社名 | - | |||||
| 最初に厚生年金へ加入した会社の住所文字列 | - | |||||
| 最初に厚生年金へ加入した会社の在籍開始日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 最初に厚生年金へ加入した会社の在籍終了日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 最後に厚生年金へ加入した会社名 | - | |||||
| 最後に厚生年金へ加入した会社の住所文字列 | - | |||||
| 最後に厚生年金へ加入した会社の在籍開始日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 最後に厚生年金へ加入した会社の在籍終了日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 社会保険の資格取得年月日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 社会保険の資格喪失年月日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 配偶者の有無 | - | |||||
| 配偶者の年収 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 報酬月額（通貨） | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 報酬月額（現物） | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 基本給（月給） | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 標準報酬月額の改定年月 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 健康保険の標準報酬月額 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 厚生年金の標準報酬月額 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 通勤経路 | - | |||||
| 通勤手当1の定期券代 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 通勤手当1の期間 | - | 使用できる値：commutation_period_1_month, commutation_period_3_month, commutation_period_6_month | ||||
| 通勤手当1の片道運賃 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 通勤手当2の定期券代 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 通勤手当2の期間 | - | 使用できる値：commutation_period_1_month, commutation_period_3_month, commutation_period_6_month | ||||
| 通勤手当2の片道運賃 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 在留資格情報：姓 | - | |||||
| 在留資格情報：名 | - | |||||
| 在留資格情報：ミドルネーム | - | |||||
| 在留カード番号 | - | |||||
| 国籍 / 国籍コード | - | |||||
| 在留資格 | - | |||||
| 在留資格不明理由 | - | |||||
| 在留期日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 資格外活動許可の有無 | - | 使用できる値：permitted, none | ||||
| 派遣・請負就労区分 | - | 使用できる値：other_be_workable, others | ||||
| 部署 | - | |||||
| 契約種別 | - | 使用できる値：unlimited, fixed_term | ||||
| 契約開始日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 契約終了日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 契約更新の有無 | - | 使用できる値：renewal, none, auto_renewal | ||||
| 課税区分 | - | 使用できる値：kou, otsu, hei, reward, non_resident, no_taxation_required | ||||
| 障害者区分 | - | 使用できる値：ordinary_handicapped, special_handicapped | ||||
| 障害者手帳の種類 | - | |||||
| 障害者手帳の交付年月日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 勤労学生フラグ | - | |||||
| 勤労学生：学校名 | - | |||||
| 勤労学生：入学年月日 | - | 日付形式：YYYY-MM-DD（例：2025-06-27） | ||||
| 勤労学生：所得の見積額 | - | 入力可能範囲：-2,147,483,648 ～ 2,147,483,647 | ||||
| 給与所得フラグ | - | |||||
| 事業所得フラグ | - | |||||
| 配当所得フラグ | - | |||||
| 不動産所得フラグ | - | |||||
| 寡婦・ひとり親 | - | 使用できる値：widow, single_parent | ||||
| 寡婦・ひとり親の理由 | - | 使用できる値：divorce, bereavement, missing, unmarried | ||||
| 寡婦・ひとり親の備考 | - | |||||
| 雇用形態のID | - | |||||
| 所属する部署のIDリスト | - | 0個以上の部署ID配列 | ||||
| 給与支給形態 | - | |||||
| プロフィール画像のファイル名 | - | |||||
| プロフィール画像のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 履歴書・職務経歴書1のファイル名 | - | |||||
| 履歴書・職務経歴書1のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 履歴書・職務経歴書2のファイル名 | - | |||||
| 履歴書・職務経歴書2のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 本人確認書類1のファイル名 | - | |||||
| 本人確認書類1のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 本人確認書類2のファイル名 | - | |||||
| 本人確認書類2のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 住所を確認できる書類のファイル名 | - | |||||
| 住所を確認できる書類のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 雇用保険被保険者番号添付画像のファイル名 | - | |||||
| 雇用保険被保険者番号添付画像のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 基礎年金番号添付画像のファイル名 | - | |||||
| 基礎年金番号添付画像のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 在留カードの画像1のファイル名 | - | |||||
| 在留カードの画像1のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 在留カードの画像2のファイル名 | - | |||||
| 在留カードの画像2のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 障害者手帳の画像のファイル名 | - | |||||
| 障害者手帳の画像のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 勤労学生：学生証の画像のファイル名 | - | |||||
| 勤労学生：学生証の画像のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| △ | 口座情報の銀行コード | - | bank_accountsが存在する場合は必須 | |||
| △ | 口座情報の支店コード | - | bank_accountsが存在する場合は必須 | |||
| △ | 口座情報の預金種別 | - | bank_accountsが存在する場合は必須。 使用できる値：saving, checking, deposit | |||
| △ | 口座情報の口座番号 | - | bank_accountsが存在する場合は必須 | |||
| △ | 口座情報の名義（カタカナ） | - | bank_accountsが存在する場合は必須。 カタカナのみ許可 | |||
| 口座情報を確認できる画像のファイル名 | - | |||||
| 口座情報を確認できる画像のコンテンツ | - | ファイルをBase64形式でエンコードした文字列データ。 ファイルサイズ上限：10MB 対応ファイル形式：画像（PNG、JPEG）、文書（PDF、Word、Excel）、テキスト（TXT、CSV）、その他（CONF、LOG、GIF） | ||||
| 口座設定ID | - |
SmartHR for Developers