You need to enable JavaScript to run this app.
导航

ListSplitBillDetail - 分页查询分账账单

最近更新时间2024.04.02 20:05:34

首次发布时间2023.12.06 17:34:36

分页查询分账账单

调试

请求参数

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

注意

为了提升查询效率和成功率,您可使用账单日期"ExpenseDate"指定获取某日数据、或使用统计周期"GroupPeriod"获取按日/按月聚合口径数据;

参数
类型
是否必填
示例值
描述
Action
String

ListSplitBillDetail

要执行的操作,取值:ListSplitBillDetail

Version
String

2022-01-01

API的版本,取值:2022-01-01

Product
Array of String

[ECS]

产品名称,默认不选为全部

BillingMode
Array of String

[1]

计费模式:1:包年包月;2:按量计费;3:合同计费;4:履约计费;默认不选为全部

BillCategory
Array of String

[consume-use]

账单类型:consume-use:消费-使用;consume-new:消费-新购;consume-renew:消费-续费;consume-formalize:消费-转正;consume-modify:消费-更配;consume-trial:消费-试用;refund-terminate:退款-退订;refund-modify:退款-更配;transfer-manual:调账-人工;transfer-system:调账-系统;默认不选为全部

ExpenseDate
String

2023-08-15

账单日期,在GroupPeriod=1时支持账单日期传参,必须与账期在同一月份

Offset
Integer

10

偏移量

Limit
Integer

10

数量:[1-300]

BillPeriod
String

2023-08

账期:格式为YYYY-MM;仅支持单月查询;最多24个月;最早只能查询2022-01(新版账单的时间);

GroupPeriod
Integer

0

统计周期:0:账期;1:按天;2:明细;

InstanceNo
String

i-ycjlq77tdg8rx6ib4v1s

实例ID

SplitItemID
String

split-test1

分拆项ID

IgnoreZero
Integer

1

是否忽略折后价为0的数据:0:不忽略;1忽略;默认为不忽略;

NeedRecordNum
Integer

1

是否需要访问列表的总记录数:用于前端分页;1:表示需要; 0:表示不需要;默认为不需要

返回参数

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

参数
类型
示例值
描述
List
Array of SplitBill

分账账单列表

Total
Integer

100

总数

Limit
Integer

100

步长

Offset
Integer

0

偏移量

请求示例

curl --location --request POST 'https://open.volcengineapi.com?Action= ListSplitBillDetail&Version=2022-01-01' \
--header 'AccessKey: AKLTZm*****' \
--header 'SecretKey: T1RVek*****' \
--header 'Region: cn-north-1' \
--header 'ServiceName: billing'
--header 'Content-Type: application/json' \
--data-raw '{
    "BillPeriod":"2023-11",
    "Limit":1,
    "Offset":1,
    "GroupTerm":1,
    "GroupPeiod":1
}'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231205175018EE56242994CA47D2031D",
        "Action": "ListSplitBillDetail",
        "Version": "2022-01-01",
        "Service": "billing",
        "Region":"cn-north-1"
    },
    "Result": {
        "List": [
            {
                "BillPeriod": "2023-11",
                "ExpenseTime": "-",
                "PayerUserName": "antao",
                "SellerUserName": "万有在线",
                "OwnerUserName": "antao",
                "Product": "renxiao_product",
                "ProductZh": "renxiao_product",
                "BusinessMode": "普通业务",
                "BillingMode": "包年包月",
                "UseDuration": "2",
                "UseDurationUnit": "月",
                "TradeTime": "-",
                "BillID": "-",
                "BillCategory": "消费-新购",
                "SettlementType": "-",
                "InstanceNo": "Renxiao_product7301236330060402988",
                "InstanceName": "-",
                "ConfigName": "-",
                "Element": "fanweizhi",
                "Region": "不限",
                "Zone": "-",
                "Factor": "-",
                "ExpandField": "-",
                "SplitItemID": "-",
                "SplitItemName": "-",
                "Price": "1000000.000000",
                "PriceUnit": "颗",
                "SplitItemAmount": "1",
                "Unit": "颗",
                "SplitItemRatio": "-",
                "DeductionCount": "0",
                "SolutionZh": "-",
                "OriginalBillAmount": "2000000.0000000000",
                "PreferentialBillAmount": "0.0000000000",
                "DiscountBillAmount": "2000000.00",
                "CouponDeductionAmount": "0.00",
                "PayableAmount": "2000000.00",
                "PaidAmount": "2000000.00",
                "UnpaidAmount": "0.00",
                "Currency": "CNY",
                "Project": "-",
                "Tag": "-",
                "SellingMode": "0",
                "SubjectName": "北京火山万有在线科技有限公司",
                "ReservationInstance": "0",
                "SplitBillDetailId": "-",
                "ElementCode": "BE007530",
                "RegionCode": "-",
                "ZoneCode": "-",
                "FactorCode": "-",
                "ConfigurationCode": "-",
                "CreditCarriedAmount": "0.00",
                "BillingFunction": "固定单价",
                "MarketPrice": "",
                "DiscountBizBillingFunction": "单一折扣",
                "DiscountBizUnitPrice": "0.16",
                "DiscountBizUnitPriceInterval": "-",
                "DiscountBizMeasureInterval": "-",
                "EffectiveFactor": "1",
                "PriceInterval": "-",
                "MeasureInterval": "-",
                "BillingMethodCode": "按加和量小时结",
                "ProjectDisplayName": "默认项目"
            }
        ],
        "Total": -1,
        "Limit": 1,
        "Offset": 1
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。