本レシピはFreeプランにて無料でご利用いただけます。アカウント登録が完了されていない場合は下記よりご登録ください。
ActRecipe Freeプラン利用申込フォーム
SmartHRの年末調整データを用いて国税庁が定める「年末調整申告書XMLデータ」を出力する方法を解説します。
レシピを使用するには事前にSmartHRの利用契約が必要になります。
このレシピは2023年版となりますのでサポート対象外となります。
0.事前準備
- 「SmartHR - 年調ソフトXML形式 年末調整連携 [2023年版]」レシピを使用するには、事前にSmartHR Plusでのアプリの登録が必要となります。
- 以下のSmartHR Plusにアクセスし、画面右上の「ログイン」ボタンよりSmartHRへログインします
https://www.smarthr.plus/apps/actrecipe - 続いて「連携をはじめる」ボタン(青色)を押下します
- アプリのインストール確認画面にて「連携をはじめる」ボタンを押下します
- アプリの連携が完了しますと上記「2」のボタンが「アプリを開く」に変わりますので、同ボタンを押下します
- 以下の確認画面が表示されますので「連携を許可」を押下します(※)
連携するユーザはSmartHRの「管理者」権限を保持している必要があります。
※
ActRecipeのアカウントを保持しておりActRecipeにログインしていない場合にはログインをしてください。
ActRecipeのアカウントが未作成の場合は「無料ではじめる」ボタンよりアカウントを作成し、通知メールに従ってください。
1.マイレシピへの登録
メニューの「シェアレシピ」から、「SmartHR - 年調ソフトXML形式 年末調整連携 [2023年版]」にチェックを入れ、画面下にある登録ボタンを押下します。シェアレシピの画面に「SmartHR - 年調ソフトXML形式 年末調整連携 [2023年版]」が表示されない場合はSmartHR Plusの画面からやり直してください。
メニューの「マイレシピ」から、コピーしたレシピ名を押下します。
レシピ名とレシピ説明を任意に入力し、変更した場合は保存ボタンを押下します。
2.SmartHRの連携設定
「SmartHR - 年末調整書類一覧取得」を押下し、設定を展開します。
SmartHRとのOAuth接続を切断する場合は「OAUTHを切断する」を押下し、下記の確認画面より右下の削除アイコンを押下します。
- フリーワード検索 (オプション):SmartHRからの取得データ件数が多い場合にはレシピ実行がタイムアウトエラー(サーバー応答コード: 202)となる可能性があります。そのような場合に、取得データを絞り込んでデータを取得できるオプションです。例えば、社員番号の「0001」を指定しますと「00001」および「00010〜00019」が取得対象となります。他にも氏名、ビジネスネーム、部署名、役職名、事業所でも絞り込むことができます。下記の「依頼グループ名」と組み合わせて絞り込むこともできるのですが、「依頼グループ名」だけを指定した場合は事前に全件のデータ取得が行われてしまうため、社員番号や部署名等での絞り込みをご検討ください。
- 依頼グループ名 (オプション):SmartHRの依頼グループ名を入力します。取得するデータは上記の「フリーワード検索」で絞り込まれた従業員データのうち、指定した依頼グループに含まれる従業員データのみが対象となります。この項目がブランクの場合は全ての依頼グループを対象にデータが取得されます。レシピ実行がタイムアウトエラーになる場合にはフリーワード検索と依頼グループ名を組み合わせて対象データの絞り込みをお願いします。
3.出力ファイル内容の設定
「SmartHR - 年末調整申告書生成」を押下し、設定を展開します。
このタスクでは、出力ファイルの内容を設定を行います。設定項目は以下の通りです。
- 住所選択:年末調整申告書に使用する住所を「現住所」または「住民票住所」より選択します。
-
出力フォルダ構成:出力ファイルのフォルダ構成を「従業員ごとにフォルダを分ける」または「申告書ごとにフォルダを分ける」より選択します。各フォルダ構成は以下の通りです。
【従業員ごとにフォルダを分ける】
出力ファイル:年末調整{対象の手続きの年}_{テナントID}_{依頼グループ名}_{レシピ実行日時}.zip
以下は出力ファイルを解凍した後のフォルダ構成です。
1階層目:社員番号_pass.zip、または、社員番号_nopass.zip (複数ある場合は社員番号ごとにzipファイルを生成)
→パスワード設定されている場合:社員番号_pass.zip、パスワード設定されていない場合:社員番号_nopass.zip
2階層目:[社員番号]フォルダ
3階層目:
fuyo05_[社員番号].xml
fuyo06_[社員番号].xml
hoken05_[社員番号].xml
haigusha05_[社員番号].xml
jutaku05_[社員番号].xml
kiso05_[社員番号].xml
shotoku05_[社員番号].xml
→「jutaru-fuyo05_[社員番号].xml」は出力されません。
上記xmlファイルと申告書の内容は下記の [申告書の内容と申告書フォルダ名の組み合わせ] をご覧ください。
【申告書ごとにフォルダを分ける】
以下は出力ファイルを解凍した後のフォルダ構成です。
1階層目:申告書フォルダ名 (※)
2階層目:
[申告書フォルダ名]_[社員番号1].xml
[申告書フォルダ名]_[社員番号2].xml
[申告書フォルダ名]_[社員番号3].xml
※ [申告書の内容と申告書フォルダ名の組み合わせ]
[申告書の内容:申告書フォルダ名]
給与所得者の扶養控除等(異動)申告書 令和5年分:fuyo05
給与所得者の扶養控除等(異動)申告書 令和6年分:fuyo06
給与所得者の保険料控除申告書:hoken05
給与所得者の配偶者控除等申告書:haigusha05
住宅借入金等特別控除申告書:jutaku05
給与所得者の基礎控除申告書:kiso05
所得金額調整控除申告書:shotoku05
→「従たる給与についての扶養控除等(異動) 申告書: jutaru-fuyo05フォルダ」は出力されません。
- zipパスワード (オプション):出力されるzipファイルにパスワードを設定する場合はパスワードの文字列を入力します。値がブランクの場合はパスワードなしのzipファイルが生成されます。
各項目の入力が完了しましたら「保存」ボタンでタスクを保存します。
レシピを実行する (自動実行はこちら)
「マイレシピ」内の「操作」メニューからから「実行」を押下します。
レシピの実行に成功すると「ファイル一覧」に以下のようにzipファイルが出力されます。
ローカル環境に保存するには操作メニューよりダウンロードを選択します。
レシピ実行エラーについて
レシピの実行がエラーになった場合は「レシピ実行履歴メニュー>実行ログ」をご覧ください。主なエラーログと原因は以下の通りです。
【エラーログ】
サーバー応答コード: 202
エラー内容: 実行中の処理がタイムアウトしました。
【原因】
処理件数が多いため内部的にタイムアウトが発生しています。
フリーワード検索および依頼グループ名によって対象データの絞り込みをお試しください。
【エラーログ】
サーバー応答コード: 400
エラー内容: SmartHR Plus上でActRecipeのアプリをインストールしてレシピを再実行してください。
【原因】
SmartHR Plus上でActRecipeアプリの連携が行われていない場合に発生します。
下記URLからActRecipeのアプリ連携をお試しください。
https://www.smarthr.plus/apps/actrecipe
【エラーログ】
サーバー応答コード: 400
エラー内容: 403 Client Error: Forbidden for url: https://{subdomain}.smarthr.jp/api/v1/nencho/year_end_adjustment/procedures?year=2023
【原因】
SmartHRの接続が正しく行われていない場合や管理者権限がない場合に発生します。
一度SmartHRからのログアウトとOAuth接続を切断をした上で、改めてSmartHRの管理者ユーザにてOAuth接続をお願いします。
解消しない場合はブラウザのキャッシュおよびクッキーを削除した上で、再度上記をお試しください。
【重要】生成ファイルについて
- 出力対象のデータ:SmartHRから取得される年末調整データは、依頼状況が「回答済み~確定」の全てのデータとなり、「確定」のものだけを対象にする等の特定のステータスに限定した取得することができません。そのため、対象となる方の年末調整の作成や修正がすべて確定してからレシピを実行をお願いします。本レシピは重複取得の制御を行っておりませんので、同一のデータであっても再取得が可能です。
-
生成ファイルの形式:生成されたファイルはデフォルトではパスワードなしのzip形式で出力されます。zipファイルには「1. 各xmlファイルを含むzipファイル」と「2. 処理結果をまとめたzipファイル」の2ファイルが出力されます。このうち「1. 各xmlファイルを含むzipファイル」は依頼グループ単位で出力され、「2. 処理結果をまとめたzipファイル」は1つのzipファイル内に依頼グループ単位の処理結果のcsvファイルが含まれます。ファイル名フォーマットは以下の通りです。
- 1. 各xmlファイルを含むzipファイル:年末調整{対象の手続きの年}_{テナントID}_{依頼グループ名}_{レシピ実行日時}.zip
-
2. 処理結果をまとめたzipファイル:処理結果_{レシピ実行日時}.zip
人事給与システムへのXMLファイルのアップロードの仕様については、各システムベンダーへお問い合わせください。
- zipファイルのパスワード:「出力フォルダ構成」より【従業員ごとにフォルダを分ける】を選択しますと、社員番号ごとにzipファイルが生成されます。この時に、パスワードを設定していますと出力される「年末調整{対象の手続きの年}_{テナントID}_{依頼グループ名}_{レシピ実行日時}.zip」と、「社員番号_pass.zip」に同一のパスワードが設定されます。また「出力フォルダ構成」の種類に関係なく、「処理結果_{レシピ実行日時}.zip」にも同一のパスワードが設定されます。
【重要】SmartHRの年末調整の項目および仕様について
以下はSmartHRの年末調整項目とXMLの対応表となりますので内容をご確認ください。
SmartHR年末調整項目と年調ソフトXML項目の対応表.pdf
また、下記は国税庁が公開しておりますXMLの定義書のページとなりますので適宜ご覧ください。
控除申告書データに係る仕様公開|国税庁
以下はSmartHRの年末調整データの仕様となります。出力ファイルに影響しますので内容をご確認ください。
1 | 情報連携の前提 | SmartHR年末調整(以下SmartHR)で、書類が存在しない場合は、その書類に紐づく情報は連携しない |
2 | 情報連携の前提 | SmartHRで、従業員の依頼ステータスが以下の場合は、その従業員の情報は連携しない ・依頼ステータスが回答期限切れ ・依頼ステータスが対象外(候補も含む) ・前職情報に「源泉徴収票:入手不可」が存在する |
3 | 情報連携の前提 | SmartHRの依頼ステータスが「未依頼」または「入力中」の場合でも、書類が存在する場合はその書類に紐づく情報を連携する |
4 | 情報連携の前提 | SmartHRで提供していない書類の情報は連携しない(従たる給与についての扶養控除等(異動)申告書) |
5 | 項目の連携 | 扶養控除等申告書の「本年中の所得 > 本年の合計所得の見積額」<xml001_B00701> について、 勤労学生である場合は、勤労学生の給与収入とその他収入から算出した合計所得見積額が入ります。 |
6 | 項目の連携 | 「保険料控除等証明書の保険期間<xml003_D00060> に、SmartHRで数字3桁以外の文字列が入っていた場合は、カラで出力されます。数字が「999」の場合は「99」で出力されます。 |
7 | 項目の連携 | 住宅借入金控除等証明書について、「年末残高」、「取得対価」、「居住用部分割合」、「取得対価」については出力しません。 |
8 | 項目の連携 | 住宅借入金控除等証明書について、「増改築等に係る年末残高」、増改築等の費用の額、増改築〜割合に関する項目は出力しません。 |
9 | 項目の連携 | 扶養控除等申告書の配偶者及び扶養親族の、「障害者である事実」に紐づく 「手帳の種類」、「交付年月日」、「障害者の移動月日」、「障害の内容」は出力しません。 |
10 | 項目の連携 | 所得金額調整控除申告書の、「申告者が特別障害者である旨及びその該当する事実」 に紐づく「障害の内容」は出力しません。 |
11 | 項目の連携 | 所得金額調整控除申告書の、「特別障害者である同一生計配偶者/扶養親族」に紐づく「障害の内容」は出力しません。 |
12 | 項目の連携 | 配偶者控除等申告書の、個人番号 は出力しません。 |
13 | 項目の連携 | 「配偶者の種別」について、SmartHRにて「今年退職手当を受け取ったことで扶養から外れた配偶者」である場合は、4が出力されます。 |
【注意事項】SmartHRから取得可能な従業員情報の取扱いについて
- 取得できる従業員の範囲・項目は、設定時に利用したSmartHRのアカウントの権限設定を反映します。目的と用途に応じた権限のSmartHRのアカウントを使って設定を行なってください。
詳しくは、*従業員関連の閲覧・作成・更新・削除の権限を設定する* を参照してください。
https://support.smarthr.jp/ja/help/articles/1500001368101/
FAQ
Q2. XMLデータに含まれる[<, >, &, ", ']のような記号が原因で給与ソフト等でインポートエラーになります。
Freeプランについて
このレシピは無料でご利用いただけるFreeプランでご提供しております。Freeプランの制約事項や有償プランへの移行は下記をご覧ください。
有償プランについて
Freeプランでは、ご利用方法の詳細なご案内やお客様個別のご要件に合わせた対応は行っておりません。下記のような対応をご希望の場合にはお問い合わせフォームよりご連絡ください。
- 人事給与システム等にそのまま取り込めるファイルを生成したい
- 人事給与システム等にAPIでダイレクト連携させたい
- 担当者による導入支援をして欲しい
- 出力ファイルの形式を変更したい
- レシピの処理内容を変更したい など
このレシピで連携できるSaaSについて
その他のSmartHR連携ができるレシピ