当前位置： API文档

sales.Payment.queryWithDetail（销售收付单查询）

¥标准

1.接口说明

1.1 接口描述：获取ERP内销售收付款单信息
1.2 适用版本：客户端V1.4.3.7及以上版本
1.3 增量获取:
1.4 时间跨度：最大跨度不能超过30天

1.5注意事项：为了达到保护用户隐私数据安全的目的，本接口不返回淘系及系统供销平台订单数据，相关平台规则点击这里，淘系及系统供销平台数据获取办法点击这里。

本接口中涉及到用户隐私的字段数据仅有自有平台及线下平台订单返回。具体字段详情见下面表格；

字段描述字段名
客户网名
buyer_nick

2.调用场景

2.1 举例说明：

3.请求参数说明

   3.1 请求地址

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

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
是卖家账号, 由旺店通分配
接口账号keyString
是由旺店通分配appkey, 在发送的数据中对应 key 字段,获取方式点击这里
盐saltString
是由旺店通分配appsecret，是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称methodString
是调用的接口名称
版本号vString
是1.0
秒级时间戳timestampint
是秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
是签名
分页大小page_sizeint
否分页大小，分页查询必传
分页编号page_noint
否分页编号，分页查询必传，标准接口page_no从0开始
是否计算查询结果的总条数calc_totalint
否是否计算查询结果的总条数, 需要计算则1, 否则填0         

   3.3 业务请求参数

名称字段类型长度
必须描述

业务请求参数

params

Map<String, Object>


是

业务请求参数

分页

pager

pager


是

分页

params

名称字段类型长度
必须描述
开始时间start_timeString40是

开始时间，yyyy-MM-dd HH:mm:ss格式

结束时间end_time

String

40是

结束时间，上同开始时间

时间类型time_typeInt4
否

0：创建时间

1：收付时间

默认0

状态
statusInt
4
否

10：已取消

20：待审核

30：待结算

40：已完成

方向is_refundInt4
否

0：收款

1：退款

收付单号
payment_no
String
40
否
收付单号
业务单号
sales_order_no
String
40
否
业务单号
店铺编号
shop_nos
String
20
否
店铺编号，多个使用英文逗号分隔

pager

名称字段类型长度
必须描述
分页大小page_sizeInt4否

分页大小

页号page_noInt4否

从0开始

4.响应参数

名称字段类型长度
必须描述
状态码statusInt
Y

状态码,0表示正常

错误信息messageString
Y

无错误信息不返回

响应正文数据data

Map<String, Object>


Y响应正文数据

data

名称字段类型长度
必须描述
总数total_countInt11Y

查询单据总条数

单据信息payment_listList<Map<String, Object>>
Y

单据信息

payment_list

名称字段类型长度
必须描述
主键id

payment_id

Int
11
是主键id
收付单号

payment_no

String40
是收付单号
状态

status

Int4
是10: 编辑中 

20: 待审核 

30: 待结算

40: 已完成

店铺编号
shop_noString
40
是店铺编号
业务单号sales_order_noString40
是业务单号
原始单号
raw_nosString40
是原始单号
业务类型order_typeInt4
是

1：订单

2：原始单

3：退换单

4：线下退款

款项类型
refund_typeString40
是款项类型
收款账户account_nameString40
是收款账户
网名
buyer_nickString40
是
网名（仅自有平台及线下平台返回，其他平台均不返回）
付款账户pay_accountString40
是付款账户
买家开户银行account_bankString40
是买家开户银行
退款金额refund_amount

Decimal(19,4)


是退款金额
收款金额receive_amount

Decimal(19,4)


是收款金额
实际收退款金额real_amount

Decimal(19,4)


是实际收退款金额
核销金额
verify_amount

Decimal(19,4)


是核销金额
建单人
operator_nameString40
是建单人
建单时间
created
String
40
是
建单时间
收付人
checker_name
String
40
是
收付人
收付时间
pay_time
String
40
是
收付时间
异常退款标记
error_type
Int
4
是

退款异常标记

1：取消

2：已退款

3：待撤销

备注
remarkString255是
备注
建单人id
operator_idInt11是
建单人id
收付人id
checker_idInt11是
收付人id
业务单id
sales_order_idInt11是
业务单id（若是销售订单对应的是订单主键，若是退款单对应的是退换单主键）
方向
is_refundboolean1是

true：退款

false：收款

店铺id
shop_idInt
11是
店铺id
收款账户id
account_id
Int
11
是
收款账户id

5.请求示例

Json格式请求报文
[
    {
        "start_time": "2022-12-01 00:00:00",
        "end_time": "2022-12-28 17:59:59"
    }
]
PHP

<?php
include 'wdtsdk.php';
 
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret");
$parMap = new stdClass();
 
$parMap->start_time = '2022-12-01 00:00:00';
$parMap->end_time = '2022-12-28 17:59:59';

 
$pager = new Pager(2, 0, true);
 
try {
    $data = $client->pageCall("sales.Payment.queryWithDetail", $pager, $parMap);
}catch(WdtErpException $e)
{
    echo $e->getMessage();
}
?>

6.响应示例

   6.1 正常响应示例 

JSON

{
    "status": 0,
    "data": {
        "total_count": 25,
        "payment_list": [
            {
                "operator_id": 149,
                "remark": "手工建单,立即收款199.0000元",
                "pay_account": "",
                "account_bank": "",
                "checker_id": 149,
                "sales_order_no": "AT202212120003-9",
                "verify_amount": 199.0000,
                "payment_id": 14412,
                "sales_order_id": 0,
                "error_type": 0,
                "account_name": "现金-A",
                "refund_amount": 0.0000,
                "order_type": 2,
                "is_refund": false,
                "shop_no": "00212",
                "checker_name": "gwc",
                "refund_type": 0,
                "created": "2022-12-28 16:40:58",
                "version_id": 0,
                "pay_time": "2022-12-28 16:40:58",
                "shop_id": 57,
                "real_amount": 199.0000,
                "buyer_nick": "xi9",
                "operator_name": "gwc",
                "account_id": 1,
                "payment_no": "SF2022122800014",
                "receive_amount": 199.0000,
                "raw_nos": "",
                "status": 40
            }
        ]
    }
}

   6.2 异常响应示例

JSON

{"status":100,"message":"您的查询时间过宽,查询时间不能大于30天"}





常用工具