查询汇总账单(旧)
接口约束
- 该接口只允许使用客户AK/SK或者Token调用。
- 当请求参数不传递“cloud_service_type_code”时,查询的账单是以云服务类型为维度的月度消费账单,即总条数“total_count”是以云服务类型进行统计 ,每条账单记录一种云服务类型的月度消费汇总。此时响应参数中返回的资源类型“resource_type_code”返回具体的资源类型。
- 当请求参数传递“cloud_service_type_code”时,查询的账单是以资源类型为维度的月度消费账单,即总条数“total_count”是具体云服务类型下以资源类型进行统计,每条账单记录该云服务类型下的一种资源类型的月度消费汇总。此时响应参数中返回的资源类型“resource_type_code”返回具体的资源类型。
URI
GET /v1.0/{domain_id}/customer/account-mgr/bill/monthly-sum
参数说明请参见下表。
| 参数 | 是否必选 | 取值范围 | 描述 |
|---|---|---|---|
| domain_id | 是 | 最大长度:64 | 客户账号ID。 |
| 参数 | 是否必选 | 参数类型 | 取值范围 | 描述 |
|---|---|---|---|---|
| cycle | 是 | String | 最大长度:7 | 查询消费汇总账单所在的账期,东八区时间,格式为YYYY-MM。 |
| cloud_service_type_code | 否 | String | 最大长度:256 | 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表-ListServiceTypes接口获取。
|
| type | 否 | String | [0|1] |
不传此参数默认查询华为云账户下的消费汇总。 此参数不支持携带传空或携带值为空串或携带为null。 |
| enterpriseProjectId | 否 | String | - | 企业项目标识(企业项目ID)。
此参数不携带或携带值为空时,不作为筛选条件。携带值为null时,作为筛选条件。不支持携带值为空串。 |
请求消息
请求参数
无。
请求示例
GET https://bss-intl.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 | 状态码。具体请参考状态码。 只有失败才会返回这个参数。 |
| error_msg | String | 错误描述信息。 只有失败才会返回这个参数。 |
| currency | String | 币种。 USD:美元。 值为空代表美元。 |
| 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 | 金额单位。
|
| 参数 | 参数类型 | 描述 |
|---|---|---|
| customer_id | String | 客户账号ID。 |
| resource_type_code | String | 资源类型编码,例如ECS的VM为“hws.resource.type.vm”。 说明: 当请求参数不传递“cloud_service_type_code”时,响应参数“bill_sums”返回的是以云服务类型为维度的账单记录,资源类型编码的返回值无效。 |
| region_code | String | 云服务区,该字段预留,先不使用。 |
| cloud_service_type_code | String | 云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。 |
| consume_time | String | 消费统计的时期。 东八区时间,格式为YYYY-MM。 示例:2018-05。 |
| pay_method | String | 消费类型,该字段预留,先不使用。
|
| consume_amount | Bigdecimal | 消费的金额,即从客户账户实际扣除的金额。包含代金券支付的金额。 |
| debt | Bigdecimal | 欠费金额,即从客户账户扣费的时候,客户账户金额不足,欠费的金额。 |
| discount | Bigdecimal | 折扣金额。 |
| measure_id | Integer | 金额单位。
|
| bill_type | Integer | 账单类型。
|
| account_details | List<BalanceTypePay> | 按不同账户消费类型和付费方式区分的支付总金额。 具体请参见表4。 |
| discount_detail_infos | List<DiscountDetailInfo> | 折扣金额详情。 具体请参见表5。 当bill_type为1时,不返回此参数。 |
| enterpriseProjectId | String | 企业项目标识(企业项目ID)。
当请求参数中传递了“enterpriseProjectId”,响应参数“bill_sums”返回以企业项目ID为维度的账单记录。 说明: 当请求参数不传递“enterpriseProjectId”时,响应参数“bill_sums”返回的是以非企业项目ID为维度的账单记录,该字段仅供参考。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| balance_type_id | String | 账户类型。
|
| deduct_amount | Bigdecimal | 支出金额。 单位:分 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| promotion_type | String | 折扣类型。 500:代理订购指定折扣 501:代理订购指定减免 502:代理订购指定一口价 600:合同折扣返利 (商履折扣) 601:渠道框架合同折扣 602:专款专用合同折扣(特殊商务合同折扣) 603:线下直签合同折扣 604:电销授权合同折扣 605:商务合同折扣 606:渠道商务合同折扣 607:合作伙伴授权折扣 608:严选商品折扣 610:免单金额 611:节省计划 700:促销折扣 (促销,只有包年/包月场景) 800:赠送奖励金 |
| discount_amount | BigDecimal | 折扣金额。 |
| promotion_id | String | 折扣类型对应的标识,可为合同ID或商务ID。 |
| measure_id | Integer | 金额单位。
默认值为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": "USD",
"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"
}
]
}
