財務資料検索取得 API
テスト用エンドポイント：
https://transact.ti.com/v2/store/orders/T10999999/financial-documents/5999999999/test
正式運用エンドポイント：
https://transact.ti.com/v2/store/orders/{Order Number}/financial-documents/{Invoice Number}
財務資料検索取得型 API を使用すると、Apruve 以外のお支払い方法に対応する請求書情報を取得することや、貴社の請求書の PDF 版をダウンロードすることができます。TI がご注文を処理して出荷した後、請求書が入手可能になります。財務資料検索取得型 API を使用して請求書を検索取得するには、その要求で注文番号と財務資料番号を指定する必要があります。ご注文の検索取得型に対する応答のうち、「invoices」 (請求書) セクション (get /store/orders/{orderNumber} https://api-portal.ti.com/store-order-api) で、この財務資料番号を確認できます。PDF を検索取得するには、構成オプションに関する以下の仕様をご覧ください。この API は、プッシュ型と検索取得型どちらかの実装が使用できます。プッシュ型 API は、Webhook を貴社システム宛にリアルタイムで送信し、財務資料の準備ができたことを通知します。貴社はこれを、自動化フローのトリガーとして使用できます。詳細については、「プッシュ型通知のセットアップ」をご覧ください。
お支払い方法として Apruve を使用する請求書の場合、Apruve ポータルにアクセスして請求書を直接取得することができます。
財務資料検索取得のフロー
- 財務資料が生成された後、貴社への割り当て済み API キーとシークレットを使用して認証を受けます。
- 貴社のアクセス トークンを受け取った後、注文番号と資料番号を指定して要求を送信します。アクセス トークンの有効期限が切れていない限り、そのアクセス トークンを使用して同じセッションで複数の要求を行うことができます。
- この API は、「200 OK」 ステータス コードと、資料の情報を保持する JSON 文字列を作成して応答します。
- PDF を要求した場合、その PDF は、base64 エンコードされた文字列として JSON の一部になります。
API のテスト バージョンも使用できます。応答の中で返されるデータは、標準化されたテスト用サンプル データです。テストの場合、financialDocumentNumber (財務資料番号) として常に 5999999999 を渡す必要があります。
要求の例：