契約テンプレートの新機能：API経由でテンプレートを複数顧客に一括適用

1回のAPIコールで最大100件の顧客に対してドラフト契約を作成できます。

Consoleでは、契約テンプレートの顧客への適用は1つの操作で完了します。テンプレートを選び、顧客を選べば、顧客ごとにドラフト契約が作成されます。一方、API経由ではこれまでループ処理が必要でした。テンプレートを読み取り、課金ルール・プライスブック・カスタム明細項目を契約作成リクエストのボディにコピーし、顧客ごとに繰り返す必要があったのです。

Contract Templates APIで、Consoleと同じことができるようになりました。POST /billing/v1/contract-templates/{templateID}/contracts を1回呼び出すだけで、バッチ内の各顧客に対してドラフト契約が作成されます。テンプレートの課金ルール、プライスブック、カスタム明細項目は最初から反映済みです。

• バッチ適用： 1リクエストあたり最大100件の顧客を送信できます。顧客ごとに個別の結果が返るため、適用対象外の顧客が1件あっても他の処理は止まりません。
• ドライラン： dryRun=true を付けると、何も作成せずにバッチ全体を検証できます。まずはドライランの実行をおすすめします。実際の呼び出しでは、同じテンプレートから作成済みのドラフトを持つ顧客に対しても、毎回新しいドラフトが作成されます。
• 単一顧客での作成： Contracts APIで契約を作成する際に templateId を渡すと、1回の呼び出しでテンプレートを適用できます。テンプレートのコンポーネントは全体をまとめて適用する仕組みのため、リクエスト側で独自の課金ルール、プライスブック、カスタム明細項目を指定すると、そのリクエストは拒否されます。

すべての契約はドラフトとして作成されます。確認と有効化は、従来どおりの手順で行えます。

利用を開始するには、エンドポイントとリクエスト例についてAPIリファレンスを、テンプレートの仕組みについて契約テンプレートガイドをご覧ください。APIの呼び出しには、External APIへのアクセス権とContract Templates Admin権限が必要です。

PartnerOps Revenue Managementをご利用のディストリビューターおよびリセラーの皆さまにご利用いただけます。