SmartHR
SmartHRを業務アセットとして接続すると、SmartHRの「従業員」をYESODから管理できます。接続に必要な準備と、管理できる範囲を説明します。
概要
SmartHRは、株式会社SmartHRが提供する人事労務手続きのDXを推進するクラウド型の人事労務ソフトです。従業員情報の管理、入退社手続き、年末調整、労務手続きの電子申請などの人事業務をオンラインで効率化します。
| 参照先 | URL |
|---|---|
| 公式HP | https://smarthr.jp/ |
| 公式ヘルプ | https://knowledge.smarthr.jp/ |
| APIドキュメント | https://developer.smarthr.jp/api/ |
「従業員」と「アカウント」
SmartHRには「従業員」と「アカウント」という2つの概念があります。YESODが管理するのは「従業員」だけです(2025年8月時点)。
| 概念 | SmartHRでの意味 |
|---|---|
| 「従業員」 | SmartHRの「従業員リスト」で管理される従業員情報 |
| 「アカウント」 | SmartHRにアクセスしてサービスを利用するための権利 |
YESODのアカウントは、SmartHRの「従業員」に相当します。SmartHRのアカウントは管理できません。
2つの概念の違いは、SmartHRの従業員情報とアカウントの違いを参照してください。
管理できること
| 項目 | 備考 |
|---|---|
| 「従業員」の管理 | — |
| アカウント管理・割当種別 | 非対応 |
| グループプッシュ | 非対応 |
接続方式は標準コネクタです。
事前に必要なもの
- SmartHRで発行したアクセストークン
- SmartHRのサブドメイン
接続に使う情報
| 入力項目 | 必須 | 入力する内容 |
|---|---|---|
| 「カスタムURL」 | 必須 | SmartHRのサブドメインと、環境に対応するドメイン |
| 「アクセストークン」 | 必須 | SmartHRで発行したアクセストークン |
アクセストークンは第三者に共有せず、安全な場所で管理してください。
接続の準備
接続する前に、SmartHRでアクセストークンを発行します。発行方法は、SmartHRのアクセストークンの発行方法を参照してください。
アクセストークンに有効期限はありませんが、発行後に一度しか表示されません。必ず記録してください。紛失した場合は、新しく発行し直してください。
あわせて、SmartHRのサブドメインを控えます。サブドメインは、SmartHRのURLのうちhttps://とドメインのあいだの文字列です。
接続する
「業務アセット」画面から「SaaS接続」画面を開くまでの手順は、業務アセットを追加するを参照してください。
-
「SaaS接続」画面で「SmartHR」を選択します。 「SmartHR 接続」画面が表示されます。
-
「カスタムURL」に、控えておいたサブドメインを入力します。
-
ドメインの選択肢から、環境に対応するドメインを選択します。 選択肢は
.smarthr.jpと.daruma.spaceです。 -
「アクセストークン」に、SmartHRで発行したアクセストークンを入力します。
-
「接続」ボタンをクリックします。 同期が完了すると、業務アセットが作成されます。
アカウントの作成
アカウント作成タスクを実行すると、YESODからSmartHRへ一意の識別子として「メールアドレス」または「社員番号」を渡します。どちらも空の場合、タスクは失敗します。
渡した識別子がSmartHR側にすでに登録されているかどうかで、動作が変わります。
| SmartHRの状態 | 動作 |
|---|---|
| 同一の識別子を持つ**「従業員」が存在しない** | 「従業員」を新規作成します |
| 同一の識別子を持つ在籍中の「従業員」が存在する | その「従業員」の情報を更新します |
| 同一の識別子を持つ退職済みの「従業員」が存在する | 退職日を空にし、在籍状況を「在籍中」にしたうえで、情報を更新します |
同一の識別子を持つ「従業員」がSmartHRに複数存在する場合は、次のように動作します。
- 在職中と退職済みが混在していれば、在職中の「従業員」の更新が優先されます
- すべての「従業員」の在籍状況が同じ場合、どの「従業員」が更新対象になるかは取得順に依存します。その順序に明確な定義はありません
新規作成のときは、YESOD側の在籍状況の設定値に関係なく、必ず「在籍中」として作成されます。
パスワードの設定
パスワードの作成には対応していません。SmartHRのAPIではパスワードを設定できないためです。
アカウントの作成後、SmartHRからユーザーへメールが送信されます。ユーザーは、そのメールからパスワードを設定します。
アカウントの削除
削除タスクは、「従業員」の在籍状況を「退職済み」にします。
同期する項目のuser.resigned_atに値が設定されているメンバーは、在籍状況が「退職済み」になります。あわせて、SmartHRの「退職年月日」にその値が設定されます。
「従業員」を完全に削除する場合は、SmartHRの従業員情報の画面から直接削除してください。
削除タスクを前倒しで実行すると、SmartHR側では実行した時点で在籍状況が「退職済み」に変わります。YESOD側の在籍状況とのあいだに差が生じます。
割当種別
割当種別には対応していません。
同期する項目
業務アセット詳細の左のメニューで「アカウント設定」を開き、「同期する項目」タブで設定します。
「必須」列の記号の意味は次のとおりです。
| 記号 | 意味 |
|---|---|
| ○ | 必須です |
| △ | 条件を満たすときだけ必須です |
| — | 任意です |
| 必須 | 属性名 | key | デフォルト値 | 型 | 備考 |
|---|---|---|---|---|---|
| — | 「ユーザーID」 | user.user_id | — | string | アカウントとの紐付けに使う項目です |
| — | 「事業所ID」 | user.biz_establishment_id | — | string | — |
| ○ | 「在籍状況」 | user.emp_status | user.enrollment | string | 対応する値と注意点は、この表の下にある在籍状況の説明を参照してください |
| △ | 「社員番号」 | user.emp_code | — | string | 社員番号かメールアドレスのいずれかが必須です |
| — | 「雇用形態」 | user.emp_type | — | string | 指定できる値は限られます。この表の下にある雇用形態の説明を参照してください |
| ○ | 「姓」 | user.last_name | user.familyNameLocalPreferred | string | — |
| ○ | 「名」 | user.first_name | user.givenNameLocalPreferred | string | — |
| ○ | 「姓(カタカナ)」 | user.last_name_yomi | user.familyNameLocalPhoneticPreferred | string | カタカナのみ許可されます |
| ○ | 「名(カタカナ)」 | user.first_name_yomi | user.givenNameLocalPhoneticPreferred | string | カタカナのみ許可されます |
| — | 「ビジネスネーム:姓」 | user.business_last_name | — | string | — |
| — | 「ビジネスネーム:名」 | user.business_first_name | — | string | — |
| — | 「ビジネスネーム:姓(カタカナ)」 | user.business_last_name_yomi | — | string | カタカナのみ許可されます |
| — | 「ビジネスネーム:名(カタカナ)」 | user.business_first_name_yomi | — | string | カタカナのみ許可されます |
| — | 「生年月日」 | user.birth_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| ○ | 「戸籍上の性別」 | user.gender | user.["<メンバー項目のID>"] | string | 使用できる値:male, female。デフォルト値のIDはテナントごとに異なります |
| — | 「電話番号」 | user.tel_number | — | string | 個人電話番号です |
| — | 「現住所の国コード」 | user.address.country_number | — | string | — |
| — | 「現住所の郵便番号」 | user.address.zip_code | — | string | — |
| — | 「現住所の都道府県」 | user.address.pref | — | string | — |
| △ | 「現住所の市区町村」 | user.address.city | — | string | addressが存在する場合は必須です |
| — | 「現住所の丁目・番地」 | user.address.street | — | string | — |
| — | 「現住所の建物名・部屋番号」 | user.address.building | — | string | — |
| — | 「現住所のヨミガナ」 | user.address.literal_yomi | — | string | — |
| — | 「世帯主」 | user.address_head_of_family | — | string | — |
| — | 「世帯主の続柄」 | user.address_relation_name | — | string | — |
| △ | 「メールアドレス」 | user.email | user.email | string | 社員番号かメールアドレスのいずれかが必須です |
| — | 「緊急連絡先の続柄」 | user.emergency_relation_name | — | string | — |
| — | 「緊急連絡先の姓」 | user.emergency_last_name | — | string | — |
| — | 「緊急連絡先の名」 | user.emergency_first_name | — | string | — |
| — | 「緊急連絡先の姓(カタカナ)」 | user.emergency_last_name_yomi | — | string | カタカナのみ許可されます |
| — | 「緊急連絡先の名(カタカナ)」 | user.emergency_first_name_yomi | — | string | カタカナのみ許可されます |
| — | 「緊急連絡先の電話番号」 | user.emergency_tel_number | — | string | — |
| — | 「緊急連絡先住所の国コード」 | user.emergency_address.country_number | — | string | — |
| — | 「緊急連絡先住所の郵便番号」 | user.emergency_address.zip_code | — | string | — |
| — | 「緊急連絡先住所の都道府県」 | user.emergency_address.pref | — | string | — |
| △ | 「緊急連絡先住所の市区町村」 | user.emergency_address.city | — | string | emergency_addressが存在する場合は必須です |
| — | 「緊急連絡先住所の丁目・番地」 | user.emergency_address.street | — | string | — |
| — | 「緊急連絡先住所の建物名・部屋番号」 | user.emergency_address.building | — | string | — |
| — | 「緊急連絡先住所のヨミガナ」 | user.emergency_address.literal_yomi | — | string | — |
| — | 「住民票住所の国コード」 | user.resident_card_address.country_number | — | string | — |
| — | 「住民票住所の郵便番号」 | user.resident_card_address.zip_code | — | string | — |
| — | 「住民票住所の都道府県」 | user.resident_card_address.pref | — | string | — |
| △ | 「住民票住所の市区町村」 | user.resident_card_address.city | — | string | resident_card_addressが存在する場合は必須です |
| — | 「住民票住所の丁目・番地」 | user.resident_card_address.street | — | string | — |
| — | 「住民票住所の建物名・部屋番号」 | user.resident_card_address.building | — | string | — |
| — | 「住民票住所のヨミガナ」 | user.resident_card_address.literal_yomi | — | string | — |
| — | 「住民票住所の世帯主」 | user.resident_card_address_head_of_family | — | string | — |
| — | 「続柄(住民票住所の世帯主)」 | user.resident_card_address_relation_name | — | string | — |
| — | 「役職」 | user.position | — | string | — |
| — | 「役職名リスト」 | user.positions | — | array (string) | 0個以上の役職名の配列です |
| — | 「等級名」 | user.grade | — | string | — |
| — | 「職種名」 | user.job_category | — | string | — |
| — | 「業務内容」 | user.occupation | — | string | — |
| — | 「入社年月日」 | user.entered_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「退職年月日」 | user.resigned_at | — | string | この表の下にある退職年月日の説明を参照してください |
| — | 「退職事由」 | user.resigned_reason | — | string | — |
| — | 「雇用保険の被保険者番号」 | user.emp_ins_insured_person_number | — | string | — |
| — | 「雇用保険の被保険者番号がない場合の理由」 | user.emp_ins_insured_person_number_unknown_reason_type | — | string | 使用できる値:no_work_experience, never_joined, unknown |
| — | 「雇用保険の資格取得年月日」 | user.emp_ins_qualified_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「雇用保険の資格喪失年月日」 | user.emp_ins_disqualified_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「雇用保険に加入していた会社名」 | user.previous_workplace | — | string | — |
| — | 「雇用保険に加入していた会社の在籍開始日」 | user.previous_employment_start_on | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「雇用保険に加入していた会社の在籍終了日」 | user.previous_employment_end_on | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「厚生年金保険の被保険者整理番号」 | user.soc_ins_insured_person_number | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「健康保険の被保険者整理番号」 | user.hel_ins_insured_person_number | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「基礎年金番号」 | user.basic_pension_number | — | string | — |
| — | 「厚生年金初加入フラグ」 | user.first_enrolling_in_emp_pns_ins_flag | — | boolean | — |
| — | 「基礎年金番号が不明な場合の理由」 | user.basic_pension_number_unknown_reason_type | — | string | 使用できる値:non_pensionable, unknown |
| — | 「最初に厚生年金へ加入した会社名」 | user.first_workplace | — | string | — |
| — | 「最初に厚生年金へ加入した会社の住所文字列」 | user.first_workplace_address_text | — | string | — |
| — | 「最初に厚生年金へ加入した会社の在籍開始日」 | user.first_employment_start_on | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「最初に厚生年金へ加入した会社の在籍終了日」 | user.first_employment_end_on | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「最後に厚生年金へ加入した会社名」 | user.last_workplace | — | string | — |
| — | 「最後に厚生年金へ加入した会社の住所文字列」 | user.last_workplace_address_text | — | string | — |
| — | 「最後に厚生年金へ加入した会社の在籍開始日」 | user.last_employment_start_on | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「最後に厚生年金へ加入した会社の在籍終了日」 | user.last_employment_end_on | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「社会保険の資格取得年月日」 | user.soc_ins_qualified_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「社会保険の資格喪失年月日」 | user.soc_ins_disqualified_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「配偶者の有無」 | user.having_spouse | — | boolean | — |
| — | 「配偶者の年収」 | user.spouse_yearly_income | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「報酬月額(通貨)」 | user.monthly_income_currency | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「報酬月額(現物)」 | user.monthly_income_goods | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「基本給(月給)」 | user.monthly_base_salary | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「標準報酬月額の改定年月」 | user.monthly_standard_income_updated_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「健康保険の標準報酬月額」 | user.monthly_standard_income_hel | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「厚生年金の標準報酬月額」 | user.monthly_standard_income_pns | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「通勤経路」 | user.nearest_station_and_line | — | string | — |
| — | 「通勤手当1の定期券代」 | user.commutation_1_expenses | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「通勤手当1の期間」 | user.commutation_1_period | — | string | 使用できる値:commutation_period_1_month, commutation_period_3_month, commutation_period_6_month |
| — | 「通勤手当1の片道運賃」 | user.commutation_1_single_fare | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「通勤手当2の定期券代」 | user.commutation_2_expenses | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「通勤手当2の期間」 | user.commutation_2_period | — | string | 使用できる値:commutation_period_1_month, commutation_period_3_month, commutation_period_6_month |
| — | 「通勤手当2の片道運賃」 | user.commutation_2_single_fare | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「在留資格情報:姓」 | user.foreign_resident_last_name | — | string | — |
| — | 「在留資格情報:名」 | user.foreign_resident_first_name | — | string | — |
| — | 「在留資格情報:ミドルネーム」 | user.foreign_resident_middle_name | — | string | — |
| — | 「在留カード番号」 | user.foreign_resident_card_number | — | string | — |
| — | 「国籍 / 国籍コード」 | user.nationality_code | — | string | — |
| — | 「在留資格」 | user.resident_status_type | — | string | — |
| — | 「在留資格不明理由」 | user.resident_status_other_reason | — | string | — |
| — | 「在留期日」 | user.resident_end_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「資格外活動許可の有無」 | user.having_ex_activity_permission | — | string | 使用できる値:permitted, none |
| — | 「派遣・請負就労区分」 | user.other_be_workable_type | — | string | 使用できる値:other_be_workable, others |
| — | 「契約種別」 | user.contract_type | — | string | 使用できる値:unlimited, fixed_term |
| — | 「契約開始日」 | user.contract_start_on | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「契約終了日」 | user.contract_end_on | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「契約更新の有無」 | user.contract_renewal_type | — | string | 使用できる値:renewal, none, auto_renewal |
| — | 「課税区分」 | user.tax_cd | — | string | 使用できる値:kou, otsu, hei, reward, non_resident, no_taxation_required |
| — | 「障害者区分」 | user.handicapped_type | — | string | 使用できる値:ordinary_handicapped, special_handicapped |
| — | 「障害者手帳の種類」 | user.handicapped_note_type | — | string | — |
| — | 「障害者手帳の交付年月日」 | user.handicapped_note_delivery_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「勤労学生フラグ」 | user.working_student_flag | — | boolean | — |
| — | 「勤労学生:学校名」 | user.school_name | — | string | — |
| — | 「勤労学生:入学年月日」 | user.enrolled_at | — | string | 日付形式:YYYY-MM-DD(例:2025-06-27) |
| — | 「勤労学生:所得の見積額」 | user.working_student_income | — | integer | 入力可能範囲:-2,147,483,648 〜 2,147,483,647 |
| — | 「給与所得フラグ」 | user.employment_income_flag | — | boolean | — |
| — | 「事業所得フラグ」 | user.business_income_flag | — | boolean | — |
| — | 「配当所得フラグ」 | user.devidend_income_flag | — | boolean | — |
| — | 「不動産所得フラグ」 | user.estate_income_flag | — | boolean | — |
| — | 「寡婦・ひとり親」 | user.widow_type | — | string | 使用できる値:widow, single_parent |
| — | 「寡婦・ひとり親の理由」 | user.widow_reason_type | — | string | 使用できる値:divorce, bereavement, missing, unmarried |
| — | 「寡婦・ひとり親の備考」 | user.widow_memo | — | string | — |
| — | 「雇用形態のID」 | user.employment_type_id | — | string | — |
| — | 「所属する部署のIDリスト」 | user.department_ids | — | array (string) | 0個以上の「部署」のIDの配列です |
| — | 「給与支給形態」 | user.payment_period_id | — | string | — |
| — | 「プロフィール画像のファイル名」 | user.profile_image.file_name | — | string | — |
| — | 「プロフィール画像のコンテンツ」 | user.profile_image.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「履歴書・職務経歴書1のファイル名」 | user.resume1.file_name | — | string | — |
| — | 「履歴書・職務経歴書1のコンテンツ」 | user.resume1.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「履歴書・職務経歴書2のファイル名」 | user.resume2.file_name | — | string | — |
| — | 「履歴書・職務経歴書2のコンテンツ」 | user.resume2.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「本人確認書類1のファイル名」 | user.identity_card_image1.file_name | — | string | — |
| — | 「本人確認書類1のコンテンツ」 | user.identity_card_image1.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「本人確認書類2のファイル名」 | user.identity_card_image2.file_name | — | string | — |
| — | 「本人確認書類2のコンテンツ」 | user.identity_card_image2.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「住所を確認できる書類のファイル名」 | user.address_image.file_name | — | string | — |
| — | 「住所を確認できる書類のコンテンツ」 | user.address_image.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「雇用保険被保険者番号添付画像のファイル名」 | user.emp_ins_insured_person_number_image.file_name | — | string | — |
| — | 「雇用保険被保険者番号添付画像のコンテンツ」 | user.emp_ins_insured_person_number_image.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「基礎年金番号添付画像のファイル名」 | user.basic_pension_number_image.file_name | — | string | — |
| — | 「基礎年金番号添付画像のコンテンツ」 | user.basic_pension_number_image.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「在留カードの画像1のファイル名」 | user.foreign_resident_card_image1.file_name | — | string | — |
| — | 「在留カードの画像1のコンテンツ」 | user.foreign_resident_card_image1.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「在留カードの画像2のファイル名」 | user.foreign_resident_card_image2.file_name | — | string | — |
| — | 「在留カードの画像2のコンテンツ」 | user.foreign_resident_card_image2.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「障害者手帳の画像のファイル名」 | user.handicapped_image.file_name | — | string | — |
| — | 「障害者手帳の画像のコンテンツ」 | user.handicapped_image.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「勤労学生:学生証の画像のファイル名」 | user.student_card_image.file_name | — | string | — |
| — | 「勤労学生:学生証の画像のコンテンツ」 | user.student_card_image.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| △ | 「口座情報の銀行コード」 | user.bank_accounts.bank_code | — | string | bank_accountsが存在する場合は必須です |
| △ | 「口座情報の支店コード」 | user.bank_accounts.bank_branch_code | — | string | bank_accountsが存在する場合は必須です |
| △ | 「口座情報の預金種別」 | user.bank_accounts.account_type | — | string | bank_accountsが存在する場合は必須です。使用できる値:saving, checking, deposit |
| △ | 「口座情報の口座番号」 | user.bank_accounts.account_number | — | string | bank_accountsが存在する場合は必須です |
| △ | 「口座情報の名義(カタカナ)」 | user.bank_accounts.account_holder_name | — | string | bank_accountsが存在する場合は必須です。カタカナのみ許可されます |
| — | 「口座情報を確認できる画像のファイル名」 | user.bank_accounts.bankbook_image.file_name | — | string | — |
| — | 「口座情報を確認できる画像のコンテンツ」 | user.bank_accounts.bankbook_image.content | — | string | ファイルをBase64形式でエンコードした文字列データです。制限はこの表の下にあるファイルの制限を参照してください |
| — | 「口座設定ID」 | user.bank_accounts.bank_account_setting_id | — | string | — |
| — | 「カスタム従業員項目」 | user.custom_fields."<グループのIDまたはグループ名>"."<項目のIDまたは項目名>" | — | string | この表の下にある「カスタム従業員項目」を参照してください |
各項目の詳細は、SmartHRの従業員の登録APIを参照してください。
在籍状況
user.emp_statusは「在籍中」と「退職済み」のみに対応しています。
在籍状況は、アカウントの作成時と削除時にYESODが書き換えます。「同期する項目」の設定を変更しないでください。
アカウントの作成時の動作は「アカウントの作成」、削除時の動作は「アカウントの削除」で説明しています。属性同期では、在籍状況の値は更新されません。
雇用形態
SmartHRのAPIは、user.emp_typeに次の7種類とカスタム値だけを受け付けます。
| 値 | 意味 |
|---|---|
board_member | 役員 |
full_timer | 正社員 |
contract_worker | 契約社員 |
permatemp | 派遣社員 |
part_timer | アルバイト・パート |
outsourcing_contractor | 業務委託 |
etc | その他 |
YESOD側の雇用形態は、属性式でこれらの値へ対応づけます。属性式の例は次のとおりです。
user.employmentType[0] == "正社員" ? "full_timer" :
user.employmentType[0] == "契約社員" ? "contract_worker" :
user.employmentType[0] == "アルバイト" ? "part_timer" :
user.employmentType[0] == "派遣" ? "permatemp" :
user.employmentType[0] == "業務委託" ? "outsourcing_contractor" :
user.employmentType[0] == "取締役" ? "board_member" :
user.employmentType[0] == "無給インターン" ? "etc" :
"etc"
対応づけを追加するときは、最後のetcより前に1行足します。
user.employmentType[0] == "<YESODの値>" ? "<SmartHRの値>" :
たとえば「特別顧問」を役員として扱う場合は、次のようになります。
user.employmentType[0] == "特別顧問" ? "board_member" :
"etc"
雇用形態のマスターデータについては、SmartHRの雇用形態のマスターデータを管理するを参照してください。
退職年月日
user.resigned_atには、YYYY-MM-DD形式の文字列を指定します。マッピングを設定していない場合、削除タスクを実行してもSmartHR側に退職日は設定されません。
どの会社の退職日を反映するかは、次の属性式で指定します。
user.leaving_date["<会社のID>"]
ファイルの制限
画像・書類のコンテンツ(user.profile_image.contentなど)は、ファイルをBase64形式でエンコードした文字列データです。制限は次のとおりです。
| 項目 | 内容 |
|---|---|
| ファイルサイズ | 10MBまで |
| 対応ファイル形式 | 画像(PNG、JPEG)、文書(PDF、Word、Excel)、テキスト(TXT、CSV)、その他(CONF、LOG、GIF) |
「カスタム従業員項目」
SmartHRの「カスタム従業員項目」に値を連携できます。以前は対応していませんでしたが、2026年8月のアップデートで連携できるようになりました。
「同期する項目」のkeyに、次の形式で「カスタム従業員項目グループ」と「カスタム従業員項目」を指定します。
user.custom_fields."カスタム従業員項目グループのIDまたはグループ名"."カスタム従業員項目のIDまたは項目名"
たとえば、「カスタム従業員項目グループ」の「基本情報(サンプル)」に属する「カスタム従業員項目」の「社員ランク」に値を連携する場合を説明します。SmartHR側では、グループ名と項目名を次のように確認できます。

