查询回款单列表 - 尘锋SCRM开放平台

POST https://qw-openapi-tx.dustess.com/java-payback-srv/open-api/payback/v2/list?accessToken=

请求header

字段	值
Content-Type	application/json

接口限制：每分钟调用600次；

请求参数

参数名称	类型	描述	是否必须
limitSize	`Int`	分页查询条数（最小1, 最大100，默认10）	false
orderNumbers	`String[]`	根据订单编码列表查询回款单	false
nextPageBeginNumber	`String`	下一页数据查询起始编码（对应回款单Id）	false
paybackNo	`String`	回款单编号	false
payType	`Int`	回款方式 (1：对公转账 2：微信收款3：支付宝4：银联聚合收款 5：其他 6：余额 7:现金收款 8：POS机收款）默认全部	false
status	`Int`	回款单状态 (1：待认领 2：已认领 3：已废弃 4：待确认 5：已驳回 6:已撤销) 默认全部	false
startTime	`String`	回款日期开始日期(如： 2020-08-09)，不传则查询全量数据，没有查询时间范围限制	false
endTime	`String`	回款日期截止日期(如：2020-08-09)，不传则查询全量数据，没有查询时间范围限制	false

请求参数示例
json - Request-Example:

{
	"limitSize": 0,
	"nextPageBeginNumber": "",
	"orderNumbers": [],
	"payType": 1,
	"paybackNo": "xxx",
	"startTime": "",
    "endTime": "",
	"status": 1
}

成功响应

参数名称	类型	描述
code	`Int`	状态码
msg	`String`	状态信息
data	`Object`	响应数据
data.totalCount	`Long`	符合条件的回款单总数
data.itemCount	`Long`	本次调用获取的回款单数量
data.nextId	`String`	拉取列表的最后一个回款单ID
data.items	`Object[]`	回款单列表
data.items.id	`Long`	回款单id
data.items.paybackNo	`String`	回款单编号
data.items.subjectName	`String`	收款主体
data.items.claimantId	`String`	认领人id
data.items.belongDeptId	`Int`	回款归属部门id
data.items.followId	`String`	跟进人id
data.items.createMethod	`Int`	创建方式(1：手动 2：导入 3：自动）
data.items.paybackDate	`Date`	回款日期
data.items.paybackMethodName	`String`	回款方式名称
data.items.paybackMethod	`Int`	回款方式(1：对公转账 2：微信收款3：支付宝4：银联聚合收款 5：其他 6：余额 7:现金收款 8：POS机收款)
data.items.payAccountCorpName	`String`	支付企业名称
data.items.identificationCode	`String`	微信收款：微信支付单号,对公转账：付方账号,银联聚合收款：商户订单号,支付宝：交易号,其他/余额/现金收款/POS机收款：回款识别码
data.items.remitter	`String`	打款人
data.items.status	`Int`	状态(1：待认领 2：已认领 3：已废弃 4：待确认 5：已驳回 6:已撤销)
data.items.remark	`String`	备注信息
data.items.attachments	`Object`	附件
data.items.attachments.name	`String`	文件名称
data.items.attachments.type	`String`	文件类型
data.items.attachments.url	`String`	下载地址
data.items.attachments.size	`Long`	文件大小
data.items.certificates	`Object`	凭证
data.items.certificatesname	`String`	文件名称
data.items.certificates.type	`String`	文件类型
data.items.certificates.url	`String`	下载地址
data.items.certificates.size	`Long`	文件大小
data.items.serialNo	`String`	流水号
data.items.searchNo	`String`	检索号
data.items.bankMerchantNo	`String`	银商订单号
data.items.merchantOrderNo	`String`	商户订单号
data.items.paybackAmount	`String`	回款金额，单位:元
data.items.relateOrderAmount	`String`	已关联订单金额
data.items.unRelateOrderAmount	`String`	未关联金额
data.items.relationType	`Int`	关联信息类型(1-个人，2-企业)
data.items.relateCustomer	`Object`	关联联系人信息
data.items.relateCustomer.customerId	`String`	关联联系人id
data.items.relateCompany	`Object`	关联企业信息
data.items.relateCompany.companyId	`String`	关联企业id
data.items.relateOrders	`Object[]`	关联订单列表
data.items.relateOrders.orderNumber	`String`	订单编码
data.items.relateOrders.orderAmount	`String`	订单金额
data.items.relateOrders.phase	`Int`	回款期次
data.items.relateOrders.planDate	`Date`	计划回款日期
data.items.relateOrders.planPaybackAmount	`String`	计划回款金额
data.items.relateOrders.paybackAmount	`String`	已回款金额
data.items.relateOrders.unPayAmount	`String`	未回款金额
data.items.relateOrders.relateAmount	`String`	关联回款单金额
data.items.relateOrders.operatorId	`String`	最新关联操作人id
data.items.relateOrders.operateTime	`Date`	最新建立关联时间
data.items.redFlushList	`Object[]`	关联红冲单列表
data.items.redFlushList.amount	`Double`	红冲金额
data.items.redFlushList.orderNo	`String`	订单编号
data.items.redFlushList.redFlushDate	`Date`	红冲日期
data.items.redFlushList.redFlushNo	`String`	红冲单号
data.items.redFlushList.refundNo	`String`	售后单号
traceId	`String`	跟踪id

成功响应示例

{
    "code": 0,
    "data": {
        "itemCount": 1,
        "items": [
            {
                "claimantId": "5499",
                "belongDeptId": 1,
                "createBy": "5499",
                "createMethod": 1,
                "followId": "1623",
                "id": "4677367xxx16471552",
                "identificationCode": "",
                "lastModifiedTime": "2023-07-14 16:58:45",
                "paybackAmount": "800.00",
                "paybackDate": "2023-07-14",
                "paybackMethod": 1,
                "paybackMethodName": "对公转账",
                "paybackNo": "HK2023071400005",
                "redFlushList": [],
                "relateCompany": {
                    "companyId": "xxxx"
                },
                "relateOrderAmount": "800.00",
                "relateOrders": [
                    {
                        "operateTime": "2023-07-14 16:58:45",
                        "operatorId": "5499",
                        "orderAmount": "800",
                        "orderNumber": "1679776xxxxx310144",
                        "paybackAmount": "800.00",
                        "relateAmount": "800.00",
                        "unPayAmount": "0.00"
                    }
                ],
                "relationType": 2,
                "status": 2,
                "unRelateOrderAmount": "0.00",
                "updateBy": "5499"
            }
        ],
        "nextId": "467736724216471552",
        "totalCount": 1
    },
    "msg": "OK",
    "traceId": "7ae2391f-6be2-9f6c-bb02-5d1b7a5641da"
}

错误响应示例

  {
    "code": 500500,
    "data": {},
    "msg": "服务端错误：xxxx",
    "traceId": "5fefbbc6-bbde-988a-9226-4b590c8e707b"
}