查询流水账单
接口约束
该接口只允许使用客户AK/SK或者Token调用。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/bills/customer-bills/fee-records
|
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
|
X-Language |
否 |
String |
最大长度:10 |
语言。
默认为zh_CN:中文。 |
|
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|---|
|
bill_cycle |
是 |
String |
最大长度:8 |
查询的流水账单所在账期,东八区时间,格式为YYYY-MM。 |
|
provider_type |
否 |
Integer |
[1-2] |
服务商。
为空时查询包含华为云和云商店在内的全部服务商。 此参数不携带或携带值为空时,不作为筛选条件。 |
|
service_type_code |
否 |
String |
最大长度:64 |
云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。您可以调用查询云服务类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件。 |
|
resource_type_code |
否 |
String |
最大长度:64 |
资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。 此参数不携带或携带值为空时,不作为筛选条件。 |
|
region_code |
否 |
String |
最大长度:64 |
云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 此参数不携带或携带值为空时,不作为筛选条件。 |
|
charging_mode |
否 |
Integer |
- |
计费模式:
此参数不携带或携带值为空时,不作为筛选条件。 |
|
bill_type |
否 |
Integer |
- |
账单类型:
此参数不携带或携带值为空时,不作为筛选条件。 |
|
trade_id |
否 |
String |
最大长度:64 |
订单ID或交易ID。 此参数不携带或携带值为空时,不作为筛选条件。 |
|
enterprise_project_id |
否 |
String |
最大长度:64 |
企业项目标识(企业项目ID)。
此参数不携带或携带值为空或携带值为null时,不作为筛选条件;不支持携带值为空串。 |
|
include_zero_record |
否 |
Boolean |
- |
返回是否包含应付金额为0的记录。
默认为true:包含。 此参数不携带或携带值为空时,不作为筛选条件。 |
|
status |
否 |
Integer |
- |
支付状态。
此参数不携带或携带值为空时,不作为筛选条件。 |
|
method |
否 |
String |
最大长度:64 |
查询流水账单的方式。
此参数不携带或携带值为空时,默认值为“all”,如果没有企业子客户,取值为all时查询的是客户自己的流水账单。
说明:
若需要查询财务独立企业子的账单信息,前提是子账号已经接受了企业主账号的“允许查看子账号消费信息”的申请。申请方法见“变更子账号权限”。 |
|
sub_customer_id |
否 |
String |
最大长度:64 |
企业子账号ID。
说明:
|
|
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_date_end |
否 |
String |
最大长度:20 |
查询的流水账单的结束日期,东八区时间,格式为YYYY-MM-DD。 此参数不携带或携带值为空时,不作为筛选条件。
说明:
|
请求消息
请求参数
无
请求示例
GET https://bss.myhuaweicloud.com/v2/bills/customer-bills/fee-records?bill_cycle=2020-08&offset=0&limit=10&provider_type=1&service_type_code=hws.service.type.obs&resource_type_code=hws.resource.type.obs®ion_code=cn-north-1&charging_mode=3&bill_type=1&trade_id=CS1908201442ZLEPW476&enterprise_project_id=0&include_zero_record=true&status=1&method=oneself&bill_date_begin=2020-09-01&bill_date_end=2020-09-30 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
error_code |
String |
最大长度:16 |
状态码。具体请参考状态码。只有失败才会返回这个参数。 |
|
error_msg |
String |
最大长度:1024 |
错误描述信息。只有失败才会返回这个参数。 |
|
records |
List<MonthlyBillRecord> |
- |
资源费用记录数据。 具体请参见表3。 |
|
total_count |
Integer |
- |
结果集数量,只有成功才返回这个参数。 |
|
currency |
String |
最大长度:3 |
币种。 CNY:人民币 |
|
参数 |
参数类型 |
取值范围 |
描述 |
|---|---|---|---|
|
bill_cycle |
String |
最大长度:8 |
流水账单所在账期,东八区时间,格式为YYYY-MM。 |
|
customer_id |
String |
最大长度:64 |
消费客户的账号ID。
|
|
service_type_code |
String |
最大长度:64 |
云服务类型编码,例如OBS的云服务类型编码为“hws.service.type.obs”。 |
|
resource_type_code |
String |
最大长度:64 |
资源类型编码,例如ECS的VM为“hws.resource.type.vm”。 |
|
service_type_name |
String |
最大长度:200 |
云服务类型名称。例如ECS的云服务类型名称为“弹性云服务器”。 |
|
resource_type_name |
String |
最大长度:200 |
资源类型名称。例如ECS的资源类型名称为“云主机”。 |
|
region_code |
String |
最大长度:64 |
云服务区编码,例如:“cn-north-1”。具体请参见地区和终端节点对应云服务的“区域”列的值。 |
|
enterprise_project_id |
String |
- |
企业项目标识(企业项目ID)。
|
|
enterprise_project_name |
String |
- |
企业项目的名称。 |
|
charging_mode |
Integer |
- |
计费模式。
|
|
consume_time |
String |
最大长度:32 |
消费时间。 格式:yyyy-MM-dd'T'HH:mm:ss'Z'。按照UTC时间截取。
|
|
trade_time |
String |
最大长度:32 |
交易时间,某条消费记录对应的扣费时间。 |
|
provider_type |
Integer |
- |
服务商。
|
|
trade_id |
String |
最大长度:64 |
订单ID或交易ID,扣费维度的唯一标识。 |
|
id |
String |
最大长度:256 |
唯一标识。 该字段为预留字段。 |
|
bill_type |
Integer |
- |
账单类型。
|
|
status |
Integer |
- |
支付状态。
|
|
official_amount |
BigDecimal |
- |
官网价。单位:元。
说明:
official_amount = official_discount_amount + erase_amount + consume_amount |
|
official_discount_amount |
BigDecimal |
- |
折扣金额。单位:元。 |
|
erase_amount |
BigDecimal |
- |
抹零金额。单位:元。 |
|
consume_amount |
BigDecimal |
- |
应付金额,包括现金券和储值卡和代金券金额。单位:元。
说明:
consume_amount的值等于cash_amount,credit_amount,coupon_amount,flexipurchase_coupon_amount,stored_value_card_amount,bonus_amount,debt_amount,writeoff_amount的总和。 |
|
cash_amount |
BigDecimal |
- |
现金支付金额。单位:元. |
|
credit_amount |
BigDecimal |
- |
信用额度支付金额。单位:元。 |
|
coupon_amount |
BigDecimal |
- |
代金券支付金额。单位:元。 |
|
flexipurchase_coupon_amount |
BigDecimal |
- |
现金券支付金额。单位:元。 |
|
stored_value_card_amount |
BigDecimal |
- |
储值卡支付金额。单位:元。 |
|
bonus_amount |
BigDecimal |
- |
奖励金支付金额(奖励金已经下线,目前用于现网客户未使用完的奖励金)。单位:元。 |
|
debt_amount |
BigDecimal |
- |
欠费金额。单位:元。
说明:
对于月结客户,欠费金额即页面上的月度结算金额。 |
|
writeoff_amount |
BigDecimal |
- |
欠费核销金额。单位:元。 |
|
region_name |
String |
最大长度:64 |
云服务区名称,例如:“华北-北京”。具体请参见地区和终端节点对应云服务的“区域名称”列的值。 |
|
account_name |
String |
最大长度:128 |
消费客户的登录名称。
|
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time
{
"total_count": 1,
"records": [
{
"bill_cycle": "2020-08",
"customer_id": "06a2a26a7b00d5a80f5ac01d33352a60",
"service_type_code": "hws.service.type.obs",
"resource_type_code": "hws.resource.type.obs",
"region_code": "cn-north-1",
"enterprise_project_id": "0",
"enterprise_project_name": "default",
"charging_mode": 3,
"consume_time": "2020-08-01T03:02:35Z-2020-08-01T15:59:59Z",
"trade_time": "2020-08-01T03:02:35Z",
"provider_type": 1,
"trade_id": "CS1908201442ZLEPW476",
"id": "037e8a2b-bde9-4820-9801-5f9eb5153cba_1",
"bill_type": 1,
"status": 1,
"official_amount": 2.8,
"official_discount_amount": 0,
"erase_amount": 0,
"consume_amount": 2.8,
"cash_amount": 2.8,
"credit_amount": 0.0,
"coupon_amount": 0.0,
"flexipurchase_coupon_amount": 0.0,
"stored_value_card_amount": 0.0,
"bonus_amount": 0.0,
"debt_amount": 0.0,
"writeoff_amount": 0.0,
"region_name": "华北-北京一",
"account_name": "bei******7"
}
],
"currency": "CNY"
}
