文档首页/ 合作伙伴中心/ API参考/ 管理账单/ 查询伙伴子客户消费记录
更新时间:2024-12-19 GMT+08:00
分享

查询伙伴子客户消费记录

功能介绍

伙伴在伙伴销售平台可实时查询子客户的消费记录,了解客户的资源消耗情况。

伙伴在伙伴中心查询客户消费明细请参见这里

  • 消费记录支持查询18个月内的记录。
  • 如果是客户经理主管来查询,只支持按照单个客户经理查询,必须输入客户经理ID。
  • 目前支持伙伴查询所有子客户(包含代售类和顾问销售类)的消费记录。
  • 如您的顾问销售子客户同时是财务托管模式企业子账号,解绑前当月账期消费数据体现在企业子账号,解绑后当月消费数据体现在企业主账号。详情请见“如何查询财务托管模式企业子账号解绑当月账期的消费数据”。

接口约束

该接口只允许使用合作伙伴AK/SK或者Token调用。

调试

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

URI

GET /v2/bills/subcustomer-bills/res-fee-records

参数说明请参见表1-1

表1 查询参数

参数

是否必选

参数类型

取值范围

描述

bill_cycle

String

最大长度:7

账期所在月份。

格式:YYYY-MM

customer_id

String

最大长度:64

客户账号ID。您可以调用查询客户列表接口获取customer_id。

service_type_code

String

最大长度:64

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

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

region_code

String

最大长度:64

云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。

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

charging_mode

Integer

-

计费模式。

  • 1:包周期
  • 3:按需
  • 10:预留实例
  • 11:节省计划

此参数不携带或携带值为空或携带为null时,默认查询所有计费模式下的消费记录;不支持携带值为空串。

bill_detail_type

Integer

-

账单类型。

  • 1:消费-新购
  • 2:消费-续订
  • 3:消费-变更
  • 4:退款-退订
  • 5:消费-使用
  • 8:消费-自动续订
  • 9:调账-补偿
  • 14:消费-服务支持计划月末扣费
  • 16:调账-扣费
  • 18:消费-按月付费
  • 20:退款-变更
  • 23:消费-节省计划抵扣
  • 24:退款-包年/包月转按需

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

resource_id

String

最大长度:64

资源标识。

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

resource_name

String

最大长度:128

资源名称。

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

trade_id

String

最大长度:64

订单ID或交易ID,扣费维度的唯一标识。

  • 账单类型为1,2,3,4,8时为订单ID。
  • 其它场景下为交易ID。
    • 非月末扣费:应收ID
    • 月末扣费:账单ID

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

account_manager_id

String

最大长度:64

客户经理标识。

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

indirect_partner_id

String

最大长度:64

云经销商ID。获取方法请参见查询云经销商列表

说明:
  • 华为云总经销商可以查询名下所有子客户消费(包括云经销商子客户)。
  • 如果是普通经销商,那么此处可以为空。
  • 如果华为云总经销商需要查询客户在云经销商关联期间的消费,需要携带该字段;除此之外,此参数不做处理。否则只能查询该客户在与自己关联期间的消费。

association_type

String

最大长度:2

子客户的关联类型:

  • 1:顾问销售
  • 2:代售

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

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。

bill_date_begin

String

最大长度:20

查询的资源消费记录的开始日期,格式为YYYY-MM-DD。

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

说明:
  • 必须和bill_cycle(即资源的消费账期)在同一个月。
  • bill_date_begin需小于等于bill_date_end。

bill_date_end

String

最大长度:20

查询的资源消费记录的结束日期,格式为YYYY-MM-DD。

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

说明:
  • 必须和bill_cycle(即资源的消费账期)在同一个月。
  • bill_date_begin和bill_date_end两个参数必须同时出现,否则仅按照bill_cycle(即资源的消费账期)进行查询。
  • bill_date_begin需小于等于bill_date_end。

请求消息

请求参数

无。

请求示例

