利用実績を登録する
Description
Body部に設定された入力情報をもとに利用実績を登録します。
Method
POST
共通リクエストヘッダーを参照してください。
Argument
なし
URI
Sample request uri
Parameters in request body
共通仕様はこちらを参照してください。
例には一部項目を記載しています。全項目の詳細は表を参照してください。
example
{
"monthly": "201709",
"overlap_check": "0",
"use_record_entry_list": [
{
"log_key": "000000000000838",
"price_plan_code": "000000719",
"use_start_date": "20170914",
"use_start_time": "000000000000",
"use_end_date": "20170914",
"use_end_time": "235959000000",
"use_volume": "100",
"use_element_1": "K000000001"
}
]
}
Parameters
| Name |
Type |
Required |
Length
（Long/Decimalの場合はValue） |
Description |
monthly |
String |
Yes |
6 |
月度
yyyyMM形式 |
use_record_file_path |
String |
No |
1
～
256 |
利用実績ファイルパス
別途公開予定の汎用ファイルアップロードAPIにて、アップロードしたファイルを指定する場合（利用可能時期未定なため項目定義暫定） |
overlap_check |
String |
No |
1 |
重複チェック有フラグ |
use_record_entry_list |
Array |
|
- |
利用実績登録リスト |
|
log_key |
String |
Yes |
15 |
サービス契約ＩＤ
サービス契約を一意に識別するID |
price_plan_code |
String |
No |
9 |
料金プランコード
サービス契約に紐付く料金プランを識別するコード |
use_start_date |
String |
Yes |
8 |
利用開始日
yyyyMMdd形式 |
use_start_time |
String |
Yes |
12 |
利用開始時刻
HHmmssSSS+{数字３桁}形式 |
use_end_date |
String |
Yes |
8 |
利用終了日
yyyyMMdd形式 |
use_end_time |
String |
Yes |
12 |
利用終了時刻
HHmmssSSS+{数字３桁}形式 |
use_volume |
Decimal |
No |
-999999999999.999999
～
999999999999.999999 |
利用量
サービスの利用量を表す |
use_fee |
Decimal |
No |
-999999999999.999999
～
999999999999.999999 |
利用金額
サービスの利用金額を表す |
use_element_1 |
String |
Yes |
10 |
利用要素１
レート計算用要素 |
use_element_2 |
String |
No |
10 |
利用要素２
レート計算用要素 |
use_element_3 |
String |
No |
10 |
利用要素３
レート計算用要素 |
use_element_4 |
String |
No |
10 |
利用要素４
レート計算用要素 |
use_element_5 |
String |
No |
10 |
利用要素５
レート計算用要素 |
Return Codes
| Code |
Description |
| 202 |
正常受付（非同期） |
| 401 |
認証エラー |
| 403 |
アクセス不可 |
| 404 |
対象なし |
| 500 |
業務不整合 |
特筆する返却値はありません。
Response Parameter
共通仕様はこちらを参照してください。
example
{
"receipt_code": "000000000000119",
"receipt_count": 1,
"result_information": {
"result": "OK"
}
}
Parameters
| Name |
Type |
Required |
Length
（Long/Decimalの場合はValue） |
Description |
receipt_code |
String |
No |
15 |
受付ＩＤ
受付時期を特定するＩＤ |
receipt_count |
Long |
No |
1
～
999999999999999999 |
受付件数
利用実績ファイルへ書き込んだレコード数を表す |
result_information |
object |
|
- |
結果情報 |
|
result |
String |
No |
2 |
結果
OKまたはNGを返却 |
detailed_result |
String |
No |
1
～
256 |
結果詳細
NGの場合、エラー内容を返却 |
Top