客户运营能力客户运营能力

更新时间:2021/09/08 GMT+08:00
分享

查询流水账单

功能介绍

客户在自建平台查询自己的消费流水账单

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

接口约束

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

调试

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

URI

GET /v2/bills/customer-bills/fee-records

表1 消息头参数

参数

是否必选

参数类型

取值范围

描述

X-Language

String

最大长度:10

语言。

  • en_US:英文
  • zh_CN:中文

默认为zh_CN:中文。

查询参数

参数

是否必选

参数类型

取值范围

描述

bill_cycle

String

最大长度:8

查询的流水账单所在账期,格式为YYYY-MM。

provider_type

Integer

[1-2]

服务商。

  • 1:华为云
  • 2:云市场

为空时查询包含华为云和云市场在内的全部服务商。

service_type_code

String

最大长度:64

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

resource_type_code

String

最大长度:64

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。

region_code

String

最大长度:64

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

charging_mode

Integer

-

计费模式:

  • 1 : 包年/包月
  • 3:按需
  • 10:预留实例

bill_type

Integer

-

账单类型:

  • 1:消费-新购
  • 2:消费-续订
  • 3:消费-变更
  • 4:退款-退订
  • 5:消费-使用
  • 8:消费-自动续订
  • 9:调账-补偿
  • 14:消费-服务支持计划月末扣费
  • 16:调账-扣费

trade_id

String

最大长度:64

订单ID或交易ID。

  • 账单类型为1、2、3、4和8时此处为订单ID。
  • 账单类型为其它场景时此处为交易ID,为扣费维度的唯一标识。

    例如非月末扣费时为应收ID;月末扣费时为账单ID。

enterprise_project_id

String

最大长度:64

企业项目标识(企业项目ID)。

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

include_zero_record

Boolean

-

返回是否包含应付金额为0的记录。

  • true:包含
  • false:不包含

status

Integer

-

支付状态。

  • 1:已支付
  • 2:未结清
  • 3:未出账

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

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

limit

Integer

[1-1000]

页面大小。默认值为10。

请求消息

请求参数

请求示例

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&region_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 HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:16

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

error_msg

String

最大长度:1024

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

records

List<MonthlyBillRecord>

-

资源费用记录数据。

具体请参见表2

total_count

Integer

-

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

currency

String

最大长度:3

币种。

CNY:人民币

表2 MonthlyBillRecord

参数

参数类型

取值范围

描述

bill_cycle

String

最大长度:8

流水账单所在账期,格式为YYYY-MM。

customer_id

String

最大长度:64

消费的客户账号ID。

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

service_type_code

String

最大长度:64

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

resource_type_code

String

最大长度:64

资源类型编码,例如ECS的VM为“hws.resource.type.vm”。您可以调用查询资源类型列表接口获取。

region_code

String

最大长度:64

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

enterprise_project_id

String

-

企业项目标识(企业项目ID)。

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

enterprise_project_name

String

-

企业项目的名称。

charging_mode

Integer

-

计费模式。

  • 1:包年/包月
  • 3:按需
  • 10:预留实例

consume_time

String

最大长度:32

消费时间。

  • 计费模式为包年/包月和预留实例场景时为订单的支付时间。
  • 计费模式为按需场景时为话单的生/失效时间。

trade_time

String

最大长度:32

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

provider_type

Integer

-

服务商。

  • 1:华为云
  • 2:云市场

trade_id

String

最大长度:64

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

bill_type

Integer

-

账单类型。

  • 1:消费-新购
  • 2:消费-续订
  • 3:消费-变更
  • 4:退款-退订
  • 5:消费-使用
  • 8:消费-自动续订
  • 9:调账-补偿
  • 14:消费-服务支持计划月末扣费
  • 16:调账-扣费

status

Integer

-

支付状态。

  • 1:已支付
  • 2:未结清
  • 3:未结算

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

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

响应示例

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",
            "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": "华北-北京一"
        }
    ],
    "currency": "CNY"
}

状态码

HTTP状态码

错误码

错误描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

未知错误。

分享:

    相关文档

    相关产品