検証環境について
国税庁では、利用者が構築するシステムとのインターフェース検証のため、検証環境を提供しています。
本ページは、適格請求書発行事業者公表システムWeb-API機能の検証環境について、次の構成で説明を行います。
1．概要
検証環境では、利用者が構築するシステムからのリクエストに対し、Web-APIの検証用サーバより、サンプルデータ（架空の適格請求書発行事業者のデータ）を応答します。
２．利用方法
検証環境にはインボイス用アプリケーションIDが必要になります。
国税庁からお知らせしたインボイス用アプリケーションIDを、以下のリクエストフォーマットに設定し送信することで検証環境を利用することができます。利用方法の詳細は、「４．関連資料」の「第二編：リクエストの設定方法及び提供データの内容について」をご確認ください。
| 登録番号を指定 |
|---|
| https://kensyo.invoice-kohyo.nta.go.jp/【バージョン】/num?id=【アプリケーションID】&【条件】 |
| 取得期間を指定 |
| https://kensyo.invoice-kohyo.nta.go.jp/【バージョン】/diff?id=【アプリケーションID】&【条件】 |
| 登録番号と日付を指定 |
| https://kensyo.invoice-kohyo.nta.go.jp/【バージョン】/valid?id=【アプリケーションID】&【条件】 |
（注１）上記のリクエストフォーマットは本番環境で使用するものと異なりますので、ご注意ください。
（注２）リクエストフォーマットに設定する「バージョン」及び「条件」は本番環境と同様となります。
（注３）リクエスト誤り等の場合、HTTPステータスコードのほか、エラーコード及びエラーメッセージをCSV形式で応答します。
３．サンプルデータ
Web-API検証環境では、次のサンプルデータと同様のデータで検証することができます。
なお、サンプルデータの「最終更新年月日」は令和５年11月13日としています。
サンプルデータをご利用いただく際には、以下の事項にご留意ください。
- 検証環境で、取得期間を指定して取得したデータの更新を検証する場合には、事前にサンプルデータから、全件データを取り込む必要があります。
＜ファイル格納場所＞ k-sample-dl-r0310 ⇒ 01_ダウンロード機能 ⇒ 01_全件データ
- 「提供するサンプルデータについて」の「全件データの概要」及び「差分データの概要」に記載されているデータのうち、次のレコードは、仕様上Web-APIで取得するデータには含まれません。
| 更新年月日 | ケース番号 | 備考 |
|---|---|---|
全件データ 令和５年９月29日 |
６ | 対象の公表情報について、令和５年10月20日の差分データのダウンロードファイルにおいて、事業者処理区分が「99：削除」のデータとして提供されている。事業者処理区分については、適格請求書発行事業者公表システムリソース定義書（ダウンロードファイル、Web-API機能）の項番9を参照。 |
| 22 |
注意事項
- サンプルデータは、登録番号を活用するためのシステムの開発・改修等以外の用途でのご利用はご遠慮ください。
- サンプルデータは、システム開発・改修等以外で第三者に貸与・譲渡しないでください。
- Webブラウザを介してWeb-API機能を利用した場合には、取得したデータを表示できない事象が発生することがあります。なお、Javaアプリケーションなどのシステムやプログラムからリクエストを送信する場合には、同事象は発生することはありません。
4．関連資料
詳細については、次の資料をご確認ください。
第一編：Web-API機能の利用手続について（PDF：7,830KB）
第二編：リクエストの設定方法及び提供データの内容について（PDF：4,385KB）
５．利用規約
検証環境を利用するには、利用規約等に同意する必要があります。
現在、当サイトで公開している以下の利用規約等は、検証環境においても適用されます。検証環境をご利用になる前に、改めてご一読いただき、利用規約等に同意された場合にのみ、ご利用ください。
検証環境利用時に適用される規約及び個人情報保護方針
- 適格請求書発行事業者公表システムWeb-API機能の利用規約
- 国税庁適格請求書発行事業者公表サイト及び適格請求書発行事業者公表システムWeb-API機能に係る個人情報保護方針
- 国税庁適格請求書発行事業者公表サイト利用規約