卸売ルート・トゥ・マーケット請求レポート
請求レポート
パートナーは、次の卸売請求 API を使用して、使用状況とプロビジョニングの正確さを検証するのに役立つ請求レポートを生成できます。卸売請求 API は developer.webex.com からアクセスできます。
-
調整 - パートナーごと、顧客ごと、またはユーザーごとのレベルで使用量の消費を表示します。パートナーは、このカスタム請求レポート情報を使用して月次請求書を調整し、使用量に応じて顧客やユーザーに請求することができます。
-
ポイントインタイム - 顧客ごとまたはユーザーごとの現在のパッケージ割り当てを表示します。ポイントインタイム レポートは、パッケージ割り当てのリアルタイム カウントを提供します。パートナーはこの情報を使用してプロビジョニングの正確性を検証し、顧客の注文との整合性を確保できます。
パートナーは、subPartnerOrgId パラメータを使用してサブパートナーのカスタム請求レポートを生成することもできます。
最低限のアクセス要件を満たすパートナー管理者が利用できる API は 4 つあります。
|
課金API |
APIの目的 |
パートナー管理者のアクセス要件 |
|---|---|---|
|
卸売請求レポートを作成する |
請求レポートを生成するために使用されます。 |
Read/write |
|
卸売請求レポートを取得する |
生成された請求レポートをダウンロード用に取得するために使用されます。 |
既読 |
|
卸売請求レポートの一覧 |
そのパートナーの存在する請求レポートを一覧表示するために使用されます。 |
既読 |
|
卸売請求レポートを削除する |
既存の請求レポートを削除するために使用されます。 |
Read/write |
データソース
請求レポートのデータは、Webex が各パートナーに対して追跡するパッケージの割り当てと使用状況データから取得されます。Webex は顧客とユーザーのパッケージ データを毎日集計し、パートナーの月次請求書を生成します。Billing API はこのデータを使用することで、パートナー管理者がカスタム レポートを生成できるようになります。これらのレポートは、パートナーがパートナー、顧客、ユーザーのレベルで月次請求書の使用量を調整するのに役立ちます。
Webex がパートナーに請求する方法の詳細については、 サービス プロバイダーの請求を参照してください。
卸売請求レポートを作成する
| 1 |
developer.webex.comから 卸売請求レポート API の作成に移動します。 |
| 2 |
次のいずれかのレポート カテゴリを選択します。
調整レポートを生成する場合は、調整がデフォルトで選択されているため、何も変更する必要はありません。次の手順に進むことができます。ポイントインタイムレポートを生成する場合は、選択をポイントインタイムに変更します。 |
| 3 |
billingStartDate と billingEndDate を API が指定する形式で入力します。過去 5 年間の任意の日付を入力できますが、現在の日付は入力できません。 ポイントインタイムレポートの場合、 billingStartDate フィールドと billingEndDate フィールドは必須ではなく、入力しても無視されます。レポートには常に現在のパッケージ割り当てが反映されます。 |
| 4 |
レポートの タイプ を入力してください:
|
| 5 |
実行 をクリックしてレポートを生成します。 |
| 6 |
API出力からレポート id をコピーします。この値を Get API で使用すると、生成された請求レポートを取得できます。 |
次に行うこと
レポートのコピーをダウンロードするには、 卸売請求レポートの取得 セクションに移動してください。
卸売請求レポートを取得する
請求レポートが生成されたら、この API を使用して特定の請求レポートを取得します。レポートは URL に出力され、GET リクエストの完了後 30 分間ダウンロードできます。
| 1 |
developer.webex.comから 卸売請求レポート API の取得に移動します。 |
| 2 |
レポートの一意の id 値を入力し、 実行をクリックします。 API はレポートのステータスを出力します。出力には tempDownloadURL パラメータが含まれており、レポートをダウンロードできる URL が提供されます。 |
| 3 |
レポートにアクセスしてダウンロードするには、 tempDownloadURL をブラウザにコピーします。 |
卸売請求レポートの一覧
この API を使用して、パートナー組織に対して生成された請求レポートのリストを取得します。既存のレポートをすべて一覧表示することも、請求期間や請求タイプ (パートナー、顧客、ユーザー) などの指定されたパラメータを満たすレポートのみに一覧表示を制限することもできます。
オプションのパラメータを入力すると、API は指定したパラメータと完全に一致するレポートのみを返します。たとえば、請求期間を指定すると、その特定の請求期間を使用するレポートのみが返されます。期間内にあっても日付が完全に一致しないレポートは返されません。
| 1 |
developer.webex.comから List Wholesale Billing Report APIに移動します。 |
| 2 |
クエリ パラメータの下に、使用する検索パラメータ (startDate、endDate、Type、sortBy など) を入力します。 |
| 3 |
[実行] をクリックします。 API は、一意のレポート ID とステータス (COMPLETED、IN_PROGRESS) とともにレポートのリストを出力します。
|
次に行うこと
ダウンロードするレポートの id を記録します。レポートをダウンロードするには、 卸売請求レポートを取得する にアクセスしてください。
卸売請求レポートを削除する
レポート ID に基づいて生成された請求レポートを削除するには、この手順を使用します。レポートを削除する必要がある例としては、次のようなものがあります。
-
既存の調整請求レポートを再生成する場合は、まず既存のレポートを削除する必要があります。既存のレポートを削除した後、その期間の新しいレポートを作成できます。レポートの生成が失敗した場合やまだ進行中の場合は、レポートを削除することはできません。
ポイントインタイム レポートの場合、システムによってレポートが再生成されないため、既存のレポートを削除する必要はありません。各レポートには常に現在のタイムスタンプ時点のデータが反映されます。
-
生成されたレポートの URL を間違った人に送信した場合は、その人がアクセスできないようにレポートを削除することができます。
| 1 |
developer.webex.comから Delete Wholesale Billing Report APIに移動します。 |
| 2 |
レポート ID を入力し、 実行をクリックします。 |
請求レポートのフィールド
請求レポートには次のフィールドが含まれます。
|
フィールド |
説明 |
サポートされているレポートタイプ |
サポートされているレポートカテゴリ |
|---|---|---|---|
|
パートナー_名 |
パートナーの名前 |
パートナー、顧客、ユーザー |
調整、ポイントインタイム |
|
パートナー_組織_ID |
固有のパートナー識別子 |
パートナー、顧客、ユーザー |
調整、ポイントインタイム |
|
サブスクリプション_ID |
一意のサブスクリプション識別子 |
パートナー、顧客、ユーザー |
調整、ポイントインタイム |
|
サービス_名 |
サービス名 (例: COMMON_AREA_CALLING、WEBEX_CALLING、WEBEX_SUITE、WEBEX_MEETINGS) |
パートナー、顧客、ユーザー |
調整、ポイントインタイム |
|
SKU |
サービスのSKU |
パートナー、顧客、ユーザー |
調整、ポイントインタイム |
|
説明 |
サービスの説明 |
パートナー、顧客、ユーザー |
調整、ポイントインタイム |
|
消費開始日__ |
サービス消費の開始。この値は次のフィールドとともに使用期間を定義します。 |
パートナー、顧客、ユーザー |
調整 |
|
消費_終了_日 |
サービス利用の終了。この値は、前のフィールドとともに、使用消費期間を定義します。 |
パートナー、顧客、ユーザー |
調整 |
|
量 |
パートナーごと、顧客ごと、またはユーザーごとの集計されたユーザー使用量消費を表します (レポートとデータを表示するレベルによって異なります)。 計算:システムは、各ユーザーの 1 日あたりの量をその日の按分に基づいて計算します。 1日の使用 = 1 半日の使用 = 0.5 次に、請求期間内のすべての日の 1 日あたりの合計を合計し、その請求期間内のそのユーザーの合計量を計算します。 顧客レベルおよびパートナー レベルのレポートでは、すべてのユーザーの合計が集計され、その顧客またはパートナーの合計数量が示されます。 ポイントインタイム: 顧客レポートには、顧客ごとのパッケージ割り当てがリストされます。各行は、特定の顧客組織内のユーザーまたはワークスペースに割り当てられた特定のパッケージの合計数量を表します。割り当てられたパッケージがない場合、数量は「0」と表示されます。 ユーザー レポートには、ユーザーまたはワークスペースに割り当てられたパッケージが一覧表示されます。各行には数量 1 が表示され、ユーザーまたはワークスペースと、その個別のパッケージまたはアドオンを表します。複数のパッケージまたはアドオンがユーザーまたはワークスペースに割り当てられている場合、レポートには複数のエントリが表示され、それぞれに数量が表示されます。1. |
パートナー、顧客、ユーザー |
調整、ポイントインタイム |
|
顧客_組織_ID |
社内顧客固有識別子 |
顧客、ユーザー |
調整、ポイントインタイム |
|
顧客_外部_ID |
パートナーが提供する顧客固有の識別子 |
顧客、ユーザー |
調整、ポイントインタイム |
|
加入者_ID |
加入者の一意の識別子 |
USER |
調整、ポイントインタイム |
|
USER_ID |
加入者のWebexユーザーID |
USER |
調整、ポイントインタイム |
|
ワークスペース_ID |
一意のワークスペース識別子 |
USER |
調整、ポイントインタイム |
|
場所_ID |
固有の位置識別子 |
顧客、ユーザー |
調整、ポイントインタイム |
|
ライセンス_ID |
ライセンス識別子 このフィールドは卸売パッケージにのみ表示されます 調整レポートの場合、このフィールドが導入される前に割り当てられたライセンスの License_ID は空白になります。 請求レポートでは、LOCATION_ID と LICENSE_ID の異なる組み合わせに関連付けられている場合、同じ卸売パッケージに対して複数の行が表示されます。 |
顧客、ユーザー |
調整、ポイントインタイム |
|
レポート_日付 |
レポートが生成された日時。 |
顧客、ユーザー |
ポイントインタイム |
ユーザーにパッケージをプロビジョニングすると Webex Wholesale の課金が開始され、パッケージの割り当てを削除すると課金が停止します。