請求レポート
パートナーは、以下の卸売請求APIを使用して、 使用状況とプロビジョニングの正確性を検証するのに役立つ請求レポートを生成できます。 卸売請求APIには、developer.webex.comからアクセスできます。
-
調整-パートナーごと、顧客ごと、またはユーザーごとの使用量を表示します。 パートナーは、 このカスタム請求レポート情報を使用して毎月の請求書を調整し、 使用量に応じて顧客とユーザーに請求することができます。
-
ポイント・イン・タイム—現在のパッケージ割り当てを顧客ごと、またはユーザーごとに表示します。 ポイント・イン・タイム・レポートは、パッケージの割り当て数をリアルタイムで示します。 パートナーはこの情報を使用して、 プロビジョニングの正確性を検証し、顧客の注文と一致していることを確認できます。
パートナーは、SubPartnerOrgIDパラメーターを使用してサブパートナー向けのカスタム請求レポートを生成することもできます。
最小アクセス要件を満たすパートナー管理者が利用できるAPIは4つあります。
|
請求API |
APIの目的 |
パートナー管理者のアクセス要件 |
|---|---|---|
|
卸売請求レポートを作成してください |
請求レポートの作成に使用されます。 |
読み取り/書き込み |
|
卸売請求レポートを入手してください |
生成された請求レポートをダウンロード用に取得するために使用されます。 |
読んでください |
|
卸売請求レポートを一覧表示する |
そのパートナーについて存在する請求レポートを一覧表示するために使用されます。 |
読んでください |
|
卸売請求レポートを削除する |
既存の請求レポートを削除するために使用されます。 |
読み取り/書き込み |
データソース
請求レポートのデータは、 Webex がパートナーごとに追跡しているパッケージ割り当てと使用状況データから取得されます。 Webexは、 顧客とユーザーのパッケージデータを毎日集計して、パートナーの毎月の請求書を生成します。 請求APIはこのデータを使用して、 パートナー管理者がカスタムレポートを生成できるようにします。 これらのレポートは、パートナーが毎月の請求書から使用量をパートナー、顧客、 およびユーザーレベルで調整するのに役立ちます。
Webex がパートナーに請求する方法の詳細については、「サービスプロバイダー請求」を参照してください。
卸売請求レポートを作成してください
| 1 | |
| 2 |
次のレポートカテゴリのいずれかを選択してください。
調整レポートを生成する場合は、調整がデフォルトで選択されているので、 何も変更する必要はありません。次のステップに進むことができます。 ポイント・イン・タイム・レポートを生成したい場合は、 選択内容をポイント・イン・タイムに変更してください。 |
| 3 |
請求開始日と請求終了日を、APIで指定された形式で入力してください。 過去5年間の任意の日付を入力できますが、現在の日付は入力できません。 ポイントインタイムレポートでは、 請求開始日と請求終了日のフィールドは必須ではなく、入力しても無視されます。 レポートには常に現在のパッケージ割り当てが反映されます。 |
| 4 |
レポートの種類を入力してください:
|
| 5 |
「含める」フィールドに、レポートに表示したい追加またはオプションの列を入力します。 各レポートタイプには、必須の属性とオプションの属性があります。 各レポートに表示するオプション属性を決めることができます。 オプションの属性を含めない場合、レポートには必須の属性のみが表示されます。 次の列は、顧客とユーザーのレポートに含めるようリクエストできるオプション項目です。
これらの属性をレポートに表示するには、CUSTOMER_GROUP_IDCUSTOMER_GROUP_NAMEとを一緒に含める必要があります。 オプションの列を選択すると、顧客とユーザーの調整レポートの列の順序が変わります。 パートナーは、新しいCSV形式を受け入れるようにAPI統合を更新する必要があります。 ポイント・イン・タイム・レポートの列の順序は変わりません。 現在、列の順序を決定する際には、既存の機能設定がインクルードパラメーターよりも優先されます。 たとえば、特定の機能設定が顧客に対して有効になっている場合、その機能列は Include パラメータに追加しても、古いレポート形式に従って表示されます。 これらの設定は間もなく削除します。 削除されたら、オプションの列はIncludeパラメータでのみリクエストできます。 |
| 6 |
[実行] をクリックしてレポートを生成します。 |
| 7 |
API出力からレポートIDをコピーします。 この値をGet APIと一緒に使用して、生成された請求レポートを取得できます。 |
次にすべきこと
レポートのコピーをダウンロードするには、「卸売請求レポートを取得」セクションに移動してください。
卸売請求レポートを入手してください
請求レポートが生成されたら、このAPIを使用して特定の請求レポートを取得します。 レポートは、 GETリクエストが完了してから30分間ダウンロードできるURLに出力されます。
| 1 | |
| 2 |
レポートの一意のID値を入力して、[ 実行] をクリックします。 APIはレポートのステータスを出力します。 出力には、 レポートをダウンロードできるURLを提供するtempDownloadURLパラメーターが含まれています。 |
| 3 |
TempDownloadURLをブラウザにコピーして、 レポートにアクセスしてダウンロードしてください。 |
卸売請求レポートを一覧表示
このAPIを使用して、パートナー組織向けに生成された請求レポートのリストを取得してください。 既存のすべてのレポートを一覧表示することも、請求期間や請求タイプ(パートナー、顧客、ユーザー)などの指定されたパラメーターを満たすレポートに限定することもできます。
オプションのパラメータを入力すると、 APIは指定したパラメータと完全に一致するレポートのみを返します。 たとえば、 請求期間を指定すると、その特定の請求期間を使用したレポートのみが返されます。 期間内にあっても、 日付と完全には一致しないレポートは返されません。
| 1 | |
| 2 |
クエリパラメータに、 使用したい検索パラメータ(開始日、終了日、タイプ、並べ替え日など)を入力します。 |
| 3 |
「実行」をクリックします。 APIは、固有のレポートIDとステータス(COMPLETED、IN_PROGRESS)とともにレポートのリストを出力します。
|
次にすべきこと
ダウンロードしたいレポートのIDを記録してください。 レポートをダウンロードするには、「卸売請求レポートを取得」にアクセスしてください。
卸売請求レポートを削除する
レポートIDに基づいて生成された請求レポートを削除するには、この手順を使用してください。 レポートを削除したい例としては、次のようなものがあります。
-
既存の照合請求レポートを再作成する場合は、 まず既存のレポートを削除する必要があります。 既存のレポートを削除したら、 その期間の新しいレポートを作成できます。 生成が失敗したか、 まだ生成中の場合は、レポートを削除できません。
ポイントインタイムレポートでは、 システムがこれらのレポートを再生成しないため、既存のレポートを削除する必要はありません。 各レポートには、 常に現在のタイムスタンプ時点のデータが反映されます。
-
生成されたレポートのURLを間違った人に送った場合は、 レポートを削除してその人がアクセスできないようにすることができます。
| 1 |
developer.webex.comから、ホールセール請求レポートAPIを削除するを参照してください。 |
| 2 |
レポートIDを入力して、「 実行」をクリックしてください。 |
請求レポートのフィールド
請求レポートには次のフィールドがあります。
|
フィールド |
説明 |
サポートされているレポートタイプ |
サポートされているレポートカテゴリ |
必須またはオプションの属性 |
|---|---|---|---|---|
|
PARTNER_NAME |
パートナーの名前 |
PARTNER, CUSTOMER, USER |
調整、ポイント・イン・タイム |
必須 |
|
PARTNER_ORG_ID |
固有のパートナー識別子 |
PARTNER, CUSTOMER, USER |
調整、ポイント・イン・タイム |
必須 |
|
SUBSCRIPTION_ID |
固有のサブスクリプション識別子 |
PARTNER, CUSTOMER, USER |
調整、ポイント・イン・タイム |
必須 |
|
CUSTOMER_GROUP_ID | 顧客が所属するグループの一意の識別子。 請求期間中に顧客がグループ間で移動した場合、その期間中に顧客が所属していたグループに基づいて使用量が分割されます。 |
CUSTOMER, USER |
調整、ポイント・イン・タイム |
オプション |
|
CUSTOMER_GROUP_NAME | 顧客グループの名前を表示します。 請求期間中にグループ名が変更された場合は、最新の名前が使用されます。 |
CUSTOMER, USER |
調整、ポイント・イン・タイム |
オプション |
|
CUSTOMER_ORG_ID |
社内の顧客固有の識別子 |
CUSTOMER, USER |
調整、ポイント・イン・タイム |
必須 |
|
CUSTOMER_EXTERNAL_ID |
パートナーから提供された顧客固有の識別子 |
CUSTOMER, USER |
調整、ポイント・イン・タイム |
必須 |
|
TYPE |
ユーザーまたはワークスペースタイプ |
CUSTOMER, USER |
ポイント・イン・タイム |
必須 |
|
SUBSCRIBER_ID |
購読者の一意の識別子 |
USER |
調整、ポイント・イン・タイム |
必須 |
|
USER_ID |
サブスクライバーの Webex ユーザー ID |
USER |
調整、ポイント・イン・タイム |
必須 |
|
WORKSPACE_ID |
ユニークなワークスペース識別子 |
USER |
調整、ポイント・イン・タイム |
必須 |
|
SERVICE_NAME |
サービス名 (例えば、、COMMON_AREA_CALLING、WEBEX_CALLINGWEBEX_SUITE、WEBEX_MEETINGS) |
PARTNER, CUSTOMER, USER |
調整、ポイント・イン・タイム |
必須 |
|
SKU |
サービスのSKU |
PARTNER, CUSTOMER, USER |
調整、ポイント・イン・タイム |
必須 |
|
DESCRIPTION |
サービスの説明 |
PARTNER, CUSTOMER, USER |
調整、ポイント・イン・タイム |
必須 |
|
CONSUMPTION_START_DATE |
サービス消費の開始。 次のフィールドとともに、この値は使用期間を定義します。 |
PARTNER, CUSTOMER, USER |
和解 |
必須 |
|
CONSUMPTION_END_DATE |
サービス消費の終了。 前のフィールドに加えて、この値は使用量消費期間を定義します。 |
PARTNER, CUSTOMER, USER |
和解 |
必須 |
|
REPORT_DATE |
レポートが生成された日付と時刻。 |
CUSTOMER, USER |
ポイント・イン・タイム |
必須 |
|
QUANTITY |
パートナーごと、顧客ごと、またはユーザーごとのユーザー使用量の集計を表します(レポートとデータを表示しているレベルによって異なります)。 計算:システムは、各ユーザーの1日あたりの数量を、その日の日割り計算で計算します。 1日の使用量 = 1 半日の使用量 = 0.5 次に、請求期間内の全日の1日あたりの合計を合計して、その請求期間内のそのユーザーの合計数量を計算します。 顧客およびパートナーレベルのレポートでは、すべてのユーザーの合計が集計され、その顧客またはパートナーの合計数量が得られます。 ポイントインタイム:顧客レポートには、顧客ごとのパッケージ割り当てが一覧表示されます。 各行は、特定の顧客組織内のユーザーまたはワークスペースに割り当てられた特定のパッケージの総数量を表します。 パッケージが割り当てられていない場合、数量は「0」と表示されます。 ユーザーレポートには、ユーザーまたはワークスペースに割り当てられたパッケージが一覧表示されます。 各行には、ユーザーまたはワークスペース、および個々のパッケージまたはアドオンを表す数量1が表示されます。 複数のパッケージまたはアドオンがユーザーまたはワークスペースに割り当てられている場合、レポートには複数のエントリが表示され、それぞれの数量は1です。 |
PARTNER, CUSTOMER, USER |
調整、ポイント・イン・タイム |
必須 |
|
LOCATION_ID |
ユニークなロケーション識別子 |
CUSTOMER, USER |
調整、ポイント・イン・タイム お客様のポイント・イン・タイム・レポートにはロケーションIDは含まれていません |
オプション |
|
LICENSE_ID |
ライセンス識別子 このフィールドは卸売パッケージでのみ表示されます 調整レポートでは、License_IDこのフィールドが導入される前に割り当てられたライセンスの場合は空白です。 請求レポートには、との組み合わせが異なる場合、同じWholesaleパッケージでも複数の行が表示されますLICENSE_ID。LOCATION_ID |
CUSTOMER, USER |
調整、ポイント・イン・タイム |
オプション |
オプションの列を選択すると、顧客とユーザーの調整レポートの列の順序が変更されます。 次の順序は、サブスクリプションに卸売SKUのみのパートナーに適用されます。
ユーザーレベルのレポート— PARTNER_NAME、PARTNER_ORG_ID、SUBSCRIPTION_ID、CUSTOMER_GROUP_ID、CUSTOMER_GROUP_NAME、CUSTOMER_ORG_ID、CUSTOMER_EXTERNAL_ID、LOCATION_ID、LICENSE_ID、SUBSCRIBER_ID、USER_ID、WORKSPACE_IDSERVICE_NAME、SKU、説明、CONSUMPTION_START_DATECONSUMPTION_END_DATE、数量
顧客レベルのレポート— PARTNER_NAME、PARTNER_ORG_ID、SUBSCRIPTION_ID、CUSTOMER_GROUP_ID、CUSTOMER_GROUP_NAME、CUSTOMER_ORG_ID、、CUSTOMER_EXTERNAL_ID、LOCATION_ID、LICENSE_IDSERVICE_NAME、SKU、説明、CONSUMPTION_START_DATECONSUMPTION_END_DATE、数量
ユーザーにパッケージをプロビジョニングすると Webex Wholesale 請求がトリガーされ、パッケージの割り当てを削除すると停止します。
顧客組織は、一度に1つの顧客グループにのみ属することができます。 現在、組織ごとに複数の顧客グループをサポートすることはできません。