GET/partners/invoice-details

請求明細リストを取得する。

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 

管理用識別コード (最大 200 Bytes)


readOnly : true 
settlementItems array (SettlementItems) 

精算リスト


readOnly : true 

SettlementItems

PropertyTypeDescription
subscriptionId integer 

商品契約 ID

 
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)

    • LINE WORKSサービス

      • FR : フリープラン
      • LT_T : ライトプラントライアル
      • BS_T : ベーシックプラントライアル
      • PRM_T : プレミアムプラントライアル
      • LT : ライトプラン
      • BS : ベーシックプラン
      • PRM : プレミアムプラン
      • STD_T : スタンダードプラントライアル
      • ADV_T : アドバンストプラントライアル
      • STD : スタンダードプラン
      • ADV : アドバンストプラン

    • LINE WORKSラジャーサービス

      • ROG_FR : フリープラン
      • ROG_STD_T : スタンダードプラントライアル
      • ROG_ADV_T : アドバンストプラントライアル
      • ROG_STD : スタンダードプラン
      • ROG_ADV : アドバンストプラン

    • LINE WORKS AiNoteサービス

      • NTA_FR : フリープラン
      • NTA_SL_T : ソロプラントライアル
      • NTA_TM_T : チームプラントライアル
      • NTA_BZ_T : ビジネスプラントライアル
      • NTA_EP_T : エンタープライズプラントライアル
      • NTA_SL : ソロプラン
      • NTA_TM : チームプラン
      • NTA_BZ : ビジネスプラン
      • NTA_EP : エンタープライズプラン

    • LINE WORKS PaperOnサービス

      • JP_PPO_LT_T : ライトプラントライアル
      • JP_PPO_STD_T : スタンダードプラントライアル
      • JP_PPO_ADV_T : アドバンストプラントライアル
      • JP_PPO_LT : ライトプラン
      • JP_PPO_STD : スタンダードプラン
      • JP_PPO_ADV : アドバンストプラン

    • LINE WORKS AiStudioサービス

      • JP_AIS_STD : スタンダードプラン
      • JP_AIS_STD_T : スタンダードプラントライアル

  • itemType が OPTION_PRODUCT の場合、オプション商品 ID (optionProductId)
    サブオプション商品 ID が subItemId に返る。

    • LINE WORKS オプション商品

      • ACV : アーカイブ (旧商品)
      • SSTG : 共有ストレージ (旧商品)
      • ACV2 : アーカイブ (トーク)
      • ACV3 : アーカイブ (メール)
      • DRV : Drive
      • SSTG2 : 追加ストレージ
      • BCT : アドレス帳登録数拡張
      • CST_S : CXトーク 対応者5席の窓口
      • CST_M : CXトーク 対応者30席の窓口
      • CST_L : CXトーク 対応者100席の窓口

    • LINE WORKS AiNote オプション商品

      • QTA_O1 : 追加文字起こし時間 100分(単月追加)
      • QTA_O2 : 追加文字起こし時間 6,000分(単月追加)
      • QTA_M1 : 追加文字起こし時間 100分(毎月追加)
      • QTA_M2 : 追加文字起こし時間 6,000分(毎月追加)

    • LINE WORKS PaperOn オプション商品

      • JP_PPO_O : 読み取り回数追加(単月追加)
      • JP_PPO_M : 読み取り回数追加(毎月追加)

    • LINE WORKS AiStudio オプション商品

      • JP_AIS_O : 追加トークン(毎月追加)
      • JP_AIS_M : 追加トークン(単月追加)

  • itemType が ADJUSTMENT の場合、custom フィールド名

  • itemType が OPTION_PLUS、SUMMARY、PENALTY の場合は null


readOnly : true 
subItemId string 

サブオプション商品 ID

  • LINE WORKSサービスのオプション商品

    • オプション商品 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席の窓口

  • LINE WORKS AiNoteサービスのオプション商品

    • オプション商品 ID が QTA_O1 の場合
      • QTA_O101 : 追加文字起こし時間 100分(単月追加)
    • オプション商品 ID が QTA_O2 の場合
      • QTA_O201 : 追加文字起こし時間 6,000分(単月追加)
    • オプション商品 ID が QTA_M1 の場合
      • QTA_M101 : 追加文字起こし時間 100分(毎月追加)
    • オプション商品 ID が QTA_M2 の場合
      • QTA_M201 : 追加文字起こし時間 6,000分(毎月追加)

  • LINE WORKS PaperOnサービスのオプション商品

    • オプション商品 ID が JP_PPO_O の場合
      • JP_PPO_O01 : 読み取り回数追加(単月追加)
    • オプション商品 ID が JP_PPO_M の場合
      • JP_PPO_M01 : 読み取り回数追加(毎月追加)

  • LINE WORKS AiStudioサービスのオプション商品

    • オプション商品 ID が JP_AIS_O の場合
      • JP_AIS_O01 : 追加トークン(単月追加)
    • オプション商品 ID が JP_AIS_M の場合
      • JP_AIS_M01 : 追加トークン(毎月追加)

Allowed values : 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, QTA_O101, QTA_O201, QTA_M101, QTA_M201, JP_PPO_O01, JP_PPO_M01, JP_AIS_O01, JP_AIS_M01 
plan string 

プラン (契約タイプ)

  • FREE : フリー
  • FREE_LICENSE : フリー ライセンス
  • TRIAL : トライアル
  • TRIAL_LICENSE : トライアル ライセンス
  • MONTHLY : 月額契約 後払い
  • MONTHLY_LICENSE : 月額契約 後払い ライセンス
  • ANNUAL : 年額契約 月払い
  • ANNUAL_LICENSE : 年額契約 月払い ライセンス
  • ANNUAL_PREPAY : 年額契約 一括払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

商品グループ別の適用可能なプラン

  • LINE WORKSサービス
    • FREE : フリー
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス
  • LINE WORKSラジャーサービス
    • FREE_LICENSE : フリー ライセンス
    • TRIAL_LICENSE : トライアル ライセンス
    • MONTHLY_LICENSE : 月額契約 後払い ライセンス
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス
  • LINE WORKS AiNoteサービス
    • FREE : フリー
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い
  • LINE WORKS PaperOnサービス
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い
  • LINE WORKS AiStudioサービス
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い

Allowed values : FREE, TRIAL, MONTHLY, ANNUAL, ANNUAL_PREPAY, FREE_LICENSE, TRIAL_LICENSE, MONTHLY_LICENSE, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

ライセンス数


readOnly : true 
memberCount integer 

利用ユーザー数


readOnly : true 
quantity integer 

契約数

  • 数量追加型の商品では利用数
  • その他は null

readOnly : true
nullable : true 
status string 

商品契約状態

  • ACTIVE : 正常
  • SUSPENDED_TRIALEND : 停止 (トライアル終了による停止)

Allowed values : ACTIVE, SUSPENDED_TRIALEND 
discountAmount number 

割引金額


readOnly : true 
amount number 

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


readOnly : true 
itemCustomerCode string 

商品識別コード

  • itemType が PRODUCT, OPTION_PRODUCT の場合

nullable : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

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