GET/partners/invoice-details

顧客企業の請求明細リストを取得する。

注意
この API は引き続きご利用いただけますが、ドキュメントは 請求明細リストの取得 をご参照ください。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/invoice-details

Query Parameters

ParameterTypeDescription
year integer 

取得年


required
example : 2021 
month integer 

取得月


required
minimum : 1
maximum : 12
example : 6 
count integer 

取得数


default : 20
minimum : 1
maximum : 20 
cursor string 

リストのカーソル値


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
invoiceDetails array (InvoiceDetails) 

顧客の利用履歴をもとに請求書の項目情報を表示する。
商品及びオプションは商品、プラン、ライセンス数、ユーザー数が変更されたら開始日と終了日で計算した総計を提供する。
総計には調整金、違約金は含まれていないため、注意が必要。

 
responseMetaData object (responseMetaData) 

ページ付け情報

 

InvoiceDetails

PropertyTypeDescription
domainId integer 

ドメイン ID


readOnly : true 
domain string 

ドメイン名


readOnly : true 
customerName string 

顧客企業/団体名


readOnly : true 
customerCode string 

管理用識別コード


maxLength : 200
readOnly : true 
settlementItems array (SettlementItems) 

精算リスト


readOnly : true 

SettlementItems

PropertyTypeDescription
itemType string 

精算項目タイプ

  • PRODUCT : 商品
  • OPTION_PRODUCT : オプション商品
  • OPTION_PLUS : オプションプラス
  • SUMMARY : 合計 (PRODUCT + OPTION_PRODUCT + ADJUSTMENT)
  • ADJUSTMENT : 調整金 (custom field)
  • PENALTY : 違約金

Allowed values : PRODUCT, OPTION_PRODUCT, OPTION_PLUS, SUMMARY, ADJUSTMENT, PENALTY 
startDate string 

利用開始日

  • itemType が PRODUCT、OPTION_PRODUCT、 OPTION_PLUS の場合は利用開始日

format : date
readOnly : true 
endDate string 

利用終了日

  • itemType が PRODUCT、OPTION_PRODUCT、OPTION_PLUS の場合は利用終了日

format : date
readOnly : true 
itemId string 

項目 ID

  • itemType が PRODUCTの場合、商品 ID (productId)
    • FR : Free
    • LT_T : Lite Trial
    • BS_T : Basic Trial
    • PRM_T : Premium Trial
    • LT : Lite
    • BS : Basic
    • PRM : Premium
    • STD_T : Standard Trial
    • ADV_T : Advanced Trial
    • STD : Standard
    • ADV : Advanced
  • itemType が OPTION_PRODUCT の場合、オプション商品 ID (optionProductId)
    サブオプション商品 ID が subItemId に返る。
    • ACV : アーカイブ (旧商品)
    • SSTG : 共有ストレージ (旧商品)
    • ACV2 : アーカイブ (トーク)
    • ACV3 : アーカイブ (メール)
    • DRV : Drive
    • SSTG2 : 追加ストレージ
    • BCT : アドレス帳登録数拡張
  • itemType が ADJUSTMENT の場合、custom フィールド名
  • itemType が OPTION_PLUS、SUMMARY、PENALTY の場合は null

readOnly : true 
subItemId string 

