法人番号システムWeb-API機能には以下3つの機能があります。
1.法人番号を指定して情報を取得
2.取得期間を指定して情報を取得
3.法人名を指定して情報を取得
参照すべき資料
申請手続きとお作法の把握には「Web-APIの利用手続について(共通編)」を参照します。
Web-API仕様関連参考資料「Web-APIのリクエストの設定方法及び提供データの内容について(概要編)」には、具体的なAPI構文とデータ仕様が記載されています。
現在APIはver4まであり、「Web-API(Ver.4.0)のリクエストの設定方法及び提供データの内容について」には以前のバージョン仕様との差分を解説しています。
仕様概要
Web-API仕様は「Web-APIのリクエストの設定方法及び提供データの内容について(概要編)」に詳しく説明がありますが仕様概要です。
下記は「1.法人番号を指定して情報を取得」の場合のAPI構文例です
https://api.houjin-bangou.nta.go.jp/4/num?id=xxxxxxxx&number=法人番号&type=yy&history=z
id=xxxxxxxxはアプリケーションIDで国税庁に事前に申請する必要があります。
numberに法人番号を指定し情報を取得します。
type=yyはレスポンスデータ形式をcsv(sjis:01、unicode:02)、xml:12で指定します。
※レスポンスデータとして、なぜかjsonはサポートされていません。
history=zは履歴の有無で0:無、1:有で指定します。
分割数の考慮
データ形式がcsvの場合一行目がヘッダー(レコード総数、分割数)、二行目以降が明細レコードとなっており、明細が2000行を超えると2000行単位で分割されます。
「2.取得期間を指定して情報を取得」と「3.法人名を指定して情報を取得」は指定の仕方によっては2000行以上になるので一行目のヘッダー記載の分割数を取得しプログラムで別途要求する事になります。
アプリケーションID申請でハマる事
国税庁法人番号Web-API利用には事前申請が必要です。申請は「アプリケーションID発行届出仮登録」ページに申請者メールアドレスを入力し仮登録を行います。本登録用のURL入りのメールが返ってきますので登録を行います。本登録を行うと「国税庁からのお知らせ【本登録完了:アプリケーションID発行届出】」という件名のメールが返ってきますが、安心してはイケません、ID発行には、もうひと手間必要です。
このアプリケーションIDは国税庁の別システム「適格請求書発行事業者公表システム」でも共通に使われているため、今回使いたい「法人番号システム」のみである事を国税庁にメールで伝達する必要があります。「適格請求書発行事業者公表システム」のWebページに記載の下記注意事項がソレです。
なお、法人番号システムWeb-APIのみの利用をご希望の方は、国税庁軽減税率・インボイス制度対応室宛てにメールにて、次の事項をご連絡ください。
利用者の氏名又は名称
アプリケーションID発行届出フォームで入力したメールアドレス
法人番号システムWeb-APIのみの利用希望である旨
次回はRPAのAutoMateを用いた法人番号Web API設定例の掲載予定です。
関連リンク
お問合せ
https://alpcom.co.jp/contact/
アルファー・コミュニケーションズ公式YouTube
https://www.youtube.com/channel/UCTqwZsRRpAs9NPTUz2yH3ow/videos