文档首页 > > API参考> 管理账单> 查询消费汇总

查询消费汇总

分享
更新时间: 2019/10/25 GMT+08:00

功能介绍

客户在客户自建平台查询自身的消费汇总账单,此账单按月汇总消费数据。消费汇总数据仅包含前一天24点前的数据。

Web UI

客户可以登录费用中心查询自身的消费汇总账单。

  1. 进入“消费汇总”页面。
  2. 查看2018/01至今的月度账单概览、消费账单、退订明细等信息。

    • 存在退订信息时,可以在“退款”区域,查看退订详情。
    • 存在华为核销时,可以在“调账”区域,查看华为返还的详细信息。

  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”返回具体的资源类型。

  1. URI

    GET /v1.0/{domain_id}/customer/account-mgr/bill/monthly-sum

    参数说明请参见下表。

    表1 路径参数

    参数

    是否必选

    取值范围

    描述

    domain_id

    最大长度:64

    客户账号ID。获取方法请参见如何获取customer_id/domain_id

    表2 查询参数

    参数

    是否必选

    参数类型

    取值范围

    描述

    cycle

    String

    最大长度:10

    查询账期。

    格式固定为YYYY-MM。

    示例:2018-05

    cloud_service_type_code

    String

    最大长度:256

    云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。具体请参见云服务类型

    • 当不传递此参数时,查询的账单是以云服务类型为维度的月度消费账单。
    • 当传递此参数时,查询的账单是该云服务类型下以资源类型为维度的月度消费账单。

    type

    String

    [0|1]

    • 0:华为云账户
    • 1:伙伴拨款账户

      仅当客户关联合作伙伴且关联类型为垫付模式时,才会存在伙伴拨款账户。

    不传此参数默认查询华为云账户下的消费汇总。

    enterpriseProjectId

    String

    -

    企业项目ID。

    获取方法请参见如何获取企业项目ID

  1. 请求消息

    请求参数

    无。

    请求示例

    GET /v1.0/{domain_id}/customer/account-mgr/bill/monthly-sum?cycle=2018-05&type=0 HTTP/1.1
    Host: Host Server
    Content-Type: application/json
    X-Sdk-Date: request time
    Authorization: authorization

  1. 响应消息

    响应参数

    参数

    参数类型

    描述

    error_code

    String

    状态码。

    具体请参考4

    error_msg

    String

    错误描述信息。

    currency

    String

    币种。

    CNY:人民币。

    值为空代表人民币。

    total_count

    Integer

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

    bill_sums

    List<BillSumRecordInfo>

    账单记录,具体参考表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

    云服务类型编码,例如ECS的云服务类型编码为“hws.service.type.ec2”。具体请参见云服务类型

    consume_time

    String

    消费统计的时期。

    格式为YYYY-MM。

    示例:2018-05

    pay_method

    String

    消费类型。

    • 当请求消息中不传递“cloud_service_type_code”参数时,如果此值返回“0”表示此服务类型下所有的资源类型都是包周期计费模式,如果此值返回空字符串表示此服务类型下有资源类型为按需计费模式。
    • 当请求消息中传递“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。

    当请求参数中传递了“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:严选商品折扣

    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  
    
    {
        "currency": "CNY",
        "error_code": "CBC.0000",
        "error_msg": "success",
        "total_count": 3,
        "bill_sums": [
            {
                "debt": 0,
                "discount": 0,
                "customer_id": "62a26ff9b6c24d75b058c67d7f88b86b",
                "resource_type_code": null,
                "region_code": null,
                "cloud_service_type_code": "hws.service.type.ebs",
                "consume_time": "2018-05",
                "pay_method": "0",
                "consume_amount": 17000,
                "measure_id": 3,
                "bill_type": 0,
                "account_details": [
                    {
                        "balance_type_id": "BALANCE_TYPE_DEBIT",
                        "deduct_amount": 8050
                    },
                    {
                        "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_RCASH_COUPON",
                        "deduct_amount": 8950
                    }
                ],
                "discount_detail_infos": []
            },
            {
                "debt": 0,
                "discount": 0,
                "customer_id": "62a26ff9b6c24d75b058c67d7f88b86b",
                "resource_type_code": null,
                "region_code": null,
                "cloud_service_type_code": "hws.service.type.vpc",
                "consume_time": "2018-05",
                "pay_method": "0",
                "consume_amount": 12600,
                "measure_id": 3,
                "bill_type": 0,
                "account_details": [
                    {
                        "balance_type_id": "BALANCE_TYPE_DEBIT",
                        "deduct_amount": 4546
                    },
                    {
                        "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_RCASH_COUPON",
                        "deduct_amount": 8054
                    }
                ],
                "discount_detail_infos": []
            },
            {
                "debt": 0,
                "discount": 0,
                "customer_id": "62a26ff9b6c24d75b058c67d7f88b86b",
                "resource_type_code": null,
                "region_code": null,
                "cloud_service_type_code": "hws.service.type.ec2",
                "consume_time": "2018-05",
                "pay_method": "0",
                "consume_amount": 114400,
                "measure_id": 3,
                "bill_type": 0,
                "account_details": [
                    {
                        "balance_type_id": "BALANCE_TYPE_DEBIT",
                        "deduct_amount": 41258
                    },
                    {
                        "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_RCASH_COUPON",
                        "deduct_amount": 73142
                    }
                ],
                "discount_detail_infos": []
            }
        ]
    }

  1. 状态码

    状态码

    描述

    CBC.0000

    成功。

    CBC.0999

    其他错误。

    CBC.0151

    访问拒绝。

    CBC.0100

    输入参数校验失败。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区