文档首页/ 客户运营能力/ API参考/ 管理账单/ 查询汇总账单
更新时间：2025-10-23 GMT+08:00
查看PDF
分享

查询汇总账单

功能介绍

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

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

  • 企业主账号展示的费用账单，包含关联的统一还款企业子账号的消费数据。
  • 支持查看近3年内的数据。
  • 若需要查询财务独立企业子的账单信息，前提是子账号已经接受了企业主账号的“允许查看子账号消费信息”的申请。申请方法见“变更子账号权限”。

接口约束

该接口只允许使用客户AK/SK或者Token调用。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

参数说明请参见下表。

表1 查询参数

参数

是否必选

参数类型

取值范围

描述

bill_cycle

是

String

最大长度：8

查询消费汇总数据所在的账期，东八区时间，格式为YYYY-MM。

service_type_code

否

String

最大长度：64

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

此参数不携带或携带值为空时，不作为筛选条件。

enterprise_project_id

否

String

最大长度：64

企业项目标识（企业项目ID）。

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

此参数不携带或携带值为空时，不作为筛选条件。携带值为null时，作为筛选条件。不支持携带值为空串。

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，则返回满足条件的第二个数据至最后一个数据。

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

示例2，查询总数20条，期望每页返回10条数据，则获取第一页数据，入参offset填写0，limit填写10；获取第二页数据，入参offset填写10，limit填写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-Token：MIIPAgYJKoZIhvcNAQcCo...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

云服务类型编码，例如OBS的云服务类型编码为“hws.service.type.obs”。

resource_type_name

String

最大长度：200

资源类型名称。例如ECS的资源类型名称为“云主机”。

service_type_name

String

最大长度：200

云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。

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：元

account_name

String

最大长度：128

消费客户的登录名称。

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

响应示例

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,
            "account_name": "be******7"
        },
        {
            "bill_cycle": "2020-07",
            "bill_type": 1,
            "customer_id": "05b5fef62300d2ad0f98c00befba72c0",
            "resource_type_code": "hws.resource.type.kms",
            "service_type_code": "hws.service.type.kms",
            "resource_type_name": "云主机",
            "service_type_name": "弹性云服务器",
            "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,
            "account_name": "be******7"
        }
    ],
    "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"
}

状态码

  • 状态码4xx：由于明显的客户端错误（例如，格式错误的请求语法、参数错误等），华为云会返回4xx错误码，请及时检查请求消息的正确性，重新发起请求。
  • 状态码5xx：由于华为云系统原因，导致无法完成明显有效请求的处理，可及时联系华为云客服处理。

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。
父主题： 管理账单

相关文档