財務資料検索取得型 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 版をダウンロードすることができます。
アクセスできる請求書
- この API は、(Apruve のお支払いを除き) TI が処理して出荷した注文に対応する請求書を検索取得します。
- TI がご注文を処理して出荷した後、請求書が入手可能になります。
請求書を検索取得する方法:
- 情報の収集:注文番号と財務資料番号の両方が必要です。
- ご注文の確認 Eメール、または応答を使用してご注文番号を検索します (get /store/orders/{orderNumber} https://api-portal.ti.com/store-order-api)。
- ご注文の検索取得に対する応答の「invoices」(請求書) セクションで、財務資料番号を見つけます。
- 認証:貴社への割り当て済みAPIキーとシークレットを使用して、アクセストークンを取得します。
- リクエストを送信:ご注文番号、財務資料番号、貴社のアクセス トークンを含め、API に要求します。
- 請求書の受信:
- この API は、「200 OK」 ステータス コードと、請求書情報を保持する JSON 文字列を作成して応答します。
- PDF コピーを要求する場合は、base64 エンコードされた文字列として含まれます。
API のテスト:
API のテスト バージョンも使用できます。応答の中で返されるデータは、標準化されたテスト用サンプル データです。テストの場合、financialDocumentNumber (財務資料番号) として常に 5999999999 を渡す必要があります。
追加のコメント:
- Apruve によるお支払いに対応する請求書は、お客様の Apruve ポータルから直接アクセスできます。
- この API は、プッシュ型または検索取得型の実装が可能です。詳細については、「プッシュ型通知のセットアップ」をご参照ください。