<p>いつもSmartHRをご利用いただきありがとうございます。</p><p>従業員の家族情報としてあらかじめ用意されている項目に加えて、家族ごとに必要な情報を管理する項目（カスタム家族項目）を登録できるようになります。これに伴い、家族情報に関するAPIでも、カスタム家族項目の登録や取得が可能になります。</p><p>画面上の変更点については、下記のお知らせをご覧ください。</p><p><a href="https://support.smarthr.jp/ja/info/update/mmgdqaot2wze/">https://support.smarthr.jp/ja/info/update/mmgdqaot2wze/</a></p><p></p><h2 id="he2d17b0a70">変更予定時期</h2><p>2025年3月〜6月予定</p><h2 id="he5bc7daaf4">変更箇所</h2><ul><li>家族リストの取得<ul><li>GET /v1/crews/{crew_id}/dependents</li></ul></li><li>家族の取得<ul><li>GET /v1/crews/{crew_id}/dependents/{id}</li></ul></li><li>家族の登録<ul><li>POST /v1/crews/{crew_id}/dependents</li></ul></li><li>家族の更新<ul><li>PUT /v1/crews/{crew_id}/dependents/{id}</li></ul></li><li>家族の部分更新<ul><li>PATCH /v1/crews/{crew_id}/dependents/{id}</li></ul></li></ul><h2 id="h39eedbddf5">変更内容</h2><h3 id="h41d78ffcb7">家族リストの取得・家族の取得の詳細</h3><p>レスポンスのプロパティに[custom_fields]が追加されます。リクエストパラメータに変更はありません。</p><p><strong>例. 入力タイプがテキストのカスタム家族項目の値が存在する場合</strong></p><pre><code>&quot;custom_fields&quot;:[{
    &quot;value”: &quot;サンプル&quot;
    &quot;template&quot;:{
        &quot;id&quot;: &quot;
abcabcac-abca-abca-abca-abcabcabcabc
&quot;,
        &quot;name&quot;: &quot;テキスト項目&quot;
        &quot;type&quot;: &quot;string&quot;
        &quot;elements&quot;:null,
        &quot;hint&quot;:&quot;ヒント&quot;
        &quot;scale&quot;:null,
        &quot;separated_by_commas&quot;:null,
        &quot;created_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;,
        &quot;updated_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;
    },
    &quot;created_at&quot;:&quot;2024-08-23T17:10:51.849+09:00&quot;,
    &quot;updated_at&quot;:&quot;2024-09-26T16:12:55.720+09:00&quot;
}]</code></pre><p><strong>例. 入力タイプが日付のカスタム家族項目の値が存在する場合</strong></p><pre><code>&quot;custom_fields&quot;:[{
    &quot;value”: &quot;2024/04/23&quot;
    &quot;template&quot;:{
        &quot;id&quot;: &quot;
abcabcac-abca-abca-abca-abcabcabcabc
&quot;,
        &quot;name&quot;: &quot;日付項目&quot;
        &quot;type&quot;: &quot;date&quot;
        &quot;elements&quot;:null,
        &quot;hint&quot;:&quot;ヒント&quot;
        &quot;scale&quot;:null,
        &quot;separated_by_commas&quot;:null,
        &quot;created_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;,
        &quot;updated_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;
    },
    &quot;created_at&quot;:&quot;2024-08-23T17:10:51.849+09:00&quot;,
    &quot;updated_at&quot;:&quot;2024-09-26T16:12:55.720+09:00&quot;
}]
</code></pre><p><strong>例. 入力タイプが数値のカスタム家族項目の値が存在する場合</strong></p><pre><code>&quot;custom_fields&quot;:[{
    &quot;value”: &quot;100.00&quot;
    &quot;template&quot;:{
        &quot;id&quot;: &quot;
abcabcac-abca-abca-abca-abcabcabcabc
&quot;,
        &quot;name&quot;: &quot;数値項目&quot;
        &quot;type&quot;: &quot;decimal&quot;
        &quot;elements&quot;:null,
        &quot;hint&quot;:&quot;ヒント&quot;
        &quot;scale&quot;:2,
        &quot;separated_by_commas&quot;:false,
        &quot;created_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;,
        &quot;updated_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;
    },
    &quot;created_at&quot;:&quot;2024-08-23T17:10:51.849+09:00&quot;,
    &quot;updated_at&quot;:&quot;2024-09-26T16:12:55.720+09:00&quot;
}]
</code></pre><p><strong>例. 入力タイプがファイルのカスタム家族項目の値が存在する場合</strong></p><ul><li>valueには、アップロードしたファイルへのURLが入ります。</li></ul><pre><code>&quot;custom_fields&quot;:[{
    &quot;value”: &quot;https://app.smarthr.jp/~~~~~~~~~~~.jpg&quot;
    &quot;template&quot;:{
        &quot;id&quot;: &quot;
abcabcac-abca-abca-abca-abcabcabcabc
&quot;,
        &quot;name&quot;: &quot;ファイル項目&quot;
        &quot;type&quot;: &quot;file&quot;
        &quot;elements&quot;:null,
        &quot;hint&quot;:&quot;ヒント&quot;
        &quot;scale&quot;:null,
        &quot;separated_by_commas&quot;:null,
        &quot;created_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;,
        &quot;updated_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;
    },
    &quot;created_at&quot;:&quot;2024-08-23T17:10:51.849+09:00&quot;,
    &quot;updated_at&quot;:&quot;2024-09-26T16:12:55.720+09:00&quot;
}]
</code></pre><h4 id="hc4570a73b9">例. 入力タイプがドロップダウンリストのカスタム家族項目の値が存在する場合</h4><ul><li>ドロップダウンリスト項目の物理名(physical_name)が設定されている場合<ul><li>valueには、ドロップダウンリスト項目の物理名(physical_name)が入ります。</li></ul></li><li>ドロップダウンリスト項目の物理名(physical_name)が設定されていない場合<ul><li>valueには、ドロップダウンリスト項目の名称(name)が入ります。</li></ul></li></ul><pre><code>&quot;custom_fields&quot;:[{
    &quot;value”: &quot;001&quot;
    &quot;template&quot;:{
        &quot;id&quot;: &quot;
abcabcac-abca-abca-abca-abcabcabcabc
&quot;,
        &quot;name&quot;: &quot;最終学歴&quot;
        &quot;type&quot;: &quot;enum&quot;
        &quot;elements&quot;:[
            {
                &quot;id&quot;:&quot;
dbcdbcdc-dbce-dbce-dbce-sbcabcebcsbc
&quot;,
                &quot;name&quot;:&quot;大卒&quot;
                &quot;physical_name&quot;:&quot;001&quot;
                
            },
            {
                &quot;id&quot;:&quot;dbcdbcdc-dbce-dbce-dbce-sbcabcebcsbc
&quot;,
                &quot;name&quot;:&quot;大学院卒&quot;
                &quot;physical_name&quot;:&quot;002&quot;
                
            },
        ],
        &quot;hint&quot;:&quot;最終学歴を記入してください&quot;
        &quot;scale&quot;:null,
        &quot;separated_by_commas&quot;:null,
        &quot;created_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;,
        &quot;updated_at&quot;:&quot;2024-09-12T13:47:30.218+09:00&quot;
    },
    &quot;created_at&quot;:&quot;2024-08-23T17:10:51.849+09:00&quot;,
    &quot;updated_at&quot;:&quot;2024-09-26T16:12:55.720+09:00&quot;
}]</code></pre><h3 id="haf768e47e5">家族の登録・家族の更新・家族の部分更新の詳細</h3><p>リクエストパラメータに[custom_fields]を追加します。</p><h4 id="h2da9bdca77">valueに指定する値</h4><p>カスタム項目マスタの入力タイプに応じた形式の値を指定してください。</p><p>enumの場合、ドロップダウンリスト項目の ID 又は物理名(physical_name)を指定してください。</p><p>fileの場合、データをBase64エンコードした文字列を指定し、かつ file_name にデータの名前を拡張子付きで指定してください。</p><pre><code>{
  &quot;custom_fields&quot;: [
    {
      &quot;template_id&quot;: &quot;1234567a-123a-123a-123a-123456789aa&quot;,
      &quot;value&quot;: &quot;string&quot;
    },
    {
      &quot;template_id&quot;: &quot;1234567a-123a-123a-123a-123456789ab&quot;,
      &quot;value&quot;: &quot;text&quot;
    },
    {
      &quot;template_id&quot;: &quot;1234567a-123a-123a-123a-123456789ac&quot;,
      &quot;value&quot;: 0
    },
    {
      &quot;template_id&quot;: &quot;1234567a-123a-123a-123a-123456789ad&quot;,
      &quot;value&quot;: &quot;2017-03-09&quot;
    },
    {
      &quot;template_id&quot;: &quot;1234567a-123a-123a-123a-123456789ae&quot;,
      &quot;value&quot;: &quot;enum_element_physical_name&quot;
    },
    {
      &quot;template_id&quot;: &quot;1234567a-123a-123a-123a-123456789af&quot;,
      &quot;value&quot;: &quot;/9j/4AAQSkZJRgABAQAASABIAAD/4QCMRXhpZgAATU0AK...&quot;,
      &quot;file_name&quot;: &quot;awesome_image.jpg&quot;
    }
  ]
}</code></pre><h2 id="h9354422c8c">利用できるプラン</h2><p>SmartHRの「労務管理プラン」「人事・労務エッセンシャルプラン」「HRストラテジープラン」「¥0プラン」を利用している企業様がご利用いただけます。</p><h2 id="h3bcda3e6b0">最後に</h2><p>SmartHRでは、ご利用企業の声を積極的にサービス開発の参考にしていきたいと考えております。機能や画面のデザインなど、なにか気になることがございましたら、お気軽にお伝えください。</p><p>SmartHRの機能追加、改善に関する情報は「お知らせ」や「リリースノート」にて、株式会社SmartHRの企業情報に関するニュースはFacebook・Xからもお知らせしています。よろしければ「いいね！」「フォロー」をお願いします。</p><ul><li><a href="https://support.smarthr.jp/ja/info/">お知らせ</a></li><li><a href="https://support.smarthr.jp/ja/release-notes/" target="_blank" rel="noopener noreferrer nofollow">リリースノート</a></li><li><a href="https://www.facebook.com/smarthrjp/" target="_blank" rel="noopener noreferrer nofollow">Facebook</a></li><li><a href="https://twitter.com/smarthr_jp" target="_blank" rel="noopener noreferrer nofollow">X</a></li></ul><p>今後とも、SmartHRをよろしくお願いいたします。</p>

SmartHR APIでカスタム家族項目の登録や取得が可能になります

SSO／SAML認証

文書配付

分析レポート

従業員サーベイ

人事評価

配置シミュレーション

キャリア台帳

学習管理

採用管理

通勤経路検索

有料オプション

設定

従業員リスト・従業員情報

招待

マイナンバー

手続き

電子申請

届出書類

給与明細

源泉徴収票

お知らせ管理

年末調整

申請

組織図・名簿

スキル管理

HRアナリティクス

データ連携

各種サービス連携

機能で調べる

セキュリティ

SmartHR API

料金と契約内容

サポート

その他