调用QueryBillOverview查询用户某个账期内账单总览信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryBillOverview

系统规定参数。取值:QueryBillOverview。

BillingCycle String 2018-07

账单日期,YYYY-MM。

ProductCode String rds

产品代码。

ProductType String rds

产品类型。

SubscriptionType String Subscription

订阅类型:

  • Subscription:预付费。
  • PayAsYouGo:后付费。
BillOwnerId Long 1234

子账号ID。设置可查看财务云子账号账单,不填默认查看当前调用账号。

返回数据

名称 类型 示例值 描述
Code String Success

状态码。

Data Struct

返回数据。

AccountID String 185766xxxx

账号ID。

AccountName String test@test.aliyunid.com

账号。

BillingCycle String 2020-03

账期,格式:YYYY-MM。

Items Array of Item

账单详情。

Item
AdjustAmount Float 0

信用额度退款抵扣。

AfterTaxAmount Float 0
BillAccountID String 185766xxxx

账单所属账号ID。

BillAccountName String test@test.aliyunid.com

账单所属账号名称。

BizType String trusteeship

业务类型。

CashAmount Float 0

现金支付(不包含信用额度退款抵扣)。

CommodityCode String rds

商品Code,与费用中心产品明细Code一致

Currency String CNY

币种,取值:

  • CNY。
  • USD。
  • JPY。
DeductedByCashCoupons Float 0

代金券抵扣。

DeductedByCoupons Float 0

优惠券抵扣。

DeductedByPrepaidCard Float 0

储值卡抵扣。

InvoiceDiscount Float 0

优惠金额。

Item String PayAsYouGoBill

账单类型,取值:

  • SubscriptionOrder。
  • PayAsYouGoBill。
  • Refund。
  • Adjustment。
OutstandingAmount Float 0

未结清金额或信用结算金额(普通用户的欠费, 或者信用客户信用额度消耗)。

OwnerID String 1222

账单OwnerID。

PaymentAmount Float 100

现金支付(含信用额度退款抵扣)。

PaymentCurrency String USD
PipCode String rds

产品Code,与费用中心账单产品Code一致

PretaxAmount Float 100

应付金额。

PretaxAmountLocal Float 0
PretaxGrossAmount Float 100

原始金额。

ProductCode String rds

产品代码。

ProductDetail String NAT Gateway (Pay-As-You-Go)

产品明细。

ProductName String Nat网关

产品名称。

ProductType String rds

产品类型。

RoundDownDiscount String 0

抹零优惠。

SubscriptionType String Subscription

订阅类型,取值:

  • Subscription:预付费。
  • PayAsYouGo:后付费。
Tax Float 0
Message String Successful!

错误信息。

RequestId String BCB1E1BC-05BF-4217-80EE-BF09A29407BA

请求ID。

Success Boolean true

是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=QueryBillOverview
&BillingCycle=2018-07
&<公共请求参数>

正常返回示例

XML格式

<RequestId>BCB1E1BC-05BF-4217-80EE-BF09A29407BA</RequestId>
<Message>Successful!</Message>
<Data>
    <BillingCycle>2020-03</BillingCycle>
    <AccountID>185766xxxx</AccountID>
    <AccountName>test@test.aliyunid.com</AccountName>
    <Items>
        <Item>
            <AfterTaxAmount>0</AfterTaxAmount>
            <ProductName>Nat网关</ProductName>
            <BillAccountID>185766xxxx</BillAccountID>
            <DeductedByCashCoupons>0</DeductedByCashCoupons>
            <PaymentCurrency>USD</PaymentCurrency>
            <Tax>0</Tax>
            <PaymentAmount>100</PaymentAmount>
            <DeductedByPrepaidCard>0</DeductedByPrepaidCard>
            <InvoiceDiscount>0</InvoiceDiscount>
            <SubscriptionType>Subscription</SubscriptionType>
            <Item>PayAsYouGoBill</Item>
            <PretaxGrossAmount>100</PretaxGrossAmount>
            <Currency>CNY</Currency>
            <CommodityCode>rds</CommodityCode>
            <AdjustAmount>0</AdjustAmount>
            <DeductedByCoupons>0</DeductedByCoupons>
            <RoundDownDiscount>0</RoundDownDiscount>
            <ProductDetail>NAT Gateway (Pay-As-You-Go)</ProductDetail>
            <ProductCode>rds</ProductCode>
            <ProductType>rds</ProductType>
            <OutstandingAmount>0</OutstandingAmount>
            <BizType>trusteeship</BizType>
            <PipCode>rds</PipCode>
            <OwnerID>1222</OwnerID>
            <PretaxAmount>100</PretaxAmount>
            <BillAccountName>test@test.aliyunid.com</BillAccountName>
            <CashAmount>0</CashAmount>
            <PretaxAmountLocal>0</PretaxAmountLocal>
        </Item>
    </Items>
</Data>
<Code>Success</Code>
<Success>true</Success>

JSON格式

{
    "RequestId": "BCB1E1BC-05BF-4217-80EE-BF09A29407BA",
    "Message": "Successful!",
    "Data": {
        "BillingCycle": "2020-03",
        "AccountID": "185766xxxx",
        "AccountName": "test@test.aliyunid.com",
        "Items": {
            "Item": {
                "AfterTaxAmount": 0,
                "ProductName": "Nat网关",
                "BillAccountID": "185766xxxx",
                "DeductedByCashCoupons": 0,
                "PaymentCurrency": "USD",
                "Tax": 0,
                "PaymentAmount": 100,
                "DeductedByPrepaidCard": 0,
                "InvoiceDiscount": 0,
                "SubscriptionType": "Subscription",
                "Item": "PayAsYouGoBill",
                "PretaxGrossAmount": 100,
                "Currency": "CNY",
                "CommodityCode": "rds",
                "AdjustAmount": 0,
                "DeductedByCoupons": 0,
                "RoundDownDiscount": 0,
                "ProductDetail": "NAT Gateway (Pay-As-You-Go)",
                "ProductCode": "rds",
                "ProductType": "rds",
                "OutstandingAmount": 0,
                "BizType": "trusteeship",
                "PipCode": "rds",
                "OwnerID": 1222,
                "PretaxAmount": 100,
                "BillAccountName": "test@test.aliyunid.com",
                "CashAmount": 0,
                "PretaxAmountLocal": 0
            }
        }
    },
    "Code": "Success",
    "Success": true
}

错误码

访问错误中心查看更多错误码。