適格請求書発行事業者公表システムWeb-API検証環境の提供について
国税庁では、利用者が構築するシステムのインターフェース検証テストのために、検証環境を提供しています。
1 検証環境の概要
検証環境では、利用者が構築するシステムからのリクエストに対し、Web-APIの検証用サーバより、サンプルデータ(架空の適格請求書発行事業者のデータ)を応答します。
2 検証環境の利用方法
検証環境にはアプリケーションIDが必要になります。
国税庁からお知らせした「アプリケーションID」を以下のリクエストフォーマットに設定し送信することで検証環境を利用することができます。リクエストフォーマットに設定する「バージョン」及び「条件」は本番環境と同様となりますので、当サイトで公開している「適格請求書発行事業者公表システムWeb-API機能のリクエストの設定方法及び提供データの内容について(Ver.1.0)」を参照してください。
適格請求書発行事業者公表システムWeb-API機能のリクエストの設定方法及び提供データの内容について(Ver.1.0)(令和6年5月改訂)(PDF:755KB)
- Web-API機能別リクエストフォーマット
登録番号を指定して情報を取得する機能 |
---|
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ステータスコード及びエラーコード
リクエストに誤りがある場合などには、HTTPステータスコードのほか、エラーコード及びエラーメッセージをCSV形式で応答します。
エラーコードの値や内容については、当サイトで公開している「適格請求書発行事業者公表システムWeb-API機能のリクエストの設定方法及び提供データの内容について(Ver.1.0)」を参照してください。
適格請求書発行事業者公表システムWeb-API機能のリクエストの設定方法及び提供データの内容について(Ver.1.0)(令和6年5月改訂)(PDF:755KB)
3 検証環境利用時の留意事項
Web-API検証環境では、当サイトで公開しているサンプルデータと同様のデータで検証することができます。
なお、サンプルデータの「最終更新年月日」は令和5年11月13日としています。
サンプルデータをご利用いただく際には、以下の事項にご留意ください。
- 検証環境で「取得期間を指定して情報を取得する機能」を利用して指定した期間において更新された登録年月日、取消年月日及び失効年月日に係る履歴情報を取得し、データの更新を検証する場合には、事前に、当サイトで公開しているサンプルデータから、全件データを取り込む必要があります。
ファイル格納場所:k-sample-dl-r0310 ⇒ 01_ダウンロード機能 ⇒ 01_全件データ
- 別添「全件データの概要」及び「差分データの概要」に記載されているデータのうち、以下のレコードは、仕様上、Web-APIで取得するデータには含まれません。
更新年月日 | ケース番号 | 備考 |
---|---|---|
全件データ 令和5年9月29日 |
6 | 対象の公表情報について、令和5年10月20日の差分データのダウンロードファイルにおいて、事業者処理区分が「99:削除」のデータとして提供されている。事業者処理区分については、適格請求書発行事業者公表システムリソース定義書(ダウンロードファイル、Web-API機能)の項番9を参照。 |
22 |
適格請求書発行事業者公表システムWeb-API機能のリクエストの設定方法及び提供データの内容について(Ver.1.0)(令和6年5月改訂)(PDF:755KB)
4 利用規約
検証環境を利用するには、利用規約に同意する必要があります。
現在、当サイトで公開している以下の利用規約等は、検証環境においても適用されますので、事前に利用規約等をご一読いただき、利用規約等に同意された場合にのみ、検証環境をご利用ください。
なお、以下の利用規約等は「適格請求書発行事業者公表システムWeb-API機能の利用手続について」でもご確認いただけます。
適格請求書発行事業者公表システムWeb-API機能の利用手続について(PDF:1,141KB)
検証環境利用時に適用される規約及び個人情報保護方針
- 適格請求書発行事業者公表システムWeb-API機能の利用規約
- 国税庁適格請求書発行事業者公表サイト及び適格請求書発行事業者公表システムWeb-API機能に係る個人情報保護方針
- 国税庁適格請求書発行事業者公表サイト利用規約
Web-API検証環境の利用に関する注意事項
- サンプルデータは、登録番号を活用するためのシステムの開発・改修等以外の用途でのご利用はご遠慮ください。
- サンプルデータは、システム開発・改修等以外で第三者に貸与・譲渡しないでください。
- Webブラウザを介してWeb-API機能を利用した場合には、取得したデータを表示できない事象が発生することがあります。なお、Javaアプリケーションなどのシステムやプログラムからリクエストを送信する場合には、同事象は発生することはありません。