计费相关获取收支明细列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： billing.tencentcloudapi.com 。

获取收支明细列表，支持翻页和参数过滤

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBillList。
Version	是	String	公共参数，本接口取值：2018-07-09。
Region	否	String	公共参数，此参数为可选参数。
StartTime	是	String	查询范围的起始时间（包含）时间格式 yyyy-MM-dd HH:mm:ss 开始时间和结束时间差值小于等于六个月示例值：2020-01-01 00:00:00
EndTime	是	String	查询范围的结束时间（包含）时间格式 yyyy-MM-dd HH:mm:ss ，开始时间和结束时间差值小于等于六个月示例值：2020-01-02 00:00:00
Offset	是	Integer	翻页偏移量，初始值为0 示例值：1
Limit	是	Integer	每页的限制数量示例值：1
PayType.N	否	Array of String	交易类型： all所有交易类型，recharge充值，return退款，unblock解冻，agentin资金转入，advanced垫付，cash提现，deduct扣费，block冻结，agentout资金转出，repay垫付回款，repayment还款(仅国际信用账户)，adj_refund调增(仅国际信用账户)，adj_deduct调减(仅国际信用账户) 示例值：['deduct']
SubPayType.N	否	Array of String	扣费模式，当所选的交易类型为扣费deduct时： all所有扣费类型;trade预付费支付;hour_h按量小时结;hour_d按量日结;hour_m按量月结;decompensate调账扣费;other第三方扣费;panshi 线下项目扣费;offline 线下产品扣费; 当所选的交易类型为扣费recharge时： online 在线充值;bank-enterprice 银企直连;offline 线下充值;transfer 分成充值当所选的交易类型为扣费cash时： online 线上提现;offline 线下提现;panshi 赠送金清零当所选的交易类型为扣费advanced时： advanced 垫付充值当所选的交易类型为扣费repay时： panshi 垫付回款当所选的交易类型为扣费block时： other 第三方冻结;hour 按量冻结;month按月冻结当所选的交易类型为扣费return时： compensate 调账补偿;trade 预付费退款当所选的交易类型为扣费unblock时： other 第三方解冻;hour 按量解冻;month 按月解冻示例值：all
WithZeroAmount	否	Integer	是否返回0元交易金额的交易项，取值：0-不返回，1-返回。不传该参数则不返回示例值：1

3. 输出参数

参数名称	类型	描述
TransactionList	Array of BillTransactionInfo	收支明细列表示例值：[]
Total	Integer	总条数示例值：1
ReturnAmount	Float	退费总额，单位（分）示例值：1
RechargeAmount	Float	充值总额，单位（分）示例值：1
BlockAmount	Float	冻结总额，单位（分）示例值：1
UnblockAmount	Float	解冻总额，单位（分）示例值：1
DeductAmount	Float	扣费总额，单位（分）示例值：1
AgentInAmount	Float	资金转入总额，单位（分）示例值：1
AdvanceRechargeAmount	Float	垫付充值总额，单位（分）示例值：1
WithdrawAmount	Float	提现扣减总额，单位（分）示例值：1
AgentOutAmount	Float	资金转出总额，单位（分）示例值：1
AdvancePayAmount	Float	还垫付总额，单位（分）示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询账户收支明细

查询账户收支明细

输入示例

POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillList
<公共请求参数>

{
    "WithZeroAmount": 1,
    "PayType": [
        "all"
    ],
    "SubPayType": [
        "all"
    ],
    "Limit": 1,
    "StartTime": "2019-07-31 00:00:00",
    "Offset": 0,
    "EndTime": "2020-07-31 00:00:00"
}

输出示例

{
    "Response": {
        "Total": 39,
        "ReturnAmount": 9667,
        "DeductAmount": 7057155,
        "RechargeAmount": 2247483647,
        "BlockAmount": 5130854,
        "UnblockAmount": 10000,
        "AgentInAmount": 10000,
        "AdvanceRechargeAmount": 10000,
        "WithdrawAmount": 10000,
        "AgentOutAmount": 10000,
        "AdvancePayAmount": 10000,
        "TransactionList": [
            {
                "OperationTime": "2020-07-08 15:52:30.941",
                "ActionType": "deduct",
                "PayChannel": "用户余额",
                "OperationInfo": "OCR文字识别-广州-07月按月结算扣费",
                "Amount": -45,
                "Balance": 1951932174,
                "BillId": "20200708000000005009170242661921",
                "Cash": 1957274510,
                "Incentive": 0,
                "Freezing": 5342336,
                "DeductMode": "trade"
            }
        ],
        "RequestId": "d40b48bf-6755-4128-910b-b54f8b9df6c3"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.GatewayError	网关错误。
InvalidParameter	参数错误。
UnauthorizedOperation.CamNoAuth	账号没有cam授权。

获取收支明细列表

本页目录：