查询伙伴消费子客户列表-ListConsumeSubCustomers

功能介绍

伙伴在伙伴销售平台可实时查询消费账期内的子客户列表，可以用于查询子客户的消费记录。

若当前子客户与伙伴无关联关系，仍可查询账期内处于关联状态且有消费的子客户列表。

接口约束

该接口只允许使用解决方案提供商或华为云总经销商（一级经销商）的AK/SK或者Token调用。

调试

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

授权信息

操作员账号调用当前API需经过授权，您可以通过伙伴中心为操作员赋予相应权限项来完成授权。有关如何为角色授权的详细信息，请参见为组织人员分配权限。

接口对应的权限项如下：

权限项	权限项名称
BPC_ITEM_FINANCE_020101	销售-客户-客户消费-消费记录-查看详情

URI

POST /v2/bills/subcustomer-bills/res-fee-records/sub-customers/query

请求消息

请求参数

参数	是否必选	参数类型	取值范围	描述
bill_cycle	是	String	最大长度：10	账期所在月份。格式：YYYY-MM。
offset	否	Integer	[0-2147483646]	偏移量，从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-100]	一次查询的条数，默认值为10。

参数

是否必选

参数类型

取值范围

描述

bill_cycle

是

String

最大长度：10

账期所在月份。

格式：YYYY-MM。

offset

否

Integer

[0-2147483646]

偏移量，从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-100]

一次查询的条数，默认值为10。

请求示例

POST https://bss.myhuaweicloud.com/v2/bills/subcustomer-bills/res-fee-records/sub-customers/query HTTP/1.1
Content-Type: application/json
X-Auth-Token：MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "bill_cycle": "2022-03",
    "offset": 0,
    "limit": 10
}

响应消息

响应参数

参数	参数类型	取值范围	描述
error_code	String	最大长度：16	状态码。具体请参考状态码。只有失败才会返回这个参数。
error_msg	String	最大长度：1024	错误描述信息。只有失败才会返回这个参数。
sub_customers	List<SubCustomerInfo>	-	子客户列表。具体请参见表SubCustomerInfo。
total_count	Integer	-	结果集数量，只有成功才返回这个参数。

表1 SubCustomerInfo
参数	参数类型	取值范围	描述
customer_id	String	最大长度：64	客户账号ID。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "sub_customers": [
        {
            "customer_id": "0501ed********b50f8cc00878383140"
        }
    ],
    "total_count": 1
}