請求関連API

請求関連APIのみ、アクセス先のURLが異なります。以下の中から任意の物をご利用ください。ただし、全ゾーン合計で請求するため、全ゾーンでレスポンスは統一となります。

https://secure.sakura.ad.jp/cloud/zone/tk1a/api/system/1.0/ (東京第1ゾーン)
https://secure.sakura.ad.jp/cloud/zone/tk1b/api/system/1.0/ (東京第2ゾーン)
https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/ (石狩第1ゾーン)
https://secure.sakura.ad.jp/cloud/zone/is1b/api/system/1.0/ (石狩第2ゾーン)
https://secure.sakura.ad.jp/cloud/zone/tk1v/api/system/1.0/ (Sandbox)

GET

/bill/by-contract/:accountid

-

該当アカウントIDに請求される請求一覧を取得
GET

/bill/by-contract/:accountid/:year

-

該当アカウントID、該当年に請求される請求一覧の取得
GET

/bill/by-contract/:accountid/:year/:month

-

該当アカウントID、該当年月に請求される請求一覧の取得
GET

/bill/id/:billno

-

該当請求書NOの請求情報を取得
GET

/billdetail/:membercd/:billno

-

該当会員ID、該当請求書NOに含まれる請求明細情報を取得
GET

/billdetail/:membercd/:billno/csv

-

該当会員ID、請求書NOに含まれる請求明細情報をCSVで取得
GET

/coupon/:accountid

-

該当アカウントIDに適用されているクーポン一覧の取得

GET/bill/by-contract/:accountid

該当アカウントIDに請求される請求一覧を取得

サンプル

{
  "Bills": [
    {
      "Amount": 10000,
      "BillID": 99999999,
      "Date": "2016-06-10T00:00:00+09:00",
      "MemberID": "abc99999",
      "Paid": true,
      "PayLimit": "2016-06-30T00:00:00+09:00",
      "PaymentClassID": 200
    },
    {
      "Amount": 20000,
      "BillID": 99999999,
      "Date": "2016-05-10T00:00:00+09:00",
      "MemberID": "abc99999",
      "Paid": true,
      "PayLimit": "2016-05-31T00:00:00+09:00",
      "PaymentClassID": 200
    },
    {
      "Amount": 30000,
      "BillID": 99999999,
      "Date": "2016-04-10T00:00:00+09:00",
      "MemberID": "abc99999",
      "Paid": true,
      "PayLimit": "2016-04-30T00:00:00+09:00",
      "PaymentClassID": 200
    }
  ],
  "Count": 3,
  "ResponsedAt": "2016-06-01T15:17:06+09:00",
  "is_ok": true
}

curl --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/bill/by-contract/:accountid

curl -k --user "Access Token":"Access Token Secret" ^
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/bill/by-contract/:accountid

URLパラメータ

Name	Comment
accountid	処理対象のアカウントID

GET/bill/by-contract/:accountid/:year

該当アカウントID、該当年に請求される請求一覧の取得

サンプル
- curl(Linux)
- curl(Windows)

curl --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/bill/by-contract/:accountid/:year

curl -k --user "Access Token":"Access Token Secret" ^
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/bill/by-contract/:accountid/:year

URLパラメータ

Name	Comment
accountid	処理対象のアカウントID
year	処理対象となる請求年

GET/bill/by-contract/:accountid/:year/:month

該当アカウントID、該当年月に請求される請求一覧の取得

サンプル
- curl(Linux)
- curl(Windows)

curl --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/bill/by-contract/:accountid/:year/:month

curl -k --user "Access Token":"Access Token Secret" ^
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/bill/by-contract/:accountid/:year/:month

URLパラメータ

Name	Comment
accountid	処理対象のアカウントID
year	処理対象となる請求年
month	処理対象となる請求月

GET/bill/id/:billno

該当請求書NOの請求情報を取得

サンプル

