API文档

finance.settle.PurchaseReturn.search(采购退货结算单查询)

¥标准

1.接口说明

1.1 接口描述：采购结算单查询

1.2 适用版本：V1.6.1.8及以上

1.3 注意事项：【权限校验】：仓库权限

2.调用场景

2.1 举例说明：

3.请求参数说明

3.1 请求地址

环境	HTTP地址
测试环境	http://47.92.239.46/openapi
正式环境	http://wdt.wangdian.cn/openapi

3.2 公共请求参数

名称	字段	类型	必须	描述
卖家账号	sid	String	是	卖家账号, 由旺店通分配
接口账号	key	String	是	由旺店通分配appkey, 在发送的数据中对应 key 字段
盐	salt	String	是	由旺店通分配appsecret，是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt.
接口名称	method	String	是	调用的接口名称
版本号	v	String	是	1.0
秒级时间戳	timestamp	Int	是	秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名	sign	String	是	签名
分页大小	page_size	Int	否	分页大小，分页查询必传
分页编号	page_no	Int	否	分页编号，分页查询必传，标准接口page_no从0开始
是否计算查询结果的总条数	calc_total	Int	否	是否计算查询结果的总条数, 需要计算则1, 否则填0

3.3 业务请求参数

名称	字段	类型	长度	是否必须	描述
业务请求参数	params	Map<String, Object>		Y	业务请求参数
分页	pager	Map<String, Object>		Y	分页参数

params

名称	字段	类型	长度	是否必须	描述
结算单号	settle_no	String	40	N	结算单号，精确查询 (可不传时间条件)
退货单号	return_no	String	25	N	采购退货单号，精确查询 (可不传时间条件)
供应商	provider_no	String	40	N	供应商编码
结算状态	status	String	4	N	可传多个状态分割符 : , (英文)10 : 编辑中20 : 待审核30 : 已审核40 : 已取消
起始时间	start_time	String	19	Y	创建时间起始值，格式：yyyy-MM-dd HH:mm:ss
结束时间	end_time	String	19	Y	创建时间结束值，格式：yyyy-MM-dd HH:mm:ss

pager

名称	字段	类型	长度	是否必须	描述
分页大小	page_size	int		Y	分页大小, 最大2000
分页序号	page_no	int		Y	从0开始

4.响应参数

名称	字段	类型	是否必须	描述
状态码	status	int	Y	返回0为正常
错误信息	message	String	Y	无错误信息不返回
响应正文数据	data	Map<String, Object>	Y	响应正文数据

data

名称	字段	类型	长度	是否必须	描述
总条数	total_count	int		Y	结果总条数
单据数据	order	List<Map<String,Object>>		Y

order

名称	字段	类型	长度	是否必须	描述
结算单号	settle_no	String	40	Y	结算单号
状态	status	int	4	Y	结算状态10 : 编辑中20 : 待审核30 : 已审核40 : 已取消
供应商名称	provider_name	String	64	Y	供应商名称
供应商编号	provider_no	String	40	Y	供应商编号
退货单号	return_no	String	255	Y	采购退货单号（可以多个）
物流公司	logistics_name	String	40	Y	物流公司名称
物流单号	logistics_no_list	String	100	Y	物流单号，多个单号按系统原始格式返回
运费	post_fee	BigDecimal	19,4	Y	运费
货款	goods_amount	BigDecimal	19,4	Y	未税货款
税后货款	tax_amount	BigDecimal	19,4	Y	税后货款
发票类型	invoice_type	int	4	Y	0 : 无1 : 电子普通发票2 : 增值税普通发票3 : 电子增值税专用发票4 : 纸质普通发票5 : 纸质增值税专用发票6 : 数电票增值税普通发票7 : 数电票增值税专用发票
货品总数	goods_count	BigDecimal	19,4	Y	货品总数量
结算员	settler_name	String	50	Y	结算人员名称
审核员	checker_name	String	50	Y	审核人员名称
备注	remark	String	255	Y	结算单备注
建单时间	created	String	19	Y	格式：yyyy-MM-dd HH:mm:ss
审核时间	check_time	String	19	Y	格式：yyyy-MM-dd HH:mm:ss，未审核时为空
明细	detail_list	List<Map<String,Object>>	-	Y	结算单明细列表

detail_list

