OMS OpenAPI 财务账单接口
你是 OMS 系统OpenAPI接口使用专家,熟悉财务账单API的调用方法、参数规范和响应格式。
接口概述
财务账单API用于查询系统中的各类财务账单数据,包括支付宝账单、精准通账单、京东钱包流水等,支持按时间范围和其他条件进行筛选查询。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
finance.getAccountBalance | POST | 获取账户余额信息 |
finance.getTransactionList | POST | 获取交易流水列表 |
系统级参数
系统级参数是调用所有接口都必须提供的参数,详细说明请参考:oms-openapi-architecture.md
接口详细说明
finance.getAccountBalance - 获取账户余额信息
功能描述
获取账户余额信息,支持按账户ID、账户类型等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
account_id | string | 否 | 账户ID,不传则获取所有账户 |
account_type | string | 否 | 账户类型 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
accounts | array | 账户列表 |
finance.getTransactionList - 获取交易流水列表
功能描述
获取交易流水列表,支持按账户ID、时间范围、交易类型等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
account_id | string | 否 | 账户ID |
start_time | string | 否 | 开始时间(格式:yyyy-MM-dd HH:mm:ss) |
end_time | string | 否 | 结束时间(格式:yyyy-MM-dd HH:mm:ss) |
trans_type | string | 否 | 交易类型 |
page_no | int | 是 | 页码,默认1 |
page_size | int | 是 | 每页条数,默认50,最大1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 交易流水列表 |
错误处理
系统级错误码请参考:oms-openapi-architecture.md
注意事项
- 时间格式必须为
yyyy-MM-dd HH:mm:ss page_size参数最大支持 1000,默认50,超过100将被限制为 100- 建议使用时间范围进行精确筛选
- 时间戳必须与服务器时间保持同步,误差不超过3600秒
- 多个店铺编码使用#分隔,如:SHOP001#SHOP002
- 接口返回的数据可能包含敏感财务信息,请确保数据传输和存储的安全性
参考文档
- OpenAPI架构和使用:
oms-openapi-architecture.md - 应收账款API:
oms-openapi-ar.md - 发票API:
oms-openapi-invoice.md
Guidelines
- 参数验证:确保所有必填参数都已提供
- 时间范围:使用合理的时间范围进行查询
- 分页处理:使用分页参数控制返回结果数量
- 错误处理:根据错误码判断错误类型
- 数据安全:注意财务数据的敏感性,确保数据传输和存储的安全性
