查询汇总账单(旧)
功能介绍
客户在自建平台查询自身的消费汇总账单,此账单按月汇总消费数据。
- 此接口只能查询客户自身的汇总账单,企业子的汇总账单无法通过此接口查询。
- 支持查看近3年内的数据。
- 该接口即将下线,“查询汇总账单”新接口请参考查询汇总账单。
REST API
客户可以查询自身的消费汇总账单的功能,消费按月汇总。
用于客户自身BSS系统的按需扣费或者客户消费记录的查看。
- 该接口只允许使用客户AK/SK或者Token调用。
- 当请求参数不传递“cloud_service_type_code”时,查询的账单是以云服务类型为维度的月度消费账单,即总条数“total_count”是以云服务类型进行统计 ,每条账单记录一种云服务类型的月度消费汇总。此时响应参数中返回的资源类型“resource_type_code”为“null”。
- 当请求参数传递“cloud_service_type_code”时,查询的账单是以资源类型为维度的月度消费账单,即总条数“total_count”是具体云服务类型下以资源类型进行统计,每条账单记录该云服务类型下的一种资源类型的月度消费汇总。此时响应参数中返回的资源类型“resource_type_code”返回具体的资源类型。
- URI
GET /v1.0/{domain_id}/customer/account-mgr/bill/monthly-sum
参数说明请参见下表。
表1 路径参数 参数
是否必选
取值范围
描述
domain_id
是
最大长度:64
客户账号ID。获取方法请参见如何获取客户的customer_id/domain_id。
此参数暂不校验。
表2 查询参数 参数
是否必选
参数类型
取值范围
描述
cycle
是
String
最大长度:7
查询账期。
格式固定为YYYY-MM。
示例:2018-05
cloud_service_type_code
否
String
最大长度:256
云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。
- 当不传递此参数时,查询的账单是以云服务类型为维度的月度消费账单。
- 当传递此参数时,查询的账单是该云服务类型下以资源类型为维度的月度消费账单。
type
否
String
[0|1]
不传此参数默认查询华为云账户下的消费汇总。
此参数不支持携带传空或携带值为空串或携带为null。
enterpriseProjectId
否
String
-
企业项目标识(企业项目ID)。
- default项目对应ID:0
- 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1
- 其余项目对应ID获取方法请参见如何获取企业项目ID。
此参数不携带或携带为空时,不作为筛选条件;携带为null时,作为筛选条件;不支持携带值为空串。
- 请求消息
无。
请求示例
GET https://bss.myhuaweicloud.com/v1.0/{domain_id}/customer/account-mgr/bill/monthly-sum?cycle=2018-05&type=0 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
- 响应消息
参数
参数类型
描述
error_code
String
状态码。
具体请参考4。
error_msg
String
错误描述信息。
currency
String
币种。
CNY:人民币。
值为空代表人民币。
total_count
Integer
总条数,必须大于等于0。
bill_sums
List<BillSumRecordInfo>
账单记录,具体参考表3。
total_amount
Bigdecimal
总金额(包含退订)。
debt_amount
Bigdecimal
总欠费金额。
coupon_amount
Bigdecimal
代金券金额。
cashcoupon_amount
Bigdecimal
现金券金额。
storedcard_amount
Bigdecimal
储值卡金额。
debit_amount
Bigdecimal
现金账户金额。
credit_amount
Bigdecimal
信用账户金额。
measure_id
Integer
金额单位。
- 1:元
- 2:角
- 3:分
表3 BillSumRecordInfo 参数
参数类型
描述
customer_id
String
客户账号ID。
resource_type_code
String
资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。
当请求消息中不传递“cloud_service_type_code”参数时,此值返回“null”。
region_code
String
云服务区,该字段预留,先不使用。
cloud_service_type_code
String
云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。
consume_time
String
消费统计的时期。
格式为YYYY-MM。
示例:2018-05
pay_method
String
消费类型。
- 当请求消息中不传递“cloud_service_type_code”参数时,该参数取值无效。
- 当请求消息中传递“cloud_service_type_code”参数时,如果此值返回“0”表示此资源类型是包年/包月计费模式,如果此值返回“1”表示此资源类型为按需计费模式。
consume_amount
Bigdecimal
消费的金额,即从客户账户实际扣除的金额。包含代金券和现金券支付的金额。
debt
Bigdecimal
欠费金额,即从客户账户扣费的时候,客户账户金额不足,欠费的金额。
discount
Bigdecimal
折扣金额。
measure_id
Integer
金额单位。
- 1:元
- 2:角
- 3:分
bill_type
Integer
账单类型:
- 0:消费
- 1:退订
account_details
List<BalanceTypePay>
按不同账户消费类型和付费方式区分的支付总金额。
具体请参见表4。
discount_detail_infos
List<DiscountDetailInfo>
折扣金额详情。
具体请参见表5。
当bill_type为1时,不返回此参数。
enterpriseProjectId
String
企业项目标识(企业项目ID)。
- default项目对应ID:0
- 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:null
- 其余项目对应ID获取方法请参见如何获取企业项目ID。
当请求参数中传递了“enterpriseProjectId”,响应参数“bill_sums”返回以企业项目ID为维度的账单记录。
表4 BalanceTypePay 参数
参数类型
描述
balance_type_id
String
账户类型。
- BALANCE_TYPE_DEBIT:现金账户
- BALANCE_TYPE_CREDIT:信用账户
- BALANCE_TYPE_BONUS:奖励账户(该账户已下线)
- BALANCE_TYPE_COUPON:代金券账户
- BALANCE_TYPE_DEBIT_RATE:折扣账户
- BALANCE_TYPE_RCASH_COUPON:现金券账户
- BALANCE_TYPE_STORED_VALUE_CARD:储值卡消费
deduct_amount
Bigdecimal
支出金额。
单位:分
表5 DiscountDetailInfo 参数
参数类型
描述
promotion_type
String
折扣类型。
500:代理订购指定折扣
501:代理订购指定减免
502:代理订购指定一口价
600:合同折扣返利 (商履折扣)
601:渠道框架合同折扣
602:专款专用合同折扣(特殊商务合同折扣)
603:线下直签合同折扣
604:电销授权合同折扣
605:商务合同折扣
606:渠道商务合同折扣
607:合作伙伴授权折扣
608:严选商品折扣
610:免单金额
700:促销折扣 (促销,只有包年/包月场景)
800:赠送奖励金
discount_amount
BigDecimal
折扣金额。
promotion_id
String
折扣类型对应的标识,可为合同ID或商务ID。
measure_id
Integer
金额单位
- 1:元
- 2:角
- 3:分
默认:3
响应示例
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "error_code": "CBC.0000", "error_msg": "success", "currency": "CNY", "total_count": 1, "total_amount": 10212, "debt_amount": 56, "coupon_amount": 0, "cashcoupon_amount": 0, "storedcard_amount": 0, "debit_amount": 10156, "credit_amount": 0, "measure_id": 3, "bill_sums": [ { "customer_id": "7b47a4c7ec764e1a94c5c2eb1a578e77", "resource_type_code": "", "region_code": null, "cloud_service_type_code": "hws.service.type.ebs", "consume_time": "2019-12", "pay_method": "", "consume_amount": 10212, "debt": 56, "discount": 0, "measure_id": 3, "bill_type": 0, "account_details": [ { "balance_type_id": "BALANCE_TYPE_DEBIT", "deduct_amount": 10156 }, { "balance_type_id": "BALANCE_TYPE_CREDIT", "deduct_amount": 0 }, { "balance_type_id": "BALANCE_TYPE_BONUS", "deduct_amount": 0 }, { "balance_type_id": "BALANCE_TYPE_COUPON", "deduct_amount": 0 }, { "balance_type_id": "BALANCE_TYPE_DEBIT_RATE", "deduct_amount": 0 }, { "balance_type_id": "BALANCE_TYPE_FOREGIFT", "deduct_amount": 0 }, { "balance_type_id": "BALANCE_TYPE_BE_AVAILABLE", "deduct_amount": 0 }, { "balance_type_id": "BALANCE_TYPE_OTHER", "deduct_amount": 0 }, { "balance_type_id": "BALANCE_TYPE_RCASH_COUPON", "deduct_amount": 0 }, { "balance_type_id": "WRITEOFFDEBT", "deduct_amount": 0 }, { "balance_type_id": "BALANCE_TYPE_STORED_VALUE_CARD", "deduct_amount": 0 } ], "discount_detail_infos": [], "enterpriseProjectId": "0" } ] }