Invoice API

Overview

This API allows you to control the invoice for NTT Com Services.1

Resource URL

Please use global common domain, or the individual region domain.

If you want to use the global common domain, depending on the circumstances of your available points, your request connect to the nearest API gateway.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

Resource Information

Key Value
Response Format JSON
Authentication (OAuth) Yes
Bandwidth control#1 Yes
  • #1 implement appropriate flow restriction in the customer connection unit

GET invoice Info

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

Request Parameters

Name Description type mandatory
contractId Service Contract ID path Yes
serviceName Service Name#1 query argument Yes
chargeYearmonth Bill of Period #2,#3 query argument
  • #1 uno,bdp-e,bhec,sip-trunking,ucaas,cloudn,ip-voice,smart-pbx,050plusbiz,accs,bocn
  • #2 It is available to confirm this month billing from 15th(JST).
  • #3 If you request this API without chargeYearmonth before 15th, API gateway responses the bill of last month. If you request this API without chargeYearmonth from 16th on, API gateway responses the invoice of this month.

Example Request

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

Response Parameters

Name Description type mandatory
billContractNumber Service Contract ID String
chargeYearmonth Bill of Period String
chargeAmount Billing Amount (yen, taxes excluded) String
chargeItemRepetitionCount The number of detailed billing String
chargeItemInfo Detailed Billing String
chargeItemCodeJa Item Name String
chargeItemAmmount Billing of Item(yen, taxes included) String
resultCode Result Code String
resultCodeJa Result Message 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. Feb. 2016 currently, the invoice is services in Japan. 

  2. Dec. 2014 currently, DNS round robin operation. API request will automatically connect to geographically close API gateway as it becomes available.