客户运营能力客户运营能力

更新时间:2021/07/23 GMT+08:00
分享

查询汇总账单

功能介绍

客户在自建平台查询自身的消费汇总账单,此账单按月汇总消费数据。

客户登录费用中心查询自身的消费汇总账单请参见这里的“查看汇总”。

当前支持查看2019/01月份至今的费用账单。企业主账号展示的费用账单,包含关联的统一还款企业子账号的消费数据。

接口约束

  • 该接口只允许使用客户AK/SK或者Token调用。
  • 当请求参数不传递“service_type_code”时,查询的账单是以云服务类型为维度的月度消费账单,即总条数“total_count”是以云服务类型进行统计 ,每条账单记录一种云服务类型的月度消费汇总。此时响应参数中返回的资源类型“resource_type_code”为“null”。
  • 当请求参数传递“service_type_code”时,查询的账单是以资源类型为维度的月度消费账单,即总条数“total_count”是具体云服务类型下以资源类型进行统计,每条账单记录该云服务类型下的一种资源类型的月度消费汇总。此时响应参数中返回的资源类型“resource_type_code”返回具体的资源类型。

调试

您可以在API Explorer中直接运行调试该接口。

URI

GET /v2/bills/customer-bills/monthly-sum

参数说明请参见下表。

表1 查询参数

参数

是否必选

参数类型

取值范围

描述

bill_cycle

String

最大长度:8

查询消费汇总数据所在的账期,格式为YYYY-MM。

service_type_code

String

最大长度:64

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。您可以调用查询云服务类型列表接口获取。

enterprise_project_id

String

最大长度:64

企业项目标识(企业项目ID)。

  • default项目对应ID:0
  • 未归集(表示该云服务不支持企业项目管理能力)项目对应ID:-1
  • 其余项目对应ID获取方法请参见如何获取企业项目ID

method

String

最大长度:64

查询方式。

  • oneself:自身
  • sub_customer:企业子客户
  • all:自己和企业子客户

默认为all,如果没有企业子客户,all的时候也是查询自己的。

sub_customer_id

String

最大长度:64

企业子客户的账号ID。

说明:
  • 如果method取值不为sub_customer,则该参数无效。
  • 如果method取值为sub_customer,则该参数不能为空。

offset

Integer

[0-最大整数]

偏移量,从0开始。默认值为0。

说明:

offset用于分页处理,如不涉及分页,请使用默认值0。offset表示相对于满足条件的第一个数据的偏移量。如offset = 1,则返回满足条件的第二个数据至最后一个数据。

例如,满足查询条件的结果共10条数据,limit取值为10,offset取值为1,则返回的数据为2~10,第一条数据不返回。

limit

Integer

[1-1000]

每次查询的数量。默认值为10。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v2/bills/customer-bills/monthly-sum?bill_cycle=2020-07&method=sub_customer&sub_customer_id=05b5fef62300d2ad0f98c00befba72c0&offset=0&limit=10 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:20

状态码。具体请参考状态码

只有失败才会返回这个参数。

error_msg

String

最大长度:2000

错误描述信息。

只有失败才会返回这个参数。

total_count

Integer

-

总条数,必须大于等于0。

bill_sums

List<BillSumRecordInfo>

-

账单记录,具体参考表2

consume_amount

Bigdecimal

-

总金额(包含退订)。

debt_amount

Bigdecimal

-

总欠费金额。

coupon_amount

Bigdecimal

-

代金券金额。

flexipurchase_coupon_amount

Bigdecimal

-

现金券金额,预留。

stored_value_card_amount

Bigdecimal

-

储值卡金额,预留。

cash_amount

Bigdecimal

-

现金账户金额。

credit_amount

Bigdecimal

-

信用账户金额。

writeoff_amount

Bigdecimal

-

欠费核销金额。

measure_id

Integer

-

金额单位。

  • 1:元

currency

String

最大长度:4

币种。

CNY:人民币。