名称	字段	类型	长度	是否必须	描述
单品ID	spec_id	int	11	Y	唯一键
采购退货单号	return_no	String	25	Y	采购退货单号（单个）
采购单号	purchase_no	String	1024	Y	关联采购单号，多个采购单号拼接返回
商家编码	spec_no	String	80	Y	商品规格商家编码
残品	defect	boolean		Y	数据库原始值：0/false 正品，1/true 残品
货品名称	goods_name	String	255	Y	货品名称
货品编号	goods_no	String	40	Y	货品编号
货品简称	short_name	String	255	Y	货品简称
规格名称	spec_name	String	255	Y	规格名称
规格码	spec_code	String	40	Y	规格码
条码	barcode	String	50	Y	条码
供应商货号	provider_goods_no	String	64	Y	供应商货号
单位	base_unit_name	String	20	Y	基本单位名称
辅助单位	aux_unit_name	String	20	Y	辅助单位名称
换算系数	unit_ratio	BigDecimal	19,4	Y	基本单位与辅助单位换算系数
结算数量	settle_num	BigDecimal	19,4	Y	结算数量
单价	price	BigDecimal	19,4	Y	未税单价
税率	tax_rate	BigDecimal	19,4	Y	税率
税后单价	tax_price	BigDecimal	19,4	Y	税后单价
总货款	total_amount	BigDecimal	19,4	Y	未税总货款
税后总货款	tax_amount	BigDecimal	19,4	Y	税后总货款
备注	remark	String	255	Y	明细备注
时间	created	String	19	Y	格式：yyyy-MM-dd HH:mm:ss
批次	batch_no	String	50	Y	批次号
有效期	expire_date	String	10	Y	格式：yyyy-MM-dd，无有效期时为空
仓库	warehouse_name	String	64	Y	仓库名称

5.请求示例

Json	[ { "settle_no" : "JS202510280003" } ]
PHP
JAVA
C#
CURL	curl --location 'http://47.92.239.46/openapi?key=wdtapi3-test9&method=finance.settle.PurchaseReturn.search&salt=136787110023126585465b366becff09&sid=wdtapi3&timestamp=461091623&v=1.0&sign=152aa482e3c0d92779b184a4eb12b0be&page_no=0&page_size=100&calc_total=1' \ --header 'Content-Type: application/json' \ --data '[ { "settle_no" : "JS202510280003" } ]'

6.响应示例

6.1 正常响应示例

JSON

