料金計算機能概要
はじめに#
主機能分類#
下記の３機能に分類される各API／バッチによって、毎月の利用実績に基づいた課金料金を計算し、債権情報を作成します。
ご利用イメージ#
業務フロー#
下図に引かれた各機能の矢印の流れに沿って、料金計算を行います。
*1: サービス契約は「契約管理」サービスで提供される機能です。
*2: ご利用の料金プランが「定額料金プラン」のみの場合は不要です。
分類別説明#
料金系マスタメンテナンス#
料金計算時に必要となる料金プランを管理する「料金系マスタ」をメンテナンスするAPIです。
提供するAPIの分類は以下のとおりです。
マスタの編集#
| 提供機能（API名） | 説明 |
|---|---|
| サービス料金情報を編集する | 料金プランを管理するマスタの新規登録、追加登録、変更、削除を行います。 |
マスタの検索#
| 提供機能（API名） | 説明 |
|---|---|
| サービス料金情報を検索する | 指定したサービスコードに紐づく、料金プランを管理するマスタの検索を行います。 |
※料金系マスタメンテナンス機能の詳細説明は、料金系マスタメンテナンス機能概要を参照してください。
利用実績登録#
料金計算のための利用実績を登録するAPI／バッチです。
- 利用実績登録API … 常時実行可能
- 利用実績登録バッチ … 日次（毎日09:00～11:00）起動
API登録後のバッチ実行によって利用実績登録が完了となります。
APIとバッチの処理タイミングは以下のとおりです。
処理ステータスの照会#
| 提供機能（API名） | 説明 |
|---|---|
| 非同期処理状況を取得する | 利用実績の処理ステータスを取得します。 |
| 非同期処理のエラー情報を取得する | 指利用実績登録バッチが警告終了した際に、エラー情報を取得します。 |
利用実績の取消 *／無効化 *#
| 提供機能（API名） | 説明 |
|---|---|
| 利用実績を取り消す | 受付ＩＤを基に利用実績情報を取り消します。 |
| 利用実績を無効化する | 利用実績ＩＤを基に利用実績情報を取り消します。 |
*: 取得可能なレコードは処理ステータス「正常終了」のみです。
ステータスは「非同期処理状況を取得する」APIより確認可能です。
利用実績の検索#
| 提供機能（API名） | 説明 |
|---|---|
| 利用実績の件数を取得する | 受付ＩＤを基に利用実績情報を取り消します。 |
| 利用実績を検索する | 受付ＩＤ、開始位置、終了位置を基に利用実績の一覧検索を行います。 |
| 重複した利用実績の件数を取得する | 開始日を基に利用実績の重複件数検索を行います。 |
| 重複した利用実績を検索する | 開始日を基に利用実績の重複検索と開始日、開始位置、終了位置を基に利用実績の重複指定位置検索を行います。 |
処理ステータス#
| ステータス | 説明 |
|---|---|
| 未処理 | 利用実績未登録 |
| 処理中 | 利用実績登録処理中 |
| 処理中＿警告あり | 利用実績登録処理中（一部利用実績にエラー） |
| 正常終了 | 利用実績登録完了 |
| 警告終了 | 利用実績登録完了（一部利用実績にエラー） |
| 異常終了 | システムエラー |
バッチ実行時のチェック事項#
| チェック項目 | 観点 |
|---|---|
| サービス契約情報存在チェック | 計算対象のサービス契約が存在するか |
| 料金契約期間チェック | 利用終了日が料金契約の適用期間内であるか |
| 計算要素存在チェック | 利用実績の計算をするための計算要素(料金系マスタ)が存在するか （計算要素区分が「従量」であること） |
| 重複チェック | 利用実績が重複していないか |
チェック結果NG（非同期エラー）の場合
- 処理終了後に処理ステータスは「警告終了」となります
- 非同期エラーの利用実績は登録対象外となります
料金計算#
利用実績から日々の従量料金を計算し、月毎に料金プランの従量／定額料金に基いて課金額を計算するバッチです。
- 日次従量料金計算バッチ … 日次（毎日09:00～11:00）起動
- 月次料金計算バッチ … 月次（締日*翌日）起動
日次従量料金計算バッチ#
利用実績を基に従量料金の計算をします。
*: 締日／料金計算期間に関する詳細説明は料金計算の締めサイクルについてを参照してください。
月次料金計算バッチ#
定額料金と従量料金を基に、対象となる月の課金額を計算します。
月次料金計算バッチは正常終了後に債権／債権明細*1／債権明細付帯情報を作成します。
これらの債権情報は債権系API*2により検索／削除が可能です。
*1: 債権明細はサービス契約の契約単位で作成されます。ただし料金プランが複数の料金体系（定額・従量 等）から構成されている場合は料金体系単位で作成されます。
*2: 債権系APIの種類と説明はAPIリファレンスを参照してください。
バッチエラー通知#
-
データ不整合が原因の場合にメールにてエラーを通知します。
-
エラー情報はAPIを用いて取得することができます。*1
*1: エラーの対処法は、トラブルシューティングマニュアルを参照してください。
*2: APIの説明は、APIリファレンスを参照してください。
リモートバッチ実行機能#
バッチを任意のタイミングでリモートバッチ実行APIを経由して実行できます。 但し、以下の場合であることが実行の条件です。
-
実行対象月の債権が存在しない
-
実行対象月が過去の月
