OMS 对外开放接口说明

OMS 对外开放接口说明


客户获取账单

<h5>简要描述</h5> <ul> <li>分页获取登录客户账单数据接口</li> </ul> <h5>请求URL</h5> <ul> <li><code>/v1/expenseSettle/pageList</code> </li> </ul> <h5>请求方式</h5> <ul> <li>post</li> </ul> <h5>请求参数示例</h5> <pre><code>{ "businessType": "WH", "categoryCode": "STDENTRYFEE", "startTime": "2022-08-11", "endTime": "2023-08-11", "pageNum": 1, "pageSize": 10, "relationNo": "string", "status": 10, "warehouseIdCodes": [ "string" ] } </code></pre> <h5>json字段说明</h5> <table> <thead> <tr> <th style="text-align: left;">字段名</th> <th style="text-align: left;">必选</th> <th>类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">businessType</td> <td style="text-align: left;">否</td> <td>string</td> <td>业务类型;ASN入库SO出库RT退件CO认领MC手工应收WH仓租</td> </tr> <tr> <td style="text-align: left;">categoryCode</td> <td style="text-align: left;">否</td> <td>string</td> <td>费用类目编码,通过费用类目接口获取</td> </tr> <tr> <td style="text-align: left;">startTime</td> <td style="text-align: left;">是</td> <td>string</td> <td>结算起始日期格式年月日,如:2023-08-11</td> </tr> <tr> <td style="text-align: left;">endTime</td> <td style="text-align: left;">是</td> <td>string</td> <td>结算结束日期格式年月日,如:2023-08-11 查当天</td> </tr> <tr> <td style="text-align: left;">pageNum</td> <td style="text-align: left;">是</td> <td>int</td> <td>起始页</td> </tr> <tr> <td style="text-align: left;">pageSize</td> <td style="text-align: left;">是</td> <td>int</td> <td>每页显示记录数,1-50,大于50按50</td> </tr> <tr> <td style="text-align: left;">relationNo</td> <td style="text-align: left;">否</td> <td>string</td> <td>业务单号</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">否</td> <td>string</td> <td>账单状态:10待确认20待核销30已核销</td> </tr> <tr> <td style="text-align: left;">warehouseIdCodes</td> <td style="text-align: left;">是</td> <td>array</td> <td>仓库编码一次仅查一个仓 [&quot;FRWAREHOUSE&quot;]</td> </tr> </tbody> </table> <h5>成功返回示例</h5> <pre><code>{ "total": 1, "rows": [ { "expenseCategoryCode": "STDRETURNORDERFEE", "expenseCategoryName": "退件费用", "businessType": "RT", "businessTypeStr": "退件", "relationNo": "RMA202205170004", "customerRelationNo": "RT202205170004-XOD", "status": 10, "warehouseName": null, "settleType": 2, "settleAmount": 10, "currencyCode": "GBP", "additionalAmount": null, "settleTime": "2022-05-17", "expenseSettleCode": null, "remark": null, "username": null, "detailVOs": [ { "expenseItemName": "物流退件费", "settleAmount": 1, "currencyCode": "GBP", "additionalAmount": null, "settleTotal": 1, "remark": null } ] } ], "code": 200, "msg": null } </code></pre> <h5>成功返回示例的参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">total</td> <td style="text-align: left;">string</td> <td>总条数</td> </tr> <tr> <td style="text-align: left;">rows</td> <td style="text-align: left;">array</td> <td>数据集合</td> </tr> <tr> <td style="text-align: left;">expenseCategoryCode</td> <td style="text-align: left;">string</td> <td>费用分类编码</td> </tr> <tr> <td style="text-align: left;">expenseCategoryName</td> <td style="text-align: left;">string</td> <td>费用分类名称</td> </tr> <tr> <td style="text-align: left;">businessType</td> <td style="text-align: left;">string</td> <td>业务类型;ASN入库SO出库RT退件MC手工应收WH仓租</td> </tr> <tr> <td style="text-align: left;">businessTypeStr</td> <td style="text-align: left;">string</td> <td>业务类型</td> </tr> <tr> <td style="text-align: left;">relationNo</td> <td style="text-align: left;">string</td> <td>关联业务单据;如入库单号,出库批次号,手工应收单据号等</td> </tr> <tr> <td style="text-align: left;">customerRelationNo</td> <td style="text-align: left;">string</td> <td>关联客户单据编码</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">string</td> <td>状态;10待确认20待核销30已核销</td> </tr> <tr> <td style="text-align: left;">warehouseName</td> <td style="text-align: left;">object</td> <td>仓库名称</td> </tr> <tr> <td style="text-align: left;">settleType</td> <td style="text-align: left;">string</td> <td>1预付2日结3月结</td> </tr> <tr> <td style="text-align: left;">settleAmount</td> <td style="text-align: left;">string</td> <td>结算金额</td> </tr> <tr> <td style="text-align: left;">currencyCode</td> <td style="text-align: left;">string</td> <td>币种代码</td> </tr> <tr> <td style="text-align: left;">additionalAmount</td> <td style="text-align: left;">object</td> <td>附加金额</td> </tr> <tr> <td style="text-align: left;">settleTime</td> <td style="text-align: left;">string</td> <td>结算时间</td> </tr> <tr> <td style="text-align: left;">expenseSettleCode</td> <td style="text-align: left;">string</td> <td>结算单号</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">string</td> <td>备注</td> </tr> <tr> <td style="text-align: left;">username</td> <td style="text-align: left;">string</td> <td>客户名</td> </tr> <tr> <td style="text-align: left;">detailVOs</td> <td style="text-align: left;">array</td> <td>结算明细</td> </tr> <tr> <td style="text-align: left;">detailVOs.expenseItemName</td> <td style="text-align: left;">string</td> <td>费用项目</td> </tr> <tr> <td style="text-align: left;">detailVOs.settleAmount</td> <td style="text-align: left;">string</td> <td>结算金额</td> </tr> <tr> <td style="text-align: left;">detailVOs.currencyCode</td> <td style="text-align: left;">string</td> <td>币种代码</td> </tr> <tr> <td style="text-align: left;">detailVOs.additionalAmount</td> <td style="text-align: left;">object</td> <td>附加金额</td> </tr> <tr> <td style="text-align: left;">detailVOs.settleTotal</td> <td style="text-align: left;">string</td> <td>结算总量</td> </tr> <tr> <td style="text-align: left;">detailVOs.remark</td> <td style="text-align: left;">object</td> <td>备注</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">string</td> <td>无</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">object</td> <td>无</td> </tr> </tbody> </table> <h5>失败返回示例</h5> <pre><code>{ "errcode": "000000", "msg": "系统内部错误", "code": 500 } </code></pre> <h5>失败返回示例的参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">errcode</td> <td style="text-align: left;">string</td> <td>无</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">string</td> <td>无</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">string</td> <td>无</td> </tr> </tbody> </table>

页面列表

ITEM_HTML