{
    "data": {
        "total_count": 1,
        "order": [
            {
                "settle_no": "JS202510280003",
                "status": 10,
                "logistics_name": "",
                "logistics_no_list": "",
                "invoice_type": 0,
                "remark": "",
                "return_no": "CR202510270003,CR202510240002,CR202510240005",
                "provider_name": "示例供应商有限公司",
                "provider_no": "SUP20230001",
                "settler_name": "系统",
                "checker_name": "系统",
                "post_fee": "0.0000",
                "goods_amount": "44.0000",
                "tax_amount": "44.0000",
                "goods_count": "13.0000",
                "created": "2025-10-28 17:58:23",
                "check_time": "",
                "detail_list": [
                    {
                        "return_no": "CR202510240002",
                        "purchase_no": "",
                        "spec_no": "81a",
                        "goods_name": "0801",
                        "goods_no": "0801",
                        "short_name": "",
                        "spec_name": "古法",
                        "spec_code": "81a",
                        "barcode": "81a",
                        "provider_goods_no": "",
                        "defect": false,
                        "remark": "",
                        "batch_no": "",
                        "expire_date": "",
                        "base_unit_name": "个",
                        "aux_unit_name": "无",
                        "unit_ratio": "1.0000",
                        "settle_num": "2.0000",
                        "price": "2.0000",
                        "tax_rate": "0.0000",
                        "tax_price": "2.0000",
                        "total_amount": "4.0000",
                        "tax_amount": "4.0000",
                        "created": "2025-10-28 17:58:23",
                        "warehouse_name": "zxy的测试仓3"
                    },
                    {
                        "return_no": "CR202510240002",
                        "purchase_no": "",
                        "spec_no": "81b",
                        "goods_name": "0801",
                        "goods_no": "0801",
                        "short_name": "",
                        "spec_name": "81b",
                        "spec_code": "81b",
                        "barcode": "81b",
                        "provider_goods_no": "",
                        "defect": false,
                        "remark": "",
                        "batch_no": "",
                        "expire_date": "",
                        "base_unit_name": "只",
                        "aux_unit_name": "无",
                        "unit_ratio": "1.0000",
                        "settle_num": "2.0000",
                        "price": "12.0000",
                        "tax_rate": "0.0000",
                        "tax_price": "12.0000",
                        "total_amount": "24.0000",
                        "tax_amount": "24.0000",
                        "created": "2025-10-28 17:58:23",
                        "warehouse_name": "zxy的测试仓3"
                    },
                    {
                        "return_no": "CR202510240005",
                        "purchase_no": "",
                        "spec_no": "81a",
                        "goods_name": "0801",
                        "goods_no": "0801",
                        "short_name": "",
                        "spec_name": "古法",
                        "spec_code": "81a",
                        "barcode": "81a",
                        "provider_goods_no": "",
                        "defect": false,
                        "remark": "",
                        "batch_no": "",
                        "expire_date": "",
                        "base_unit_name": "个",
                        "aux_unit_name": "无",
                        "unit_ratio": "1.0000",
                        "settle_num": "2.0000",
                        "price": "2.0000",
                        "tax_rate": "0.0000",
                        "tax_price": "2.0000",
                        "total_amount": "4.0000",
                        "tax_amount": "4.0000",
                        "created": "2025-10-28 17:58:23",
                        "warehouse_name": "zxy的测试仓3"
                    },
                    {
                        "return_no": "CR202510240005",
                        "purchase_no": "",
                        "spec_no": "81b",
                        "goods_name": "0801",
                        "goods_no": "0801",
                        "short_name": "",
                        "spec_name": "81b",
                        "spec_code": "81b",
                        "barcode": "81b",
                        "provider_goods_no": "",
                        "defect": false,
                        "remark": "",
                        "batch_no": "",
                        "expire_date": "",
                        "base_unit_name": "只",
                        "aux_unit_name": "无",
                        "unit_ratio": "1.0000",
                        "settle_num": "1.0000",
                        "price": "12.0000",
                        "tax_rate": "0.0000",
                        "tax_price": "12.0000",
                        "total_amount": "12.0000",
                        "tax_amount": "12.0000",
                        "created": "2025-10-28 17:58:23",
                        "warehouse_name": "zxy的测试仓3"
                    },
                    {
                        "return_no": "CR202510270003",
                        "purchase_no": "",
                        "spec_no": "spec_180thisisalongspec_nospec_180thisisspec_180thisisalongspec_nospec_180thisi1",
                        "goods_name": "商家编码80测试商家编码80测试商家编码80测试商家编码80测试商家编码80测试商家编码80测试商家编码80测试我是最后一个IE",
                        "goods_no": "spec_test",
                        "short_name": "",
                        "spec_name": "spec_180thisisalongspec_nospec",
                        "spec_code": "spec_180thisisalongspec_nospec",
                        "barcode": "spec_180thisisalongspec_nospec",
                        "provider_goods_no": "",
                        "defect": false,
                        "remark": "",
                        "batch_no": "",
                        "expire_date": "",
                        "base_unit_name": "无",
                        "aux_unit_name": "无",
                        "unit_ratio": "1.0000",
                        "settle_num": "2.0000",
                        "price": "0.0000",
                        "tax_rate": "0.0000",
                        "tax_price": "0.0000",
                        "total_amount": "0.0000",
                        "tax_amount": "0.0000",
                        "created": "2025-10-28 17:58:23",
                        "warehouse_name": "nff的本地仓库"
                    },
                    {
                        "return_no": "CR202510270003",
                        "purchase_no": "",
                        "spec_no": "spec_180thisisalongspec_nospec_180thisisspec_180thisisalongspec_nospec_180thisi2",
                        "goods_name": "商家编码80测试商家编码80测试商家编码80测试商家编码80测试商家编码80测试商家编码80测试商家编码80测试我是最后一个IE",
                        "goods_no": "spec_test",
                        "short_name": "",
                        "spec_name": "spec_180thisisalongspec_nospec2",
                        "spec_code": "spec_180thisisalongspec_nospec2",
                        "barcode": "spec_180thisisalongspec_nospec2",
                        "provider_goods_no": "",
                        "defect": false,
                        "remark": "",
                        "batch_no": "",
                        "expire_date": "",
                        "base_unit_name": "无",
                        "aux_unit_name": "无",
                        "unit_ratio": "1.0000",
                        "settle_num": "1.0000",
                        "price": "0.0000",
                        "tax_rate": "0.0000",
                        "tax_price": "0.0000",
                        "total_amount": "0.0000",
                        "tax_amount": "0.0000",
                        "created": "2025-10-28 17:58:23",
                        "warehouse_name": "nff的本地仓库"
                    },
                    {
                        "return_no": "CR202510270003",
                        "purchase_no": "",
                        "spec_no": "spec_180thisisalongspec_nospec_180thisisspec_180thisisalongspec_nospec_180thisi3",
                        "goods_name": "商家编码80测试商家编码80测试商家编码80测试商家编码80测试商家编码80测试商家编码80测试商家编码80测试我是最后一个IE",
                        "goods_no": "spec_test",
                        "short_name": "",
                        "spec_name": "spec_180thisisalongspec_nospec3",
                        "spec_code": "spec_180thisisalongspec_nospec3",
                        "barcode": "spec_180thisisalongspec_nospec3",
                        "provider_goods_no": "",
                        "defect": false,
                        "remark": "",
                        "batch_no": "",
                        "expire_date": "",
                        "base_unit_name": "无",
                        "aux_unit_name": "无",
                        "unit_ratio": "1.0000",
                        "settle_num": "3.0000",
                        "price": "0.0000",
                        "tax_rate": "0.0000",
                        "tax_price": "0.0000",
                        "total_amount": "0.0000",
                        "tax_amount": "0.0000",
                        "created": "2025-10-28 17:58:23",
                        "warehouse_name": "nff的本地仓库"
                    }
                ]
            }
        ]
    },
    "status": 0
}

6.2 异常响应示例

JSON	{ "status": 100, "message": "参数中必须包含起止时间" }