GET https://bss.myhuaweicloud.com/v2/bills/subcustomer-bills/res-fee-records?bill_cycle=2021-04&customer_id=D60F111AB9BB4ADAA99E940EF144EF40&service_type_code=86CC8C59F70342C885F8AB13AEDDF342&region_code=0FE00BE8AEE3443C88C155033D1D0CAF&charging_mode=3&bill_detail_type=1&resource_id=88EB78D951A042629CF4D3A9370340B9&resource_name=B5F8A086477F469F8BAF0320441678D8&trade_id=4A9AFD7CFC2245419DDDE0B7AB813E18&account_manager_id=lvjingjing003&association_type=1&offset=0&limit=10&indirect_partner_id=5A2A73552DE24E07A996BB0DD5665464&bill_date_begin=2021-04-05&bill_date_end=2021-04-06

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:16

状态码。具体请参考状态码。只有失败才会返回这个参数。

error_msg

String

最大长度:1024

错误描述信息。只有失败才会返回这个参数。

fee_records

List<SubCustomerMonthlyBillDetail>

-

资源费用记录数据。

具体请参见表2

total_count

Integer

-

结果集数量,只有成功才返回这个参数。

currency

String

最大长度:3

货币单位代码:

CNY:人民币

表2 SubCustomerMonthlyBillDetail

参数

参数类型

取值范围

描述

bill_cycle

String

最大长度:20

账期。

格式:YYYY-MM

customer_id

String

最大长度:64

客户账号ID。

association_type

String

最大长度:2

子客户的关联类型:

  • 1:顾问销售
  • 2:代售

service_type_code

String

最大长度:400

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

resource_type_code

String

最大长度:400

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。

service_type_name

String

最大长度:200

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

resource_type_name

String

最大长度:200

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

charging_mode

Integer

-

计费模式。

  • 1:包周期
  • 3:按需
  • 10:预留实例
  • 11:节省计划

trade_time

String

最大长度:20

交易时间,即某条消费记录对应的扣费时间。

示例:2020-11-17T06:43:38Z

trade_id

String

最大长度:64

订单ID或交易ID,扣费维度的唯一标识。

  • 账单类型为1,2,3,4,8时为订单ID。
  • 其它场景下为交易ID。
    • 非月末扣费:应收ID
    • 月末扣费:账单ID

id

String

最大长度:256

唯一标识。

该字段为预留字段。

bill_detail_type

Integer

-

账单类型。

  • 1:消费-新购
  • 2:消费-续订
  • 3:消费-变更
  • 8:消费-自动续订
  • 5:消费-使用
  • 12:消费-按时计费
  • 4:退款-退订
  • 9:调账-补偿
  • 13:消费-退订手续费增收
  • 14:消费-服务支持计划月末补扣
  • 16:调账-扣费
  • 18:消费-按月付费
  • 20:退款-变更
  • 23:消费-节省计划抵扣
  • 24:退款-包年/包月转按需
  • 100:退款-退订税金
  • 101:调账-补偿税金
  • 102:调账-扣费税金

resource_id

String

最大长度:128

资源ID。

resource_name

String

最大长度:256

资源名称。

product_spec_desc

String

最大长度:512

产品的规格描述。

region_code

String

最大长度:64

云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。

product_id

String

最大长度:64

产品ID。

product_name

String

最大长度:256

产品名称。

resource_tag

String

最大长度:1024

资源标签。

consume_time

String

最大长度:50

消费时间。

包周期、预留实例预付为交易时间。

格式:yyyy-MM-ddTHH:mm:ssZ

按需、预留实例按时计费为话单生失效时间。

格式:yyyy-MM-ddTHH:mm:ssZ|yyyy-MM-ddTHH:mm:ssZ

usage_type

String

-

资源使用量的类型,您可以调用查询使用量类型列表接口获取。

usage_amount

BigDecimal

-

资源的使用量。

usage_measure_id

Integer

-

资源使用量的度量单位,您可以调用查询度量单位列表接口获取。

free_resource_usage

BigDecimal

-

套餐内使用量。

free_resource_measure_id

Integer

-

