請求書レンダリングテンプレート
請求書レンダリングテンプレートを使用して、顧客ごとに請求書のデザインをパーソナライズする
特定の顧客グループに対して、請求書の内容を調整できます。以下に例を挙げます。
- 特定の国の顧客に対して、請求書のフッターフィールドに特定のテキストを表示する
- 特定の収益チャネルの顧客向けに特定のメモを表示する
- 複雑な取引を行う顧客のために、ラインアイテムを一定の方法でグループ化する
このガイドでは、請求書テンプレートを使用して以下を行う方法を説明します。
- 関連するすべての請求書について入力する代わりに、請求書フィールドの共通の値を保存して再利用する
- 大規模な顧客に適用される請求書のフィールド値を保存、管理、更新する
- 請求書テンプレート以外に設定できない、ラインアイテムのグループ化ルールを設定する
- サブスクリプションの請求書の場合、請求書を直接操作せずに請求書の値をカスタマイズします
テンプレートを設定する
請求書テンプレートはダッシュボードでのみ作成できます。 API を使用して作成することはできません。
- 請求書設定で、請求書テンプレートタブを選択します。
- + テンプレートを作成をクリックします。
- テンプレートの名前を入力します。
- テンプレートに含めるフィールドの値を指定します。テンプレートはメモ、フッター、カスタムフィールドに対応します。
- 必要に応じて、Common Expression Language (CEL) の式を使用して 1 つ以上のラインアイテムグループを定義することができます。
- テンプレートのプレビューを表示するには、プレビューペインの請求書 ID フィールドに該当する請求書の ID を入力します。ただし、その請求書に直接設定された値は、対応するテンプレートの値を上書きします。たとえば、請求書にフッターの値がある場合、プレビューには、テンプレートのフッターではなく、請求書のフッターが表示されます。
テンプレートを請求書に適用する
テンプレートを上書きして更新する
請求書のフッター、メモ、カスタムフィールドの値は複数の場所で設定できます。1 つの請求書のフィールドに複数の値が適用される可能性がある場合は、高いものから低いものへと、次の順序で優先付けされます。
| 優先順位 | 設定 | メソッド |
|---|---|---|
| 1 | 請求書に対して | ダッシュボードまたは API |
| サブスクリプションに対して | ダッシュボードのみ | |
| 2 | 請求書に適用されるテンプレート | ダッシュボードまたは API |
| サブスクリプションに適用されるテンプレート | ダッシュボードのみ | |
| 3 | 顧客に関連付けられたテンプレート | ダッシュボードまたは API |
| 4 | 顧客の請求書設定 | API のみ |
| 5 | アカウントの請求書設定 | ダッシュボードのみ |
注
定義された請求書設定は、優先度の高い設定で上書きされない限り、常に適用されます。たとえば、請求書テンプレートが添付されている顧客の場合を考えてみましょう。添付されているテンプレートを使用せずに顧客用に 1 回限りの請求書を作成するには、別のテンプレートを請求書に適用するか、請求書の値を直接設定する必要があります。
テンプレートを更新または置換すると、そのテンプレートに関連付けられているそれ以降のすべての請求書に新しい値が適用されます。たとえば、既存のサブスクリプションを持つ顧客がいて、その顧客に請求書テンプレートが関連付けられており、それを上書きするサブスクリプションテンプレートはないとします。顧客のテンプレートの値を更新すると、新しい値は、その顧客の既存のサブスクリプションの今後の請求書に適用されます。