請求調整

パートナー管理者は、Wholesale Billing API を使用して、パートナーごと、顧客ごと、またはユーザーごとの使用量消費を表示するカスタム請求レポートを生成できます。パートナーはこの情報を使用して月次請求書を調整し、使用量に応じて顧客やユーザーに請求することができます。

パートナーは、subPartnerOrgId パラメータを使用してサブパートナーのカスタム請求レポートを生成することもできます。

最低限のアクセス要件を満たすパートナー管理者が利用できる API は 4 つあります。

課金API

APIの目的

パートナー管理者のアクセス要件

卸売請求レポートを作成する

請求レポートを生成するために使用されます。

読む / 書く

卸売請求レポートを入手する

生成された請求レポートをダウンロード用に取得するために使用されます。

読む

卸売請求レポートの一覧

そのパートナーの存在する請求レポートを一覧表示するために使用されます。

読む

卸売請求レポートを削除する

既存の請求レポートを削除するために使用されます。

読む / 書く

データ ソース

請求レポートのデータは、Webex が各パートナーに対して追跡する使用量消費データから取得されます。Webex は毎日、すべてのパートナー、顧客、ユーザーの前日の使用量を追跡し、そのデータを集計して、パートナーの月次請求書の生成に使用します。Billing API はこのデータを活用し、パートナー管理者がカスタム レポートを生成できるようにします。これにより、パートナーは月次請求書からパートナー、顧客、ユーザーのレベルで使用量を調整できます。

Webex がパートナーに請求する方法の詳細については、 サービス プロバイダーの請求を参照してください。

卸売請求レポートを作成する

この手順を使用して、請求を調整するために使用できるカスタム請求レポートを生成します。
1

卸売請求レポート API の作成に進みます。

2

API が指定する形式で billingStartDatebillingEndDate の値を入力して、請求期間を入力します。過去 5 年間の任意の日付を入力できますが、現在の日付は入力できません。

3

レポートの タイプ を入力してください:

  • PARTNER (デフォルト) - パートナー レベルでの使用状況を表示します。
  • 顧客 - パートナーの下にある顧客組織のレベル別に分類された合計使用量が表示されます。
  • ユーザー - パートナーの顧客組織および加入者のレベル別に分類された合計使用量が表示されます。
4

実行 をクリックしてレポートを生成します。

5

API出力からレポート id をコピーします。生成された請求レポートを取得するには、Get API でこの値を使用できます。

次に行うこと

レポートのコピーをダウンロードするには、 卸売請求レポートを取得する にアクセスしてください。

卸売請求レポートを入手する

請求レポートが生成されたら、この API を使用して特定の請求レポートを取得します。レポートは URL に出力され、GET リクエストの完了後 30 分間ダウンロードできます。
1

卸売請求レポート API を取得するに移動します。

2

GET 行で、 id ボタンをクリックし、レポートの一意の ID 値を入力します。

3

[実行] をクリックします。

4

API はレポートのステータスを出力します。出力には tempDownloadURL パラメータが含まれており、レポートをダウンロードできる URL が提供されます。

5

レポートにアクセスしてダウンロードするには、 tempDownloadURL をブラウザにコピーします。

卸売請求レポートの一覧

この API を使用して、パートナー組織に対して生成された請求レポートのリストを取得します。既存のレポートをすべて一覧表示することも、請求期間や請求タイプ (パートナー、顧客、ユーザー) などの指定されたパラメータを満たすレポートのみに一覧表示を制限することもできます。

オプションのパラメータを入力すると、API は入力したパラメータと完全に一致するレポートのみを返します。たとえば、請求期間を入力すると、その特定の請求期間を使用するレポートのみが返されます。期間内にあっても日付が完全に一致しないレポートは返されません。
1

リスト卸売請求レポートAPIに移動

2

クエリ パラメータの下に、使用する検索パラメータ (startDate、endDate、Type、sortBy など) を入力します。これらのパラメータの詳細については、API の開発者ヘルプを参照してください。

3

[実行] をクリックします。

API は、一意のレポート ID とステータス (COMPLETED、IN_PROGRESS) とともにレポートのリストを出力します。

次に行うこと

ダウンロードするレポートの id を記録します。レポートをダウンロードするには、 卸売請求レポートを取得する にアクセスしてください。

卸売請求レポートを削除する

レポート ID に基づいて生成された請求レポートを削除するには、この手順を使用します。レポートを削除する必要がある例としては、次のようなものがあります。

  • 既存の請求レポートを再生成する場合は、まず既存のレポートを削除する必要があります。既存のレポートを削除した後、その期間の新しいレポートを作成できます。レポートが失敗した場合や進行中の場合は、削除要件は存在しないことに注意してください。

  • レポートが生成され、その URL を間違った人に送信した場合は、レポートを削除すると、その人はレポートにアクセスできなくなります。

1

卸売請求レポート削除 API に移動します。

2

レポート IDを入力します。

3

[実行] をクリックします。

請求レポートのフィールド

請求レポートには次のフィールドが含まれます。

フィールド

付加情報

次のようなレポートに表示されます

パートナー_名

パートナーの名前

パートナー、顧客、ユーザー

パートナー_組織_ID

固有のパートナー識別子

パートナー、顧客、ユーザー

サブスクリプション_ID

一意のサブスクリプション識別子

パートナー、顧客、ユーザー

サービス_名

サービス名

(例: COMMON_AREA_CALLING、WEBEX_CALLING、WEBEX_SUITE、WEBEX_MEETINGS)

パートナー、顧客、ユーザー

SKU

サービスのSKU

パートナー、顧客、ユーザー

説明

サービスの説明

パートナー、顧客、ユーザー

消費開始日__

サービス消費の開始。この値は次のフィールドとともに使用期間を定義します。

パートナー、顧客、ユーザー

消費_終了_日

サービス利用の終了。この値は、前のフィールドとともに、使用消費期間を定義します。

パートナー、顧客、ユーザー

パートナーごと、顧客ごと、またはユーザーごとの集計されたユーザー使用状況消費量を表します (レポートとデータを表示するレベルによって異なります)。

計算:

各ユーザーの 1 日あたりの使用量を、その日の按分計算で計算します。

1日中の使用 = 1

半日使用 = 0.5

請求期間内のすべての日の 1 日あたりの合計を合計して、その請求期間内のそのユーザーの合計量を計算します。

顧客レベルおよびパートナー レベルのレポートでは、すべてのユーザーの合計が集計され、その顧客またはパートナーの合計数量が示されます。

パートナー、顧客、ユーザー

顧客_組織_ID

社内顧客固有識別子

顧客、ユーザー

顧客_外部_ID

パートナーが提供する顧客固有識別子

顧客、ユーザー

加入者_ID

加入者の一意の識別子

USER

USER_ID

加入者のWebexユーザーID

USER

ワークスペース_ID

一意のワークスペース識別子

USER

場所_ID

固有の位置識別子

顧客、ユーザー

ライセンス_ID

ライセンス識別子

このフィールドは卸売パッケージの場合にのみ表示されます。このフィールドが導入される前に割り当てられたライセンスの場合、License_ID は空白になります。

請求レポートには、同じ卸売パッケージに対して複数の行が表示される場合があり、各行は一意の package/license IDの組み合わせ。

LICENSE_IDフィールドが存在する場合、各行は一意の package/location/license IDの組み合わせ。

顧客、ユーザー

ユーザーにパッケージをプロビジョニングすると Webex Wholesale の課金が開始され、パッケージの割り当てを削除すると課金が停止します。