套餐内使用量的度量单位,您可以调用查询度量单位列表接口获取。

ri_usage

BigDecimal

-

预留实例使用量。

ri_usage_measure_id

Integer

-

预留实例使用量单位。

official_amount

BigDecimal

-

官网价。

official_discount_amount

BigDecimal

-

对应官网价折扣金额。

payment_amount

BigDecimal

-

应付金额。

cash_amount

BigDecimal

-

现金支付金额。

credit_amount

BigDecimal

-

信用额度支付金额。

coupon_amount

BigDecimal

-

代金券支付金额。

flexipurchase_coupon_amount

BigDecimal

-

现金券支付金额。

stored_value_card_amount

BigDecimal

-

储值卡支付金额。

debt_amount

BigDecimal

-

欠费金额。

writeoff_amount

BigDecimal

-

欠费核销金额。

period_type

Integer

-

周期类型:

  • 19:年
  • 20:月
  • 24:天
  • 25:小时
  • 5:一次性

account_manager_id

String

最大长度:128

客户经理标识。

partner_id

String

最大长度:64

关联的经销商ID。

region_name

String

最大长度:64

云服务区名称,例如:“华北-北京”。具体请参见地区和终端节点对应云服务的“区域名称”列的值。

sub_service_type_code

String

最大长度:64

整机的子云服务的自身的云服务类型编码。

sub_service_type_name

String

最大长度:200

整机的子云服务的自身的云服务类型名称

sub_resource_type_code

String

最大长度:64

整机的子云服务的自身的资源类型编码

sub_resource_type_name

String

最大长度:200

整机的子云服务的自身的资源类型名称。

sub_resource_id

String

最大长度:64

整机的子云服务的自身的资源ID,资源标识。(如果为预留实例,则为预留实例标识)

sub_resource_name

String

最大长度:256

整机的子云服务的自身的资源名称,资源标识。(如果为预留实例,则为预留实例标识)

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "total_count": 1,
    "currency": "CNY",
    "fee_records": [
        {
            "bill_cycle": "2020-11",
            "customer_id": "0501ed039b80d5b50f8cc00878383140",
            "association_type": "1",
            "service_type_code": "hws.service.type.ec2",
            "resource_type_code": "hws.resource.type.vm",
            "charging_mode": 10,
            "trade_time": "2020-11-16T15:59:59Z",
            "trade_id": "ss20200424zero01",
            "id": "037e8a2b-bd******-5f9eb5153cba_1",
            "bill_detail_type": 12,
            "resource_id": "01154-145400057-0",
            "resource_name": null,
            "product_spec_desc": "m3型1核8G云主机Linux ",
            "region_code": "cn-north-1",
            "product_id": "23268f5406324c198b1b1434d5ecd6fd",
            "product_name": "RI产品-m1.medium.linux",
            "resource_tag": null,
            "consume_time": "2020-09-30T16:00:00Z|2020-10-31T16:00:00Z",
            "usage_type": null,
            "usage_amount": null,
            "usage_measure_id": 0,
            "free_resource_usage": null,
            "free_resource_measure_id": 0,
            "ri_usage": null,
            "ri_usage_measure_id": 0,
            "official_amount": 22320.0,
            "official_discount_amount": 0.0,
            "payment_amount": 22320.0,
            "cash_amount": 0.0,
            "credit_amount": 0.0,
            "coupon_amount": 0.0,
            "flexipurchase_coupon_amount": 0.0,
            "stored_value_card_amount": 0.0,
            "debt_amount": 22320.0,
            "writeoff_amount": null,
            "period_type": 25,
            "account_manager_id": "lvjingjing003",
            "partner_id": "759b663910034f4c8f53e4cda1ea06c5",
            "region_name": "华北-北京一",
            "sub_service_type_code": null,
            "sub_service_type_name": null,
            "sub_resource_type_code": null,
            "sub_resource_type_name": null,
            "sub_resource_id": null,
            "sub_resource_name": null
        }
    ]
}

状态码

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

HTTP状态码

错误码

错误描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

未知错误。

相关文档