サブオプション商品 ID

  • オプション商品 ID が ACV の場合
    • ACV : アーカイブ (旧商品)
  • オプション商品 ID が SSTG の場合
    • SSTG : 共有ストレージ (旧商品)
  • オプション商品 ID が ACV2 の場合
    • ACV200 : アーカイブ (トーク) Trial
    • ACV201 : アーカイブ (トーク)
  • オプション商品 ID が ACV3 の場合
    • ACV300 : アーカイブ (メール) Trial
    • ACV301 : アーカイブ (メール)
  • オプション商品 ID が DRV の場合
    • DRV00: Drive Trial (for STD)
    • DRV01: Drive (for STD)
    • DRV_PS_T: Drive Plus Trial (for STD)
    • DRV_PS: Drive Plus (for STD)
    • DRV_PA_T: Drive Plus Trial (for ADV)
    • DRV_PA: Drive Plus (for ADV)
  • オプション商品 ID が SSTG2 の場合
    • SSTG201 : 追加ストレージ (1TB)
    • SSTG202 : 追加ストレージ (5TB)
    • SSTG203 : 追加ストレージ (10TB)
    • SSTG204 : 追加ストレージ (25TB)
    • SSTG205 : 追加ストレージ (50TB)
    • SSTG206 : 追加ストレージ (100TB)
    • SSTG207 : 追加ストレージ (500TB)
  • オプション商品 ID が BCT の場合
    • BCT01 : アドレス帳登録数拡張 (25 万件まで)
    • BCT02 : アドレス帳登録数拡張 (50 万件まで)
    • BCT03 : アドレス帳登録数拡張 (150 万件まで)
    • BCT04 : アドレス帳登録数拡張 (500 万件まで)
  • オプション商品 ID が CST_S の場合
    • CST_S00 : CXトーク 対応者5席の窓口 Trial
    • CST_S01 : CXトーク 対応者5席の窓口
  • オプション商品 ID が CST_M の場合
    • CST_M00 : CXトーク 対応者30席の窓口 Trial
    • CST_M01 : CXトーク 対応者30席の窓口
  • オプション商品 ID が CST_L の場合
    • CST_L00 : CXトーク 対応者100席の窓口 Trial
    • CST_L01 : CXトーク 対応者100席の窓口

Allowed values : ACV, SSTG, ACV200, ACV201, ACV300, ACV301, DRV00, DRV01, DRV_PS_T, DRV_PS, DRV_PA_T, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04, CST_S00, CST_S01, CST_M00, CST_M01, CST_L00, CST_L01 
plan string 

プラン

  • FREE : Free
  • TRIAL : Trial
  • MONTHLY : 月額契約 後払
  • ANNUAL_LICENSE : 年額契約 月払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い

Allowed values : FREE, TRIAL, MONTHLY, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

ライセンス数 (年額契約)


readOnly : true 
memberCount integer 

利用ユーザー数 (月額契約)


readOnly : true 
quantity integer 

契約数

  • optionProductId が SSTG の場合、単位は TB
  • その他は null

readOnly : true
nullable : true 
status string 

ステータス

  • ACTIVE : 正常
  • UPGRADING : アップグレード中
  • SUSPENDED_TRIALEND : 停止 (トライアル終了による停止)
  • SUSPENDED_ADMIN : 停止 (管理者による停止)
  • SUSPENDED_WITHDRAWAL: 停止 (解約待機による停止)

Allowed values : ACTIVE, UPGRADING, SUSPENDED_TRIALEND, SUSPENDED_ADMIN, SUSPENDED_WITHDRAWAL 
discountAmount number 

割引金額


readOnly : true 
amount number 

精算金額 (割引後、最終金額)


readOnly : true 
itemCustomerCode string 

商品識別コード

  • itemType が PRODUCT, OPTION_PRODUCT の場合

nullable : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "invoiceDetails": [3    {4      "domainId": 10000001,5      "domain": "example.com",6      "customerName": "ワークスモバイルジャパン株式会社",7      "customerCode": "XXXXXXXX",8      "settlementItems": [9        {10          "itemType": "PRODUCT",11          "startDate": "2018-11-01",12          "itemId": "STD",13          "plan": "MONTHLY",14          "memberCount": 100,15          "quantity": null,16          "status": "ACTIVE",17          "discountAmount": 0,18          "amount": 3600019        },20        {21          "itemType": "OPTION_PRODUCT",22          "startDate": "2018-11-01",23          "itemId": "ACV2",24          "plan": "MONTHLY",25          "memberCount": 100,26          "quantity": null,27          "discountAmount": 0,28          "amount": 2640029        },30        {31          "itemType": "OPTION_PLUS",32          "startDate": "2018-11-01",33          "quantity": null,34          "discountAmount": 0,35          "amount": 1000036        },37        {38          "itemType": "SUMMARY",39          "quantity": null,40          "discountAmount": 0,41          "amount": 7240042        }43      ]44    }45  ],46  "responseMetaData": {47    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="48  }49}