請求書PDF・添付ファイル取得API｜BtoBプラットフォームのインフォマート

指定した請求書のPDF及び添付ファイルを取得する。

項目	内容
プロトコル	HTTPS
メソッド	GET
ポート番号	443
タイムアウト	300秒
URL	https://api.infomart.co.jp/v1/invoice/buyer/invdata/files
インターフェースバージョン	v1

※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）

パラメータ名	名前	型	長さ・範囲	必須	備考
response_type	レスポンス形式	文字列	4	○	"json" "xml"
invoice_mng_num	請求書管理番号	半角数字	10	○	BtoB PF請求書システムで請求書を一意に識別するキー請求書管理番号は請求データ取得APIで取得が可能。
invoice_pdf_get_flg	請求書PDF取得	半角数字	1	○	請求書PDFを取得するか 0:取得しない 1:取得する
attached_file_get_flg	添付ファイル取得	半角数字	1	○	請求書に添付されているファイルを取得するか 0:取得しない 1:取得する

※必須項目の○は必須、△は条件付き必須となる（条件は備考を参照）

要素名・階層	要素内容	型	必須	備考
result	処理結果	文字列	○	"ok" または "warn" 明細またはカスタム明細が1,000件を超える場合は"warn"が設定される。
error_list[]	エラーリスト	配列
error_item	エラー項目	文字列		処理結果が"warn"時に出力
error_code	エラーコード	文字列		処理結果が"warn"時に出力
error_detail	エラー内容	文字列		処理結果が"warn"時に出力
invoice_pdf	請求書PDF	オブジェクト
file	ファイル	文字列		対象の請求書PDF BASE64形式で出力
file_name	ファイル名	文字列		対象の請求書PDF名
seller_attached_file[]	発行側添付ファイル	配列
file	ファイル	文字列		発行側で添付したファイル BASE64形式で出力
file_name	ファイル名	文字列		発行側で添付したファイル名称

要素名・階層	要素内容	型	必須
result	処理結果	文字列	○
error_list[]	エラーリスト	配列	○
error_item	エラー項目	文字列
error_code	エラーコード	文字列	○
error_detail	エラー内容	文字列	○

API利用ユーザーが有料会員かチェックを行う。
受取側企業有料会員ではない場合、HTTPステータスコード「403 Forbbiden」を返却する。

リクエストの内容に対し、不備がないか確認を行う。
不備があった場合、HTTPステータスコード「400 Bad Request」を返却する。

リクエストに該当する請求書のPDF及び添付ファイルを取得する。

処理結果をJSON/XML形式で返却する。

請求書PDF取得時に対象請求書の明細件数またはカスタム明細件数が1,000件を超えて場合
該当する情報のPDFは印刷されずエラー情報に警告メッセージが出力される。