料金系マスタメンテナンス機能概要
料金系マスタ概要#
主要マスタテーブル一覧#
| マスタ名 | 役割 |
|---|---|
| サービスマスタ | 契約時に選択するサービス情報（サービス名・商品種別・バージョン・表示順 他）を定める |
| 料金プランマスタ | サービス情報と料金形態を紐付ける |
| 料金マスタ | 料金表、および割引表の組み合わせにより料金形態（料金名・付加情報）を定める 料金形態における端数処理方法を定める |
| 計算要素マスタ | 料金表の計算要素を定める 料金表の種別（定額料金・従量料金・割引）を定める |
| 料金表マスタ | 料金表（金額・単位・数量 他）を定める 日割計算方法を定める 日割計算における端数処理を定める |
| 割引表マスタ | 割引表(割引額・割引率 他)を定める |
主要料金系マスタ関連図#
ＥＲ図#
紐付きイメージ#
※各値は分かりやすいような記述にしているため実際の設定値体系とは異なります。
※管理番号についてはAPIリファレンスを参照してください。
料金形態パターン#
実現可能な料金形態#
料金計算要点#
料金表マスタ設定の仕方#
料金表マスタの設定例－定額#
料金表最高金額を設定し、料金表を実現します。
料金表イメージ#
定額の基本式 （ b is null ）#
料金表マスタの設定例－従量#
料金要素ＦＲＯＭ・料金要素ＴＯを適用したい利用量の範囲で設定し、利用量ごとに区切られた料金表を実現します。
※ x : 利用量（数量）とすると、「料金要素FROM ＜ x ≦ 料金要素TO」に該当するレコードが使用される。
料金表イメージ#
従量の基本式 （ x － m ＞ 0 の場合 ）#
組み合せによる料金形態の実現方法#
異なる料金表の組み合せによる実現方法の例
割引表マスタ設定の仕方#
割引設定の種類#
-
料金プラン全体に対して割引を付けるパターン(合算)
-
料金レコードに対して割引を付けるパターン(個別)
※割引対象計算要素コードを設定しない場合は1. となる
※1. と2. の割引パターンの同時適用は不可
割引表の設定例#
端数処理について#
料金計算時に発生する端数の扱い方を指定します。
端数処理の種類#
- 端数処理 ：計算した料金の端数処理
- 単位数端数処理：従量時の利用量の端数処理
- 日割端数処理 ：日割り計算した料金の端数処理
端数処理の例#
| 端数処理区分 | 端数処理桁数 | 端数処理前の料金 | 端数処理後の料金 |
|---|---|---|---|
| 1 (切上げ) |
D01 (小数点第1位) |
1,000.123円 | 1,001円 |
| 3 (四捨五入) |
I03 (整数第3桁) |
12,345.5円 | 12,000円 |
■ 注意事項
-
従量の場合は必ず端数処理の指定をする必要があります。
-
端数処理区分を調整なし(0)に指定する場合、端数処理桁数は指定不要となります。
※日割計算や単位数計算の端数処理についても同様の設定を行います。
※端数処理区分、端数処理桁数の設定値の詳細はコード一覧を参照して下さい。
日割りについて#
締め期間中にサービス開始日、または終了日を基準とした日割計算をする場合は以下の項目を設定します。
※日割りは請求タイミングが「1：後払い」、且つ計算要素区分が「01：定額料金」のサービスの場合のみ実施可能です。
例：サービス開始が2017年4月3日で、4月分の料金計算を行う場合
各種サービス日付設定#
料金プランマスタにて各種サービスの開始日／終了日設定が可能です。
日付はサービス契約登録日／解約日を基準とした任意の日数を指定できます。
設定可能な開始日／終了日の種別一覧#
| 項目名 | 基準日 | 設定的曜日 |
|---|---|---|
| 適用開始日種別 | 登録日 | サービス提供の開始日付 |
| 適用終了日種別 | 解約日 | サービス提供の終了日付 |
| 課金開始日種別 | 登録日 | サービス利用による課金の開始日付 |
| 課金終了日種別 | 解約日 | サービス利用による課金の終了日付 |
| 料金プラン変更開始日種別 | 登録日 | サービス変更後、変更内容の適用開始日付 |
開始日／終了日の設定（例：適用開始日種別）#
マスタの内容変更について#
料金系マスタは料金計算期間内（締め期間）で一貫性を保つように設定してください。
※料金計算期間内に内容を変更しようとした場合、エラーが返却されます。次回の締日翌日が変更日となるよう設定してください。
- ＯＫ
- ＮＧ（チェックエラー）
※上記例は月末締めの場合を想定しています。
前払い・後払いについて#
計算要素マスタの請求タイミングと請求加算月数で前払い、後払いの設定が可能です。また計算要素区分によって課金形態を５種類に分類します。
請求タイミング、請求加算月数と計算要素区分の関係#
※前払いが行えるのは定額料金、年額定額料金、一時料金のみです。
請求加算月数について#
料金計算時に締期間を請求加算月数によって仮想締期間を作成し、契約情報が仮想締め期間に該当するかを判断するために用います。
5月1日実施の料金計算では、締期間に請求加算月数を加算することで、後払い（0ヶ月）は4月1日～4月30日、前払いは5月1日～5月31日のサービス契約を対象として料金計算をする。
※前払いの場合、サービスの申込日に対して料金プランの適用開始日が翌月以降（申込月の締日より後）になるように料金プランマスタを設定する必要があります。
機能別説明#
提供機能一覧#
マスタメンテナンス機能では下記２つのAPI機能を提供します。
| 提供機能 | 概要 |
|---|---|
| 検索 | 指定条件に該当するマスタの一覧を検索する |
| 編集 | 1. サービス情報、及び料金形態を指定し、サービスとサービスに紐づく 料金形態の実現に必要なマスタを一括で登録、変更する 2. 指定条件に該当するマスタの情報を変更する 3. 指定条件に該当するマスタを削除して利用不能とする 4. 指定条件に該当するマスタの適用終了年月日を設定し、指定日以降のマスタを 利用不能とする |
検索機能#
マスタメンテナンス「検索」機能APIは、サービスマスタのみの検索、および指定したサービスマスタの検索条件に紐付く料金系マスタの検索機能を提供します。
検索条件#
※料金系マスタの検索を行わない場合は、「料金情報取得有無フラグ」を「0：無」に設定してください。
※APIインタフェースの詳細についてはAPIリファレンスを参照してください。
インターフェイス設定例1#
サービスコードと適用開始年月日Ｆｒｏｍ、Ｔｏの範囲検索となるので、サービスマスタのBレコードが対象となります。また料金情報取得有無フラグが「0：無」のため、料金系マスタは検索対象外となります。
インターフェイス設定例2#
サービスマスタに紐付く料金系マスタを検索。適用開始年月日が20170401以降の３レコードのうち開始位置、終了位置が１～２レコード目までを取得するため、サービマスタのA,Dレコードは対象外となります。
編集機能#
マスタメンテナンス「編集」機能APIは、サービスマスタと料金プランの登録、変更（適用終了含む）、削除を行う機能を提供します。
APIインタフェースの構造#
※APIインタフェースの詳細についてはAPIリファレンスを参照してください。
各計算パターン毎のマスタリストの紐付けのイメージは以下になります。
登録と変更（適用終了含む）#
料金系マスタはサービスマスタ登録と同時に一括で登録、または段階的に登録することができます。
既存レコードは、キー情報を基に、変更を行います。
■注意事項
- 料金計算を実施する場合、料金系マスタの設定はサービス公開前（適用開始日前）に完了するようにしてください。
- 既存レコードは内部インタフェースリストに設定された値を基に変更を行うため、変更したい項目以外は必ずキー情報で取得した値を設定してください。変更した項目以外が未設定の場合は、既存の内容がNULLで上書きされます。
- 契約中のサービスがある場合に適用終了するには、料金計算の期間中に料金体系が変化してしまうことを防ぐため、新たに適用開始するマスタを同時に設定してください。また追加するマスタの適用開始日は締日翌日を設定して下さい。
削除#
各マスタの削除は、内部インタフェースの既存レコードに対して、削除対象フラグを「1：削除対象」とすることで、マスタから物理削除を行います。
全てのマスタを削除したい場合は、内部インタフェースの全ての削除対象フラグを「1：削除対象」に設定してください。
■注意事項
- サービスマスタは、カテゴリに属している場合や削除対象のサービスが契約されている場合には削除することが出来ません。
- 使用しないレコードを残しておきたい場合は、当機能で削除は行わず変更機能で適用終了年月日に終了日を設定してください。
- 料金系マスタを削除する場合は、契約されているか等のチェックは行っていないためマスタの適用終了年月日前での、API実行での削除は行わないでください。