表2 BillSumRecordInfo

参数

参数类型

取值范围

描述

bill_cycle

String

最大长度:8

消费汇总数据所在账期,格式:YYYY-MM。

bill_type

Integer

-

账单类型。

  • 1:消费
  • 2:退款
  • 3:调账

customer_id

String

最大长度:64

消费的客户账号ID。

  • 如果是普通客户或者企业子客户查询消费记录,只能查询到客户自己的消费记录,且此处显示的是客户自己的客户ID。
  • 如果是企业主查询消费记录,可以查询到企业主以及企业子客户的消费记录,此处为消费的实际客户ID。如果是企业主自己的消费记录,则为企业主ID;如果是某个企业子客户的消费记录,则此处为企业子账号ID。

resource_type_code

String

最大长度:64

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。

service_type_code

String

最大长度:64

云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。您可以调用查询云服务类型列表接口获取。

charging_mode

Integer

-

计费模式。

  • 1:包年/包月
  • 3:按需
  • 10:预留实例

official_amount

Bigdecimal

-

官网价。

official_discount_amount

Bigdecimal

-

折扣金额。

truncated_amount

Bigdecimal

-

抹零金额。

consume_amount

Bigdecimal

-

应付金额。

应付金额=官网价-折扣金额-抹零金额

coupon_amount

Bigdecimal

-

代金券金额。

flexipurchase_coupon_amount

Bigdecimal

-

现金券金额,预留。

stored_value_card_amount

Bigdecimal

-

储值卡金额,预留。

debt_amount

Bigdecimal

-

欠费金额。即伙伴从客户账户扣费时,客户账户金额不足,欠费的金额。

writeoff_amount

Bigdecimal

-

欠费核销金额。

cash_amount

Bigdecimal

-

现金账户金额。

credit_amount

Bigdecimal

-

信用账户金额。

measure_id

Integer

-

金额单位。

  • 1:元

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 2,
    "bill_sums": [
        {
            "bill_cycle": "2020-07",
            "bill_type": 1,
            "customer_id": "05b5fef62300d2ad0f98c00befba72c0",
            "resource_type_code": "hws.resource.type.bandwidth",
            "service_type_code": "hws.service.type.vpc",
            "charging_mode": 3,
            "official_amount": 7.0,
            "official_discount_amount": 0.0,
            "truncated_amount": 2.363856,
            "consume_amount": 7.0,
            "coupon_amount": 0.0,
            "flexipurchase_coupon_amount": 0.0,
            "stored_value_card_amount": 0.0,
            "debt_amount": 0.0,
            "writeoff_amount": 0.0,
            "cash_amount": 0.0,
            "credit_amount": 7.0,
            "measure_id": 1
        },
        {
            "bill_cycle": "2020-07",
            "bill_type": 1,
            "customer_id": "05b5fef62300d2ad0f98c00befba72c0",
            "resource_type_code": "hws.resource.type.kms",
            "service_type_code": "hws.service.type.kms",
            "charging_mode": 3,
            "official_amount": 3524.424,
            "official_discount_amount": 0.0,
            "truncated_amount": 1244.424,
            "consume_amount": 2280.0,
            "coupon_amount": 0.0,
            "flexipurchase_coupon_amount": 0.0,
            "stored_value_card_amount": 0.0,
            "debt_amount": 0.0,
            "writeoff_amount": 0.0,
            "cash_amount": 0.0,
            "credit_amount": 2280.0,
            "measure_id": 1
        }
    ],
    "consume_amount": 16964.0,
    "debt_amount": 0.0,
    "coupon_amount": 464.0,
    "flexipurchase_coupon_amount": 0.0,
    "stored_value_card_amount": 0.0,
    "cash_amount": 1306.0,
    "credit_amount": 15194.0,
    "writeoff_amount": 0.0,
    "measure_id": 1,
    "currency": "CNY"
}

状态码

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。

分享:

    相关文档

    相关产品