获取收支明细列表
接口描述
GET /v1/incomeStatements
获取收支明细列表
请求头(Request Header)
请求参数(Request Parameters)
| 名称 | 位置 | 类型 | 必须 | 描述 |
|---|---|---|---|---|
| filter | query | string | false | 筛选条件 支持计费账号、流水编号、订单/账单号,如:billing_account_id= xxx AND id = yyy AND order_bill_id= zzz |
| order_by | query | string | false | 排序 |
| page_size | query | integer(int32) | false | 分页大小 |
| page_token | query | string | false | 分页 |
请求体(Request Body)
无
请求示例(Request Example)
curl --request GET \
--url https://finance.sensecoreapi.dev/boss/account/v1/incomeStatements \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}'
响应参数(Response Parameters)
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | ListIncomeStatementsResponse |
响应示例(Response Example)
200 Response
{
"income_statements": [
{
"id": "string",
"trade_time": "2019-08-24T14:15:22Z",
"trade_type": "RECHARGE",
"trade_channel": "BALANCE",
"trade_channel_id": "string",
"order_bill_id": "string",
"adjust_amount": 0,
"balance": 0,
"comment": "string",
"trade_direction": "TD_IN",
"billing_account_id": "string",
"billing_account_display_name": "string"
}
],
"next_page_token": "string",
"total_size": 0,
"page_number": 0,
"page_size": 0
}
数据结构(Schemas)
IncomeStatement
| 名称 | 类型 | 必须 | 限制 | 描述 |
|---|---|---|---|---|
| id | string | false | none | 流水编号 |
| trade_time | string(date-time) | false | none | 交易时间 |
| trade_type | string(enum) | false | none | 交易类型 |
| trade_channel | string(enum) | false | none | 交易渠道 |
| trade_channel_id | string | false | none | 渠道流水号 |
| order_bill_id | string | false | none | 订单号/账单号 |
| adjust_amount | number(double) | false | none | 变动金额 |
| balance | number(double) | false | none | 账户余额 |
| comment | string | false | none | 备注 |
| trade_direction | string(enum) | false | none | 收支类型 TD_IN: 收入, TD_OUT: 支出 |
| billing_account_id | string | false | none | 计费账户ID |
| billing_account_display_name | string | false | none | 计费账户名称 |
trade_type Enumerated Values
| 枚举值 |
|---|
| RECHARGE |
| CONSUMPTION |
| REFUND |
| ADJUST |
| WITHDRAW |
| BALANCE |
| OFFLINE_REMITTANCE |
| THIRD_PARTY_ACCOUNT |
| TD_IN |
| TD_OUT |
ListIncomeStatementsResponse
| 名称 | 类型 | 必须 | 限制 | 描述 |
|---|---|---|---|---|
| income_statements | [IncomeStatement] | false | none | 收支明细记录 |
| next_page_token | string | false | none | 下一页 more results in the list |
| total_size | integer(int32) | false | none | 总页数 |
| page_number | integer(int32) | false | none | 页码 |
| page_size | integer(int32) | false | none | 分页大小 |