YESOD側では、「アカウント設定」の「同期する項目」タブでkeyを次のように指定します。
user.custom_fields."基本情報(サンプル)"."社員ランク"

- グループと項目は、それぞれSmartHR上のID(UUID)と名前のどちらでも指定できます
- 値は、アカウント作成タスク(新規作成・既存の「従業員」の更新・退職済みの「従業員」の復帰)と属性同期のどちらでも連携されます
- 評価結果が
null以外の場合は、値を文字列に変換して送信します。評価結果がnullの場合は値を送信しません - 属性式は、SmartHR側の「カスタム従業員項目」のデータ型(ドロップダウン・日付・数値など)に沿った値となるよう設定してください
- SmartHR側に存在しないグループ名・項目名(またはID)を指定すると、指定方法を案内するエラーになります。グループ名・項目名は、SmartHRの画面の表記と完全に一致させてください
次のカスタム項目には対応していません。
| 対応していない項目 | 備考 |
|---|---|
| ファイル型の「カスタム従業員項目」 | 値を連携しようとするとエラーになります |
| カスタム家族項目 | — |
連携する「カスタム従業員項目」には、アクセストークンの権限で参照・更新を許可しておく必要があります。カスタム項目は、トークンの発行後に追加された場合でもデフォルトの権限設定に従います。必要に応じて、項目ごとに参照・更新を許可してください。権限設定の方法は、SmartHRのアクセストークンの発行方法にある項目ごとのアクセス許可の説明を参照してください。
カスタム項目そのものについては、SmartHRのカスタム項目を管理するを参照してください。
グループプッシュ
グループプッシュには対応していません。