当前位置: API文档
接口说明
获取账期内的调整单汇总信息,取值于对账单据明细表。
该接口是线下接口,不走奇门。
调用场景
财务软件对接生成应收单。
请求参数说明
请求地址
环境 | 线下直接访问地址 |
测试环境 | https://hjy-openapi-test.jst.huice.cn/v2/offline/summary/periodAdjustSummary |
正式环境 | https://hjy.huice.com/openapi/v2/offline/summary/periodAdjustSummary |
请求方式: POST
公共请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
hjySign | String | 必选 | 344 | 签名 | ERITJKEIJKJHKKKKK |
appId | String | 必选 | -- | 租户应用标号 | |
sid | String | 必选 | -- | 卖家账号 | recon10 |
nextRequestId | String | 否 | 默认一页1000条。每次查询返回一个值,客户需要用这个值再查,如果返回 false 说明查询结束。 |
业务请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
periodMark | Number | 否 | 三个参数都不填默认按periodMark = 1 返回数据。账期查询只能单账期查询,不允许跨多个账期查询 | 对账标识,与对账周期时间不能同时为空 | 1代表最后一个已结账对账周期,最大为3 |
startDate | String | 否 | 账期开始日期,需要与账期结束日期一起传 | 2023-03-21 | |
endDate | String | 否 | 账期结束日期,需要与账期开始日期一起传 | 2023-03-21 | |
refundType | String[] | 否 | 退款类型,可以批量 | 退货退款,退款不退货 | |
specNo | String[] | 否 | 商家编码,可以批量 | [A0001] | |
shopNo | String[] | 否 | 店铺编码,可以批量 | ["Db001"] | |
recoStatus | String | 否 | 对账状态 | 对账成功,对账失败 | |
adjustType | String[] | 否 | 调整单类型,可以批量 | 负应收单,正应收单 |
响应数据
公共响应数据
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
resultCode | String | 是 | 业务响应码 | ||
message | String | 是 | 业务响应码描述 | ||
sub_resultCode | String | 是 | 二级响应码 | ||
sub_detail | String | 是 | 二级响应码描述 | ||
solution | String | 是 | 解决方案 | ||
nextRequestId | String | 否 | 默认一页1000条。每次查询返回一个值,客户需要用这个值再查,如果返回 false 说明查询结束。 | ||
data | Object | 是 | 返回结果数据 |
业务响应数据:data
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
shopNo | String | 1 | 店铺编码 | Db001 | |
summaryNo | String | 1 | 汇总单号,唯一编码 | HZBH0001 | |
shopName | String | 1 | 店铺名称 | 第一个店铺 | |
startDate | String | 1 | 账期开始时间 | 2023-10-10 | |
endDate | String | 1 | 账期结束时间 | 2023-10-31 | |
recoStatus | String | 1 | 对账状态 | 对账成功,对账失败 | |
specNo | String | 1 | 商家编码 | A0001 | |
goodName | String | 0 | 货品名称 | 这是个好东西 | |
adjustType | String | 1 | 调整单类型 | 负应收单,正应收单 | |
refundType | String | 0 | 退款类型 | 退货退款,退款不退货 |