“提供按账号汇总的当月总费用；请于每月第2个自然日12点后获取上月完整账单数据；”

注意事项

查询QPS限制为5QPS，超过限流将报错；

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ListBillOverviewByCategory

要执行的操作，取值：ListBillOverviewByCategory。

Version string 必选示例值：2022-01-01

API的版本，取值：2022-01-01。

BillingMode string[] 可选示例值：[1]

计费模式：1：包年包月，代表预付费；2：按量计费，代表后付费；3：合同计费，代表线下计费；4：履约计费；默认不选为全部；

BillCategoryParent string[] 可选示例值：[consume]

账单大类类型：consume：消费；refund：退款；transfer：调账；默认不选为全部

PayerID long[] 可选示例值：[2100057673]

Payer账号ID

OwnerID long[] 可选示例值：[2100057673]

Owner账号ID；财务托管场景下，不指定owner时主账号可获取自身及其下绑定所有owner子账号费用；选择owner后，可精准获取指定owner的账单费用；

BillPeriod string 必选示例值：2023-03

账务账期：格式为YYYY-MM；仅支持单月查询；所查账期至多距今 24 个月

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

List object[] 示例值：-

账单总览-账号汇总总列表

List object[] 示例值：-

账单总览-账号汇总项

OwnerID string 示例值：2100057673

Owner账号ID

PayableAmount string 示例值：0.00

应付金额

UnpaidAmount string 示例值：0.00

欠费金额

OriginalBillAmount string 示例值：0.00

原价

DiscountBillAmount string 示例值：0.00

折后价

PaidAmount string 示例值：0.00

现金支付

CouponAmount string 示例值：0.00

代金券抵扣

PayerID string 示例值：2100057673

支付账号ID

SellerID string 示例值：3423

Seller账号ID

CreditCarriedAmount string 示例值：0.00

信控额度退款抵扣

OwnerUserName string 示例值：weitest009

Owner账号名

OwnerCustomerName string 示例值：俊杰1

Owner账号客户名称

SettlementType string 示例值：非结算

结算类型，settle：结算，non-settle：非结算，quota-settle：Quota结算

SubjectName string 示例值：北京火山引擎科技有限公司

主体名

Currency string 示例值：CNY

币种

PayerCustomerName string 示例值：俊杰1

支付账号客户名称

SellerUserName string 示例值：火山引擎

Seller账号名

SellerCustomerName string 示例值：北京火山引擎科技有限公司

Seller账号客户名称

BusinessMode string 示例值：财务托管

业务类型

BillPeriod string 示例值：2023-11

账期

BillCategoryParent string 示例值：消费

账单类型

PayerUserName string 示例值：weitest009

支付账号名

SubjectNo string 示例值：3423

主体编码

SettlePretaxRealValue string

结算币种税前真实金额

CountryArea string

国家地区

RealValue string

真实金额

SettleRealValue string

结算币种真实金额

PretaxRealValue string

税前真实金额

SettlePretaxAmount string

结算币种税前应付金额

PretaxAmount string

税前应付金额

SettlePosttaxAmount string

结算币种税后应付金额

CountryRegion string

国家区域

PosttaxAmount string

税后税额

Tax string

税额

SettleTax string

结算币种税额

SavingPlanOriginalAmount string 示例值：621.946905

节省计划抵扣原价

PreTaxPayableAmount string 示例值：0.00

税前应付金额（定价币种）

SettlePayableAmount string

税后应付金额（结算币种）

SettlePreTaxPayableAmount string 示例值：0.00

税前应付金额（结算币种）

CurrencySettlement string 示例值：CNY

结算币种

PointDeductAmount string

积分抵扣金额

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	RequestInvalid	RequestInvalid
400	MissingParameter	The required parameter BillPeriod is missing.
500	InternalError	Service has some internal Error. Pls Contact With Admin.	服务内部异常

费用中心