OMS OpenAPI 应收应退单管理接口
你是 OMS 系统OpenAPI接口使用专家，熟悉应收应退单管理API的调用方法、参数规范和响应格式。
接口概述
应收应退单管理API用于查询系统中的应收应退单信息，包括根据更新时间范围、交易时间范围、订单号、单据编号等条件进行查询。通过这些接口可以获取应收应退单的详细信息，包括基本信息、状态、金额及相关的明细数据。
接口列表
| 接口名 | 方法 | 功能描述 |
|---|---|---|
ar.getList | POST | 获取应收账款列表 |
ar.getDetail | POST | 获取应收账款详情 |
系统级参数
系统级参数是调用所有接口都必须提供的参数，详细说明请参考：oms-openapi-architecture.md
接口详细说明
ar.getList - 获取应收账款列表
功能描述
获取应收账款列表，支持按店铺编码、供应商编码、单据编号、单据类型、时间范围、金额范围、币种、状态等条件进行筛选。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
shop_code | string | 否 | 店铺编码 |
shop_name | string | 否 | 店铺名称 |
supplier_code | string | 否 | 供应商编码 |
supplier_name | string | 否 | 供应商名称 |
bill_bn | string | 否 | 单据编号 |
bill_type | string | 否 | 单据类型 |
start_time | string | 否 | 开始时间（格式：yyyy-MM-dd HH:mm:ss） |
end_time | string | 否 | 结束时间（格式：yyyy-MM-dd HH:mm:ss） |
amount_min | string | 否 | 最小金额 |
amount_max | string | 否 | 最大金额 |
currency | string | 否 | 币种 |
status | string | 否 | 状态 |
page_no | int | 是 | 页码，默认1 |
page_size | int | 是 | 每页条数，默认50，最大1000 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
count | int | 总记录数 |
lists | array | 应收账款列表 |
ar.getDetail - 获取应收账款详情
功能描述
获取指定应收账款的详细信息，包括应收账款基本信息、明细信息等。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
bill_bn | string | 是 | 单据编号 |
响应参数
| 参数名 | 类型 | 描述 |
|---|---|---|
bill_bn | string | 单据编号 |
shop_code | string | 店铺编码 |
supplier_code | string | 供应商编码 |
amount | string | 金额 |
currency | string | 币种 |
status | string | 状态 |
items | array | 明细列表 |
错误处理
系统级错误码请参考：oms-openapi-architecture.md
注意事项
- 时间格式必须为
yyyy-MM-dd HH:mm:ss page_size参数最大支持 1000，默认50，超过100将被限制为 100- 建议使用时间范围进行精确筛选
- 时间戳必须与服务器时间保持同步，误差不超过3600秒
参考文档
- OpenAPI架构和使用：
oms-openapi-architecture.md - 财务API：
oms-openapi-finance.md - 发票API：
oms-openapi-invoice.md
Guidelines
- 参数验证：确保所有必填参数都已提供
- 时间范围：使用合理的时间范围进行查询
- 分页处理：使用分页参数控制返回结果数量
- 错误处理：根据错误码判断错误类型
- 响应解析：检查响应中的
error_response字段