{
  "Bills": [
    {
      "Amount": 10000,
      "BillID": 99999999,
      "Date": "2016-06-10T00:00:00+09:00",
      "MemberID": "abc99999",
      "Paid": true,
      "PayLimit": "2016-06-30T00:00:00+09:00",
      "PaymentClassID": 200
    }
  ],
  "Count": 1,
  "ResponsedAt": "2016-06-01T15:27:21+09:00",
  "is_ok": true
}

curl --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/bill/id/:billno

curl -k --user "Access Token":"Access Token Secret" ^
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/bill/id/:billno

URLパラメータ

Name	Comment
billno	請求書NO

GET/billdetail/:membercd/:billno

該当会員ID、該当請求書NOに含まれる請求明細情報を取得

サンプル

{
  "BillDetails": [
    {
      "Amount": 0,
      "ContractID": 111111111111,
      "Index": 1,
      "ServiceClassID": 50000,
      "Usage": 2678400,
      "Zone": "is1b"
    },
    {
      "Amount": 2160,
      "ContractID": 222222222222,
      "Index": 2,
      "ServiceClassID": 50072,
      "Usage": 2678400,
      "Zone": "is1b"
    },
    {
      "Amount": 2131,
      "ContractID": 333333333333,
      "Details": [ // 内訳（割引パスポート等による割引がある場合などにこのフィールドが追加されます）
        {
          "Amount": 3000,
          "ContractID": 333333333333,
          "Index": 1,
          "ServiceClassID": 50189,
          "Usage": 537839,
          "Zone": "is1b"
        },
        {
          "Amount": -869,
          "ContractID": 444444444444,
          "Index": 2,
          "ServiceClassID": 50323
        }
      ],
      "Index": 3,
      "ServiceClassID": 50189,
      "Usage": 537839,
      "Zone": "is1b"
    }
  ],
  "Count": 3,
  "ResponsedAt": "2016-06-01T15:30:52+09:00",
  "is_ok": true
}

curl --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/billdetail/:membercd/:billno

curl -k --user "Access Token":"Access Token Secret" ^
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/billdetail/:membercd/:billno

URLパラメータ

Name	Comment
membercd	取得したい請求書の会員ID
billno	処理対象となる請求書NO

GET/billdetail/:membercd/:billno/csv

該当会員ID、請求書NOに含まれる請求明細情報をCSVで取得

サンプル
- curl(Linux)
- curl(Windows)

curl --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/billdetail/:membercd/:billno/csv

curl -k --user "Access Token":"Access Token Secret" ^
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/billdetail/:membercd/:billno/csv

URLパラメータ

Name	Comment
membercd	取得したい請求書の会員ID
billno	処理対象となる請求書NO

GET/coupon/:accountid

該当アカウントIDに適用されているクーポン一覧の取得

サンプル

{
  "Count": 1,
  "Coupons": [
    {
      "AppliedAt": "2019-01-10T11:12:13+09:00",
      "ContractID": 111111111111,
      "CouponID": "xxxxxxxxxxxxxxxx",
      "Discount": 999999,  // クーポン残高
      "MemberID": "abc99999",
      "ServiceClassID": 50122,
      "UntilAt": "2019-03-31T23:59:59+09:00" // クーポン有効期限
    }
  ],
  "ResponsedAt": "2019-01-01T00:00:00+09:00",
  "is_ok": true
}

curl --user "Access Token":"Access Token Secret" \
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/coupon/:accountid

curl -k --user "Access Token":"Access Token Secret" ^
     https://secure.sakura.ad.jp/cloud/zone/is1a/api/system/1.0/coupon/:accountid

URLパラメータ

Name	Comment
accountid	処理対象のアカウントID

請求関連API

サンプル

URLパラメータ

サンプル

URLパラメータ

サンプル

URLパラメータ

サンプル

URLパラメータ

サンプル

URLパラメータ

サンプル

URLパラメータ

サンプル

URLパラメータ