請求料金情報 API

Overview

本APIは、NTT Com各種サービスの請求料金情報1を管理するAPIです。

Resource URL

グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。

グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。2

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/business-process/bills

2.Base Path(Region)

https://{region}.api.ntt.com/v1/business-process/bills
  • region is jp|us|uk
  • e.g. https://us.api.ntt.com/v1/business-process/bills
  • 指定できるregionは、将来拡充予定

Resource Information

Key Value
レスポンス フォーマット JSON
認証(OAuth) Yes
帯域制御#1 Yes
  • #1 お客さま接続単位で適切な流量制限を実施

請求料金情報参照

GET /v1/business-process/bills/{contractId}

Request Parameters

Name Description type mandatory
contractId サービスの契約IDを指定 path Yes
serviceName サービス名称を指定#1 query argument Yes
chargeYearmonth 請求年月(YYYYMM)を指定#2,#3 query argument
  • #1 uno,bdp-e,bhec,sip-trunking,ucaas,cloudn,ip-voice,smart-pbx,050plusbiz,accs,bocn
  • #2 当月の請求年月の指定は、毎月15日(JST)以降に可能です。
  • #3 請求年月を指定せず、15日より前にリクエストした場合、料金情報は、前月のものが返却される。15日以降にリクエストした場合、当月のものが返却される。

Example Request

 GET /v1/business-process/bills/Nxxxxxxxxxx?serviceName=ip-voice

Response Parameters

Name Description type mandatory
billContractNumber 契約識別番号 String
chargeYearmonth 請求年月 String
chargeAmount 請求金額(円、税込) String
chargeItemRepetitionCount 繰り返し請求内訳数 String
chargeItemInfo 請求内訳(繰り返し部分) String
chargeItemCodeJa 内訳種別名 String
chargeItemAmmount 金額(円、税抜) String
resultCode 処理結果コード String
resultCodeJa 処理結果名 String

Example Result

{
    "billContractNumber": "Nxxxxxxxxx",
    "chargeAmount": "12039",
    "chargeItemInfo": [
        {
            "chargeItemAmount": "",
            "chargeItemCodeJa": "・NTTコミュニケーションズご利用分"
        },
        {
            "chargeItemAmount": "XX",
            "chargeItemCodeJa": "IP Voice基本料・日割"
        },
        {
            "chargeItemAmount": "XX",
            "chargeItemCodeJa": "チャネル追加利用料・日割"
        },
        {
            "chargeItemAmount": "XX",
            "chargeItemCodeJa": "番号追加利用料・日割"
        },
        {
            "chargeItemAmount": "XX",
            "chargeItemCodeJa": "VoIP端末利用料・日割"
        },
        {
            "chargeItemAmount": "XXXXX",
            "chargeItemCodeJa": "工事費"
        },
        {
            "chargeItemAmount": "XXX",
            "chargeItemCodeJa": "消費税相当額(合計)"
        },
        {
            "chargeItemAmount": "XX",
            "chargeItemCodeJa": "(内訳)消費税相当額(合算)8%"
        },
        {
            "chargeItemAmount": "XXX",
            "chargeItemCodeJa": "(内訳)消費税相当額(個別分)"
        }
    ],
    "chargeItemRepetitionCount": "9",
    "chargeYearmonth": "201602",
    "resultCode": "0",
    "resultCodeJa": "正常"
}

  1. 2016/2 現在、国内の該当サービスのみ対応です。 

  2. 2014/12 現在、DNSラウンドロビン運用。準備出来次第、お客さまの地理的に近いAPIゲートウェイに自動接続予定です。別途アナウンスします。