动鑫云工场API接口文档
1.文档概述
本文档是动鑫云工场专为合作商户提供的系统对接说明文档。为了协助我们的合作伙伴成功接入动鑫云工场提供的服务,请务必依据文档内容开发部署。
特别声明:未经动鑫云工场许可,不得将动鑫云工场提供的接口技术、安全协议及证书等以任何方式提供给第三方使用。请合作伙伴妥善保存。本文档的解释权归动鑫云工场所有。
2.应用范围
3.接口规范介绍
3.1请求规范
1.请求采用HTTPS POST方式请求( 参数在 RequestBody 中 Content-Type application/json);
2.编码格式统一为utf-8;
3.数据格式统一为json;
4.请求签名采用MD5或者RSA签名(建议使用RSA加密);
5.IP白名单限制测试环境、生产环境均需提供ip进行白名单配置;
6.测试环境IP及生产请联系运营人员获取;
7.文档中Y代表必输项,N代表非必输,C代表条件传输。
3.2关于签名
为保证您与动鑫云工场之间消息来往的安全性,防止支付或者通知的数据被伪造、篡改,动鑫云工场要求对所有来往的信息加入签名机制。
签名算法使用SHA256withRSA。
除sign字段外所有值不为空的参数均需参与签名。
采用RSA加密方式需加签与业务参数data需进行加密,得到元数据需解密获取并验签。
密钥生成长度为1024位。
密钥生成格式为PKCS#8。
3.2.1RSA签名
在您与动鑫云工场的交易中, 会使用到两对公私钥,即企业公私钥与动鑫云工场公私钥。
企业公私钥:用于您向动鑫云工场发送请求时的加签与验签。 该公私钥由您自己生成, 其中,私钥用于对您发往动鑫云工场的数据签名,自己保存;公钥需要提交给动鑫云工场,当动鑫云工场收到您发来的数据时用该公钥验证签名。
动鑫云工场公私钥:用于动鑫云工场向您发送通知或者响应时的加签与验签。该公私钥由动鑫云工场生成,其中,动鑫云工场私钥不提供;动鑫云工场公钥可于动鑫云工场系统安全中心中自行下载。
- 生成请求报文
建议使用平台提供的方法获取秘钥。
/**
* 生成秘钥
* 将私钥保存,公钥上传到动鑫云工场平台
* @throws Exception
*/
public static void getRsaKey() throws Exception {
Map<String, String> keyMap = MyRSA.genKeyPair();
String publicKey = MyRSA.getPublicKey(keyMap);
String privateKey = MyRSA.getPrivateKey(keyMap);
System.out.println("公钥:"+publicKey);
System.out.println("私钥:"+privateKey);
}
- 生成请求报文
1.将业务参数组装成JSON字符串格式;
2.使用动鑫云工场平台公钥对提交的业务参数进行加密;
3.除文档中明确标注不参与签名的参数外,所有值不为空的参数均需参与签名,使用对接方私钥进行签名;
4.将签名数据和加密数据组装发送动鑫云工场平台。
/**
* 生成发送数据包
* @param appId
* @param bbxPublicKey 动鑫云工场公钥
* @param myPrivateKey 对接方的私钥
* @param data 需要发送请求的业务数据(未加密)
* @return
* @throws Exception
*/
public static String createSendMsg(String appId,String bbxPublicKey,String myPrivateKey,String data) throws Exception {
BaseDataVo vo = new BaseDataVo();
vo.setAppid(appId);
vo.setNonceStr(RandomStringUtils.randomAlphanumeric(20));
vo.setReqMsgId(UUID.randomUUID().toString().replace("-",""));
vo.setSignType("RSA");
vo.setTimestamp(String.valueOf(System.currentTimeMillis()));
String encryptData = MyRSA.encryptByPublicKey( data,bbxPublicKey);//使用动鑫云工场公钥进行加密
vo.setData(encryptData);
String signData = MyRSA.sign(JSON.toJSONString(vo),myPrivateKey);//使用我的私钥进行签名,对所有数据进行签名
vo.setSign(signData);
//vo.setData(encryptData);
return JSON.toJSONString(vo);
}
- 验签解密平台报文
1.格式转换平台返回报文为对象或JSON;
2.使用动鑫云工场平台公钥对数据进行验签;
3.使用对接方私钥对业务数据data进行解密,放入对象。
/**
* 收到数据后进行解密验签(包含回调)
* 解密&验签
* @param publicKey 使用动鑫云工场平台公钥进行验签
* @param privateKey 使用对接方的私钥进行解密
* @param data
* @return
*/
public static BaseDataVo decryptAndVerify(String publicKey, String privateKey, String data) throws Exception {
BaseDataVo vo = JSONObject.parseObject(data, BaseDataVo.class);
String signData = vo.getSign();
vo.setSign(null);//签名数据需要移除掉,不然会导致验签失败
boolean verify = MyRSA.verify(JSON.toJSONString(vo),publicKey, signData); //使用动鑫云工场平台公钥进行验签,除sign外的所有数据进行验签
vo.setVerify(verify);
if(verify) {//验签失败不进行解密
String decrypt = MyRSA.decryptByPrivateKey(JSON.toJSONString(vo.getData()), privateKey);//使用我的私钥进行解密
vo.setData(decrypt);
}
return vo;
}
- 特别说明
当动鑫云工场通知您时,动鑫云工场会使用动鑫云工场私钥进行加签,企业提供公钥进行加密业务数据,请您进行验签以确保数据的准确性,并解密业务数据已获取元数据。
回调验签解密方式与同步接口请求方法一致。
3.2.2关于请求报文公共头
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
sign | String | Y | 签名 | |
signType | String | Y | RSA | 签名类型RSA/MD5 |
timestamp | String | Y | 1645770163620 | 请求时间戳 |
nonceStr | String(20) | Y | MPzteIbCc0JiJRDWxsTQ | 随机字符串 长度20 |
reqMsgId | String(32) | Y | 394b83504cf947edbb6af8e9247a9d6b | 请求id,全局唯一 |
appid | String(32) | Y | 动鑫云工场平台分配给合作方业务平台签约唯一ID |
3.2.3关于响应报文公共头
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
sign | String | Y | 签名 | |
signType | String | Y | RSA | 签名类型RSA/MD5 |
timestamp | String | Y | 1645770163620 | 请求时间戳 |
nonceStr | String(20) | Y | DPztedbCc0JiJRDWxsTQ | 随机字符串 长度20 |
reqMsgId | String(32) | Y | 494b83504cf947edbb6af8e9247a9d6r | 响应id,全局唯一 |
appid | String(32) | Y | 动鑫云工场平台分配给合作方业务平台签约唯一ID | |
code | String | Y | 200 | 请求响应码 只表示接口调用是否成功,并不表明业务处理结果。 |
message | String | N | 请求成功 | 信息 |
3.3回调通知
所有通知类接口均根据接入方提供URL进行异步回调,接收方返回200即不再进行回调,若无响应则进行1、2、4、5、10、15分钟间隔回调,六次回调均无响应成功则不再进行回调,请发起主动查询获取结果。
回调通知接口需要对接方依据本文档规定进行相应的接收数据接口开发。
3.4关于分页
所有返回数据可能会产生大量数据的接口,均通过分页的方式返回。平台默认每页100条数据。分页请求需添加参数pageNum,表示第几页。
4名称解释
对接方:本文档阅读用户,对接的企业用户或者渠道用户。
月大小额限制拦截:月限额分为月限额与月大额限额,未超过月限额结算费率使用小额费率,超过月限额使用大额费率。超过月大额选择不允许进行结算支付。若企业配置是否允许小额转大额为否,则超过月限额不允许结算支付。同园区根据其业务规模支持范围具有不同的月限额设置。
年限额拦截:当自由职业者本年累计发放额度超过年限额时,平台不允许发放。不同园区根据其业务规模支持范围具有不同的年限额设置。
三月限额拦截:当自由职业者连续三个月(包含本月)发放额度都超过三月限额时,平台不允许发放。不同园区根据其业务规模支持范围具有不同的三月限额设置。
补缴服务费:企业配置是否允许小额转大额为是的情况下,当结算支付的某个自由职业者月累计发放超过月限额时,结算费率由小额费率变为大额费率,并且本月之前累积发放的金额也需要按照大额费率进行补缴,补缴的该部分费用成为补缴服务费。计算公式为:本月累计发放金额 *(大额费率-小额费率)。
定向招募:企业发布任务不对外公开,内部定向分派给指定的自由职业者完成该任务并进行结算。
自由招募:企业发布的任务面向社会发布,所有具有相应技能的自由职业者均可以认领该任务,企业进行审核。
5.接口详情
本章仅描述接口api的业务意义以及其业务参数,公共参数详见3.2.3公共参数说明部分。
5.1企业入驻
5.1.1入驻申请
- 说明
企业接入平台首先需要进行入驻申请,平台审核通过之后会为企业分配对应的园区并进行开户,同时设置服务费率、支持的项目类型、任务类型以及对应的开票类目等信息。
企业申请时,建议配置上回调URL。平台审核通过或者拒绝之后会自动通过回调URL告知企业。
企业的费率、账号等信息,平台通过回调接口告知企业,支持园区、项目类型、任务类型等信息需要通过其他接口进行主动查询。
- 接口API
/interface/company/register
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
companyName | String | 50 | Y | 企业名称 | |
creditCode | String | 30 | Y | 企业社会统一信用代码 | |
companyAddr | String | 100 | Y | 企业地址 | |
companyMobile | String | 20 | Y | 企业电话 | |
companyEmail | String | 20 | N | 企业邮箱 | |
businessScope | String | 200 | N | 经营范围 | |
businessType | String | 10 | N | 所属行业 详见《行业编码》 |
|
serviceTypeId | String | 10 | Y | 灵活用工场景编码 详见 《灵活用工场景编码》 |
|
registeredAssets | long | Y | 注册资本(单位:万元) | ||
regdate | String | 15 | Y | 2022-01-01 | 注册时间 |
bankName | String | 50 | Y | 企业开户行 | |
bankAcct | String | 50 | Y | 企业银行账户 | |
bankCode | String | 30 | Y | 企业开户行行号 | |
contactName | String | 30 | Y | 企业联系人 | |
contactMobile | String | 20 | Y | 企业联系人电话 | |
referralCode | String | 10 | N | 推荐码 | |
legalPersonName | String | 20 | Y | 法人姓名 | |
idNo | String | 20 | Y | 法人身份证号 | |
idCardFace | String | N | Base64图片(图片不能大于2M)/可访问URL | 法人身份证人像面 | |
idCardEmblem | String | N | Base64图片(图片不能大于2M)/可访问URL | 法人身份证国徽面 | |
businessLicense | String | Y | Base64图片(图片不能大于2M)/可访问URL | 营业执照照片 | |
accountLicense | String | Y | Base64图片(图片不能大于2M)/可访问URL | 银行开户许可证照片 | |
houseNumberImg | String | C | Base64图片(图片不能大于2M)/可访问URL | 办公场地门头照 注册时间小于6个月必传 |
|
officeSpaceImg | String | C | Base64图片(图片不能大于2M)/可访问URL | 办公场地场所照 注册时间小于6个月必传 |
|
receptionImg | String | C | Base64图片(图片不能大于2M)/可访问URL | 办公场地前台照 注册时间小于6个月必传 |
|
callBackUrl | String | 100 | N | 回调通知URL | |
bookedNoticeUrl | String | 100 | N | 入账回调地址 | |
SignChangeNoticeUrl | String | 100 | N | 短信签约回调地址 用户签约成功后通过该地址回调 |
- 请求示例
{
"sign": "dsfdsfdsgsdfds",
"signType": "MD5",
"appid": "156412121",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiSRDWxsTQ",
"reqMsgId": "394b83504cfDFDSSDSedbb6af8e9247a9d6b",
"data": {
"companyName": "北京接口科技有限公司",
"creditCode": "91110108MA04EN0G0G",
"companyAddr": "北京市大兴区丈八沟街道",
"companyMobile": "173196655242",
"companyEmail": "1564515@qq.com",
"businessScope": "建筑业行业",
"businessType": "土木工程建筑业",
"serviceTypeId": "1",
"registeredAssets": "500",
"regdate": "2022-03-01",
"bankName": "建设银行",
"bankAcct": "622365451052525",
"bankCode": "45412125620252",
"contactName": "张三",
"contactMobile": "17319852652",
"referralCode": "1",
"taskAuto": "1",
"legalPersonName": "王五",
"idNo": "632323190605269943",
"idCardFace": "http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1640327997055.jpg",
"idCardEmblem": "http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1640327997055.jpg",
"businessLicense": "http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1640327997055.jpg",
"accountLicense": "http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1640327997055.jpg",
"houseNumberImg": "http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1640327997055.jpg",
"officeSpaceImg": "http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1640327997055.jpg",
"receptionImg": "http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1640327997055.jpg",
"callBackUrl": "https://www.baidu.com"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码,作为企业在本平台内的唯一业务标志 | |
companyName | String | 100 | Y | 企业名称 | |
creditCode | String | 50 | Y | 企业社会统一信用代码 | |
status | String | 2 | Y | 审核状态 00-暂存,01-提交风控审核,02-风控拒绝,待运营审核,03-无效(关闭), 04-提交运营审核,05-运营审核拒绝,10-待配置参数,11-准入成功 |
- 响应示例
{
"code": "104-0020-001",
"message": "企业已注册"
}
{
"code": "200",
"data": {
"creditCode": "91110108MA04EN0G0G2",
"companyName": "北京接口科技有限公司",
"businessId": "951221569354338304",
"status": "01"
},
"message": "操作成功",
"nonceStr": "uzzWXz2qMYLEP3twqvdy",
"timestamp": 1646830497679
}
5.1.2入驻结果查询
- 说明
企业发起准入申请后,若没有发送回调URL,可通过该API查询审核状态。若发送了回调URL长时间没有收到回调通知,也可通过该接口进行查询。
- 接口API
/interface/company/queryCompanyInfo
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "2022022800001",
"data":
{
"businessId": "950709751405330432"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
companyName | String | 100 | Y | 企业名称 | |
creditCode | String | 50 | Y | 企业社会统一信用代码 | |
status | String | 2 | Y | 审核状态 00-暂存,01-提交风控审核,02-风控拒绝,待运营审核,03-无效(关闭), 04-提交运营审核,05-运营审核拒绝,10-待配置参数,11-准入成功 |
|
acctInfo | Array | N | 账户信息 |
acctInfo 账户信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
parkId | String | Y | 园区 Id | ||
parkName | String | 100 | Y | 园区名称 | |
acctNo | String | 50 | Y | 银行账号 | |
acctName | String | 100 | Y | 账户名 | |
bankName | String | 500 | Y | 银行名称 | |
zfCode | String | 50 | Y | 支付通道编码 | |
limitAmount | long | Y | 单笔最大限额(整数,单位:分) |
- 响应示例
{
"code": "200",
"data": {
"acctInfo": [
{
"acctNo": "30206465066104",
"parkName": "uat测试园区",
"zfCode": "pa_pay",
"limitAmount": 10000000,
"bankName": "前端数据支持测试江西讫酉有限公司",
"acctName": "北京接口科技有限公司",
"parkId": 2
}
],
"creditCode": "91110108MA04EN0G0G",
"companyName": "北京接口科技有限公司",
"businessId": "950709751405330432",
"status": "11"
},
"message": "操作成功",
"nonceStr": "30dgOBbLggO6EhNBnXOD",
"timestamp": 1646832521850
}
5.1.3入驻结果回调
- 说明
若申请入驻参数中包含了回调URL,平台审核通过或者拒绝后会及时通过该接口告知对接方。该API包含审核状态、平台为企业开通的账号、服务费率等信息。
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
companyName | String | 100 | Y | 企业名称 | |
creditCode | String | 50 | Y | 企业社会统一信用代码 | |
status | String | 2 | Y | 审核状态 00-暂存,01-提交风控审核,02-风控拒绝,待运营审核,03-无效(关闭), 04-提交运营审核,05-运营审核拒绝,10-待配置参数,11-准入成功 |
|
acctInfo | Array | N | 账户信息 |
acctInfo 账户信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
parkId | Long | Y | 园区 Id | ||
parkName | String | 100 | Y | 园区名称 | |
acctNo | String | 40 | Y | 银行卡号 | |
acctName | String | 30 | Y | 账户名 | |
bankName | String | 30 | Y | 银行名称 | |
zfCode | String | 50 | Y | 支付通道编码 | |
limitAmount | Long | Y | 单笔最大限额(整数,单位:分) |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "2022022800001",
"data":
{
"acctInfo": [
{
"acctNo": "30206465066104",
"parkName": "uat测试园区",
"zfCode": "pa_pay",
"limitAmount": 10000000,
"bankName": "前端数据支持测试江西讫酉有限公司",
"acctName": "北京接口科技有限公司",
"parkId": 2
}
],
"creditCode": "91110108MA04EN0G0G",
"companyName": "北京接口科技有限公司",
"businessId": "950709751405330432",
"status": "11"
}
}
- 响应参数
code | 说明 |
---|---|
200 | 通知成功不再回调 |
非200 | 2、4、5、10、15分钟间隔回调,五次回调均无响应成功则不再进行回调 |
- 响应示例
{
"code": "200",
"message": "请求成功"
}
5.1.4新增/修改线上签约授权书
- 说明
新增/修改线上签约授权书
- 接口API
/interface/company/authInfoSave
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | Y | 企业编码 | ||
signer | String | Y | 授权人姓名 | ||
signerIdno | String | Y | 授权人身份证号 | ||
signerMobile | String | Y | 授权人手机号 | ||
authFileUrl | String | Y | 授权书url |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "2022022800001",
"data": {
"businessId": "950709751405330432",
"authFileUrl": "http://123456.jpg",
"signer": "张三",
"signerIdno": "410***",
"signerMobile": "13000000000"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
- 响应示例
{
"code": "200",
"data": {},
"message": "操作成功",
"nonceStr": "30dgOBbLggO6EhNBnXOD",
"timestamp": 1646832521850
}
5.1.5企业线上签约
- 说明
企业和税源地进行线上电子签约
- 接口API
/interface/company/gotoSign
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | Y | 企业编码 | ||
contractId | String | Y | 签约合同模板id | ||
parkIds | String | Y | 税源地id多个,隔开 | ||
callbackUrl | String | N | 回调地址 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "2022022800001",
"data": {
"businessId": "950709751405330432",
"authFileUrl": "http://123456.jpg",
"signer": "张三",
"signerIdno": "410***"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
contractId | string | Y | 合同编号 | ||
contractDownloadUrl | string | Y | 待签约合同地址 |
- 响应示例
{
"code": "200",
"data": {
"contractId": "123***",
"contractDownloadUrl": "https://ws.hidongxin.com/fdd/api2/extsign.api?app_id=501894&v=2.0×tamp=20220726124249&transaction_id=1001469645875650560&customer_id=92724EF00A1069AD9CD96C545B6B6311&contract_id=1001469612124086272&doc_title=%E4%BC%81%E4%B8%9A%E5%9C%A8%E7%BA%BF%E7%AD%BE%E7%BA%A6%E5%90%88%E5%90%8C&keyword_strategy=0&sign_keyword=%E7%94%B2%E6%96%B9%EF%BC%88%E7%9B%96%E7%AB%A0%EF%BC%89&position_type=0&customer_mobile=13761310182¬ify_url=https%3A%2F%2Fws.hidongxin.com%2FcclgServer%2Fsystem%2FcallBack%2FfddSignCallBack&msg_digest=MDU5MEM3MTBDRjRBNDA0QkRCMTNFNTlEQTU2NjFFOTc0NTAwN0NFMw=="
},
"message": "操作成功",
"nonceStr": "30dgOBbLggO6EhNBnXOD",
"timestamp": 1646832521850
}
5.1.6查询企业合同状态
- 说明
查询具体企业合同状态信息
- 接口API
/interface/company/queryContract
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | Y | 企业编码 | ||
contractId | String | Y | 5.1.5返回编号 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "2022022800001",
"data": {
"businessId": "950709751405330432",
"contractId": "123546789"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
contractId | string | Y | 合同编号 | ||
contractName | string | Y | 待签约合同地址 | ||
signStatus | string | Y | 签约状态 | ||
contractViewUrl | string | N | 签约后合同地址 | ||
contractDownloadUrl | string | Y | 下载签约地址 | ||
signTime | string | N | 签约时间 | ||
createTime | string | Y | 创建时间 | ||
parkName | string | Y | 园区多个,隔开 |
- 响应示例
{
"code": "200",
"data": {
"contractId": "123***",
"contractName": "xxx合同",
"signStatus": "1",
"contractViewUrl": "https://ws.hidongxin.com/fdd/api2/extsign.api?app_id=501894&v=2.0×tamp=20220726124249&transaction_id=1001469645875650560&customer_id=92724EF00A1069AD9CD96C545B6B6311&contract_id=1001469612124086272&doc_title=%E4%BC%81%E4%B8%9A%E5%9C%A8%E7%BA%BF%E7%AD%BE%E7%BA%A6%E5%90%88%E5%90%8C&keyword_strategy=0&sign_keyword=%E7%94%B2%E6%96%B9%EF%BC%88%E7%9B%96%E7%AB%A0%EF%BC%89&position_type=0&customer_mobile=13761310182¬ify_url=https%3A%2F%2Fws.hidongxin.com%2FcclgServer%2Fsystem%2FcallBack%2FfddSignCallBack&msg_digest=MDU5MEM3MTBDRjRBNDA0QkRCMTNFNTlEQTU2NjFFOTc0NTAwN0NFMw==",
"signTime": "2023-01-01",
"createTime": "2023-01-01",
"parkName": "a园区,b园区,c园区",
"contractDownloadUrl": "https://ws.hidongxin.com/fdd/api2/extsign.api?app_id=501894&v=2.0×tamp=20220726124249&transaction_id=1001469645875650560&customer_id=92724EF00A1069AD9CD96C545B6B6311&contract_id=1001469612124086272&doc_title=%E4%BC%81%E4%B8%9A%E5%9C%A8%E7%BA%BF%E7%AD%BE%E7%BA%A6%E5%90%88%E5%90%8C&keyword_strategy=0&sign_keyword=%E7%94%B2%E6%96%B9%EF%BC%88%E7%9B%96%E7%AB%A0%EF%BC%89&position_type=0&customer_mobile=13761310182¬ify_url=https%3A%2F%2Fws.hidongxin.com%2FcclgServer%2Fsystem%2FcallBack%2FfddSignCallBack&msg_digest=MDU5MEM3MTBDRjRBNDA0QkRCMTNFNTlEQTU2NjFFOTc0NTAwN0NFMw=="
},
"message": "操作成功",
"nonceStr": "30dgOBbLggO6EhNBnXOD",
"timestamp": 1646832521850
}
5.1.7查询企业任务信息
- 说明
查询企业下正在进行中的任务信息
- 接口API
/interface/company/queryTask
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | Y | 企业编码 | ||
parkId | String | Y | 园区id |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "2022022800001",
"data": {
"businessId": "950709751405330432",
"parkId": "12"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
taskId | string | Y | 任务id | ||
parkName | string | Y | 园区名称 | ||
subjectOne | string | Y | 一级类目 | ||
subjectTwo | string | Y | 二级类目 |
- 响应示例
{
"code": "200",
"data": {
[{
"taskId": "123456",
"parkName": "a园区",
"subjectOne": "一级类目",
"subjectTwo": "二级类目"
}]
"message": "操作成功",
"nonceStr": "30dgOBbLggO6EhNBnXOD",
"timestamp": 1646832521850
}
5.2园区信息
5.2.1园区信息查询
- 说明
企业申请入驻后,平台审核并为企业分配相应的园区以及相应支持的项目、任务类型。本API主要查询企业关联的园区及其各自支持的项目、任务类型关系。用于对接方创建项目、任务必要的数据选项支持。
- 接口API
/interface/baseInfo/queryParks
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 907988488631091200 | 企业编码 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgt+Qo+gl9s+6okHOL186+Mr+DW8eNVpuepnUOB0fLF",
"signType": "RSA",
"appid":"14561212",
"timestamp": "1645770163620",
"nonceStr":"{% mock 'string', 'MPzteIbCc0JiJRDWxsTQ', 20, 20 %}",
"reqMsgId":"{% mock 'string', '44fdsf45dsf4s51cdfsd4s5c1', 20, 30 %}",
"data": {
"businessId": "950709751405330432",
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
parkId | String | Y | 园区 Id | ||
parkName | String | 100 | Y | 园区名称 | |
itemType | Array | Y | 园区支持项目类型 |
itemType 园区支持项目类型
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
itemTypeId | String | 10 | Y | 项目类型编号 | |
itemTypeName | String | 50 | Y | 项目类型名称 | |
taskType | Array | Y | 项目包含任务类型 | ||
invoiceOneObjectName | String | Y | 一级开票类目 |
taskType 项目包含任务类型
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
taskTypeId | String | 10 | Y | 任务类型编号 | |
taskTypeName | String | 50 | Y | 任务类型名称 | |
invoiceTwoObjectName | String | Y | 二级开票类目 |
- 响应示例
{
"code": "200",
"data": [
{
"itemType": [
{
"invoiceOneObjectName": "现代服务",
"itemTypeId": 2,
"itemTypeName": "人力资源服务",
"taskType": [
{
"invoiceTwoObjectName": "现代外包服务费",
"taskTypeId": 106,
"taskTypeName": "外包服务"
}
]
},
{
"invoiceOneObjectName": "现代服务",
"itemTypeId": 6,
"itemTypeName": "服务业",
"taskType": [
{
"invoiceTwoObjectName": "通用设备安装服务",
"taskTypeId": 138,
"taskTypeName": "通用设备安装服务"
}
]
}
],
"parkId": 23,
"parkName": "湖南税猫科技有限公司"
}
],
"appid": "954749107102408704",
"signType": "RSA",
"message": "操作成功",
"nonceStr": "zb0TiTWisCMtxCxJCDW0",
"timestamp": "1222332123",
"reqMsgId": "sdscs5sfds455455fssf4cfsds"
}
5.2.2项目任务类型信息查询
- 说明
本API返回企业支持的任务类型列表及其对应的项目类型和发票类目。请对接方一定要注意本API接口返回的数据信息,每一个任务类型都有其对应的发票类目,要认真核对企业的实际需求,创建项目、任务时一定要选择正确的项目类型和任务类型,平台只可以根据任务类型出具对应的发票。请一定要注意此项。
- 接口API
/interface/baseInfo/queryTaskTypes
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 907988488631091200 | 企业编码 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgt+Qo+gl9s+6okHOL186+Mr+DW8eNVpuepnUOB0fLF",
"signType": "RSA",
"appid":"14561212",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"data": {
"businessId": "923962185565216768",
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
taskType | String | 10 | Y | 任务类型编码 | |
taskTypeName | String | 50 | Y | 任务类型名称 | |
itemType | String | 10 | Y | 项目类型编码 | |
itemTypeName | String | 50 | Y | 项目类型名称 | |
invoiceOneObjectName | String | 100 | Y | 发票一级类目名称 | |
invoiceTwoObjectName | String | 100 | Y | 发票二级类目名称 | |
serviceType | Array | Y | 服务类型 | ||
deliveries | Array | Y | 交付物种类 |
serviceType 服务类型
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
name | String | 50 | Y | 服务类型名称 | |
id | int | N | 服务类型ID |
deliveries 交付物种类
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
name | String | 50 | Y | 交付物种类名称 | |
type | String | 5 | Y | 交付物种类 | |
id | int | N | 服务类型ID |
- 响应示例
{
"code": "200",
"message": "操作成功",
"nonceStr": "U85EjT1xFIJEsMHgv8Ez",
"timestamp": 1646890709987,
"data": [
{
"deliveries": [
{
"id": 1,
"name": "测试及验收报告",
"type": "1"
}
],
"invoiceLevelOne": 35,
"invoiceLevelTwo": 1,
"invoiceOneObjectName": "数据研发技术服务",
"invoiceTaxCode": "3040105000000000000",
"invoiceTwoObjectName": "研发和技术服务",
"itemType": 1,
"itemTypeName": "专业服务",
"serviceType": [
{
"name": "计算机软件服务",
"id": 1
}
],
"taskType": 12,
"taskTypeName": "数据研发"
},
{
"deliveries": [
{
"id": 2,
"name": "解决方案",
"type": "1"
}
],
"invoiceLevelOne": 37,
"invoiceLevelTwo": 3,
"invoiceOneObjectName": "专业税务顾问",
"invoiceTaxCode": "3040603020000000000",
"invoiceTwoObjectName": "专业税务顾问",
"itemType": 1,
"itemTypeName": "专业服务",
"serviceType": [
{
"name": "财务/审计/税务服务",
"id": 2
}
],
"taskType": 14,
"taskTypeName": "专业税务顾问"
},
{
"deliveries": [
{
"id": 3,
"name": "服务验收材料",
"type": "1"
}
],
"invoiceLevelOne": 39,
"invoiceLevelTwo": 4,
"invoiceOneObjectName": "人力资源管理咨询费",
"invoiceTaxCode": "3040803990000000000",
"invoiceTwoObjectName": "人力资源服务",
"itemType": 2,
"itemTypeName": "人力资源服务",
"serviceType": [
{
"name": "人力资源服务",
"id": 3
}
],
"taskType": 16,
"taskTypeName": "人力资源管理咨询"
},
{
"deliveries": [
{
"id": 3,
"name": "服务验收材料",
"type": "1"
}
],
"invoiceLevelOne": 41,
"invoiceLevelTwo": 4,
"invoiceOneObjectName": "代发业务服务",
"invoiceTaxCode": "3040803990000000000",
"invoiceTwoObjectName": "人力资源服务",
"itemType": 2,
"itemTypeName": "人力资源服务",
"serviceType": [
{
"name": "人力资源服务",
"id": 3
}
],
"taskType": 18,
"taskTypeName": "代发业务"
},
{
"deliveries": [
{
"id": 3,
"name": "服务验收材料",
"type": "1"
}
],
"invoiceLevelOne": 43,
"invoiceLevelTwo": 4,
"invoiceOneObjectName": "其他人力资源服务",
"invoiceTaxCode": "3040803990000000000",
"invoiceTwoObjectName": "人力资源服务",
"itemType": 2,
"itemTypeName": "人力资源服务",
"serviceType": [
{
"name": "人力资源服务",
"id": 3
}
],
"taskType": 20,
"taskTypeName": "其他人力资源服务"
},
{
"deliveries": [
{
"id": 3,
"name": "服务验收材料",
"type": "1"
}
],
"invoiceLevelOne": 44,
"invoiceLevelTwo": 4,
"invoiceOneObjectName": "劳务服务费",
"invoiceTaxCode": "3040803990000000000",
"invoiceTwoObjectName": "人力资源服务",
"itemType": 2,
"itemTypeName": "人力资源服务",
"serviceType": [
{
"name": "人力资源服务",
"id": 3
}
],
"taskType": 21,
"taskTypeName": "劳务服务"
},
{
"deliveries": [
{
"id": 3,
"name": "服务验收材料",
"type": "1"
}
],
"invoiceLevelOne": 46,
"invoiceLevelTwo": 4,
"invoiceOneObjectName": "人力资源外包服务费",
"invoiceTaxCode": "3040803990000000000",
"invoiceTwoObjectName": "人力资源服务",
"itemType": 2,
"itemTypeName": "人力资源服务",
"serviceType": [
{
"name": "人力资源服务",
"id": 3
}
],
"taskType": 23,
"taskTypeName": "人力资源外包"
},
{
"deliveries": [
{
"id": 1,
"name": "测试及验收报告",
"type": "1"
}
],
"invoiceLevelOne": 193,
"invoiceLevelTwo": 1,
"invoiceOneObjectName": "专业技术服务",
"invoiceTaxCode": "3040105000000000000",
"invoiceTwoObjectName": "研发和技术服务",
"itemType": 1,
"itemTypeName": "专业服务",
"serviceType": [
{
"name": "学术/科研服务",
"id": 16
}
],
"taskType": 170,
"taskTypeName": "专业技术服务"
},
{
"deliveries": [
{
"id": 1,
"name": "测试及验收报告",
"type": "1"
}
],
"invoiceLevelOne": 194,
"invoiceLevelTwo": 1,
"invoiceOneObjectName": "合同能源管理服务",
"invoiceTaxCode": "3040103000000000000",
"invoiceTwoObjectName": "研发和技术服务",
"itemType": 1,
"itemTypeName": "专业服务",
"serviceType": [
{
"name": "企业服务",
"id": 4
}
],
"taskType": 171,
"taskTypeName": "合同能源管理"
},
{
"deliveries": [
{
"id": 1,
"name": "测试及验收报告",
"type": "1"
}
],
"invoiceLevelOne": 195,
"invoiceLevelTwo": 1,
"invoiceOneObjectName": "工程勘察勘探服务",
"invoiceTaxCode": "3040104010000000000",
"invoiceTwoObjectName": "研发和技术服务",
"itemType": 11,
"itemTypeName": "房地产/建筑",
"serviceType": [
{
"name": "工程施工/勘察服务",
"id": 30
}
],
"taskType": 172,
"taskTypeName": "工程勘察勘探"
},
{
"deliveries": [
{
"id": 1,
"name": "测试及验收报告",
"type": "1"
}
],
"invoiceLevelOne": 196,
"invoiceLevelTwo": 1,
"invoiceOneObjectName": "技术咨询",
"invoiceTaxCode": "3040105000000000000",
"invoiceTwoObjectName": "研发和技术服务",
"itemType": 1,
"itemTypeName": "专业服务",
"serviceType": [
{
"name": "咨询服务",
"id": 10
}
],
"taskType": 173,
"taskTypeName": "研发技术咨询"
}
]
}
5.3企业项目信息
5.3.1发布项目
- 说明
企业发布任务首先需要具有对应的项目,发布项目时需要注意的事项如下:
1.园区编码:请确保上传本企业支持的园区编码(园区信息查询接口),不同的园区账号是不一样的,充值时要注意充值账号要与项目的分包园区相对应,否则将无法向完成任务的自由职业者进行支付;
2.项目类型:同园区编码,只允许上送本企业支持的项目类型,不同的项目类型所包含的任务类型是不一样的,请根据分包业务实际场景在支持的范围内,上传正确的项目类型;
3.项目名称:同一个企业的项目名称不可以重复。请注意不要创建灵活用工业务法律法规不允许的项目,项目名称需要具有实际的业务意义,不允许随意命名;
4.任务名称:同一个企业的任务名称不可以重复。请注意需要上送具有实际业务意义的任务名称;
5.任务类型:同项目类型,只允许上送本企业支持的任务类型。平台实际分包业务完成,企业向自由职业者进行结算后,平台根据任务类型及其相对应的结算金额开具相应额度的发票;
6.招募模式:API接口当前版本仅支持定向招募,需要自由招募请登录动鑫云工场管理系统进行任务发布;
7.交付模式:API接口当前版本仅支持统一上传交付物。
一个项目可支持多个任务。每个任务可根据项目和任务的交付特点向已经完成任务的自由职业者进行结算。项目和任务不支持更改。若有新的业务场景,需要重新创建项目和任务。
项目和任务分为两个事务进行处理,外部code为项目返回状态,taskInfo列表内部code为任务创建返回状态,可能会出现项目创建成功任务创建失败的情况。对接方重新创建任务需要调发布任务API去再次执行。
- 接口API
/interface/item/create
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
parkId | Long | Y | 园区编码 | ||
itemTitle | String | 50 | Y | 项目名称 | |
itemTypeId | String | 10 | Y | 项目类型编码 | |
commissionType | String | 5 | Y | 结算方式 01-日结,02-次日结,03-周结,04-月结 |
|
commissionLow | int | 14 | Y | 佣金单次结算最低值(整数,单位:分) | |
commissionHigh | int | 14 | Y | 佣金单次结算最高值(整数,单位:分) | |
itemPeriod | String | 5 | Y | 项目分期 01-不分期,02-二期,03-三期,04-不限制 |
|
firstPeriodStart | String | C | 2022-02-22 | 一期(不分期)开始时间(项目分期01时必填) | |
firstPeriodEnd | String | C | 2022-02-22 | 一期(不分期)结束时间(项目分期01时必填) | |
secondPeriodStart | String | C | 2022-02-22 | 二期开始时间(项目分期02时必填) | |
secondPeriodEnd | String | C | 2022-02-22 | 二期结束时间(项目分期02时必填) | |
threePeriodStart | String | C | 2022-02-22 | 三期开始时间(项目分期03时必填) | |
threePeriodEnd | String | C | 2022-02-22 | 三期结束时间(项目分期03时必填) | |
checkRequire | String | 5 | Y | 验收时间类型 01-定期验收,02-完结验收 |
|
checkPeriod | String | 5 | C | 定期验收频率 1-按月,2-按周,3-按日 |
|
checkDateStart | String | 10 | C | 2022-02-22 | 验收开始时间 |
checkDateEnd | String | 10 | C | 2022-02-22 | 验收结束时间 |
taskInfo | Array | N | 任务信息 |
taskInfo 任务信息
参数名 | 类型 | 是否必填 | 长度 | 示例 | 说明 |
---|---|---|---|---|---|
taskTitle | String | Y | 50 | 任务名称(同一企业 不可重复) | |
taskDesc | String | N | 2000 | 任务描述 | |
taskTypeId | String | Y | 10 | 任务类型 | |
commissionType | String | Y | 2 | 结算方式 01-日结,02-次日结,03-周结,04-月结 |
|
commissionLow | int | Y | 佣金单次结算最低值(整数,单位:分) | ||
commissionHigh | int | Y | 佣金单次结算最高值(整数,单位:分) | ||
taskPeriod | String | Y | 2 | 任务分期 01-不分期,02-二期,03-三期,04-不限制 |
|
firstPeriodStart | String | C | 2022-02-22 | 一期(不分期)开始时间(任务分期01时必填) | |
firstPeriodEnd | String | C | 2022-02-22 | 一期(不分期)结束时间(任务分期01时必填) | |
secondPeriodStart | String | C | 2022-02-22 | 二期开始时间(任务分期02时必填) | |
secondPeriodEnd | String | C | 2022-02-22 | 二期结束时间(任务分期02时必填) | |
threePeriodStart | String | C | 2022-02-22 | 三期开始时间(任务分期03时必填) | |
threePeriodEnd | String | C | 2022-02-22 | 三期结束时间(任务分期03时必填) | |
checkRequire | String | Y | 2 | 验收时间类型 01-定期验收,02-完结验收 |
|
checkPeriod | String | C | 2 | 定期验收频率 1-按月,2-按周,3-按日 |
|
checkDateStart | String | C | 10 | 2022-02-22 | 验收开始时间 |
checkDateEnd | String | C | 10 | 2022-02-22 | 验收结束时间 |
recruitType | String | Y | 2 | 招募模式 1-自由招募,2-定向招募 |
|
deliveryType | String | Y | 2 | 交付模式 1-自由职业者小程序交付,2-统一上传交付 |
|
callBackUrl | String | N | 100 | 回调 URL |
- 请求示例
{
"sign": "2312",
"signType": "MD5",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "44fdsf45dsf4s51cdfsd4s5c1",
"appid": "56523245121",
"data": {
"parkId": "2",
"businessId": "950709751405330432",
"itemTitle": "自动化项目{% mock 'increment' %}",
"commissionType": "01",
"commissionLow": "1",
"itemTypeId": "1",
"commissionHigh": "100",
"itemPeriod": "01",
"firstPeriodStart": "2022-03-01",
"firstPeriodEnd": "2022-03-30",
"secondPeriodStart": "",
"secondPeriodEnd": "",
"threePeriodStart": "",
"threePeriodEnd": "",
"checkRequire": "01",
"checkPeriod": "1",
"checkDateStart": "",
"checkDateEnd": "",
"taskInfo": [{
"taskTitle": "自动化任务{% mock 'increment' %}",
"taskTypeId": "172",
"commissionType": "01",
"commissionLow": "1",
"commissionHigh": "100",
"taskPeriod": "01",
"firstPeriodStart": "2022-03-01",
"firstPeriodEnd": "2022-03-01",
"secondPeriodStart": "",
"secondPeriodEnd": "",
"threePeriodStart": "",
"threePeriodEnd": "",
"checkRequire": "01",
"checkPeriod": "1",
"checkDateStart": "",
"checkDateEnd": "",
"recruitType": "2",
"deliveryType": "2",
"callBackUrl": "https://www.baidu.com/"
}]
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
itemId | String | 50 | Y | 项目编码 | |
itemTitle | String | 200 | Y | 项目名称 | |
taskInfo | Array | N | 任务信息 |
taskInfo 任务信息
参数名 | 类型 | 是否必填 | 长度 | 示例 | 说明 |
---|---|---|---|---|---|
taskId | String | C | 50 | 任务编码 | |
taskTitle | String | Y | 200 | 任务名称 | |
status | String | Y | 5 | 状态见下表 00-终止,01-暂停,02-待审核,03-审核通过(进行中), 04-审核拒绝,05-已失效,10-已完工,99-创建失败 |
|
code | String | C | 创建失败返回错误CODE | ||
massage | String | C | 创建失败返回错误描述 |
- 响应示例
{
"sign":"fh5bg2w6fvsUsgt+Qo+gl9sGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"code": "200",
"message": "请求成功",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"data": {
"itemId": "935610056158183421",
"itemTitle": "测试项目1",
"taskInfo": [
{
"taskId": "935595201108815872",
"taskTitle": "测试任务1",
"status": "02"
},
{
"taskId": "935595201108815871",
"taskTitle": "测试任务2",
"status": "02"
}
]
}
}
5.3.2查询企业项目信息
- 说明
查询企业发布项目及其包含任务的详细信息。
- 接口API
/interface/item/myItem
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
itemId | Long | N | 项目编码(不传默认查所有项目) | ||
businessId | String | 50 | Y | 企业编码 |
- 请求示例
{
"sign":"456126",
"signType":"MD5",
"APPID":"1235645",
"timestamp":"1645770163620",
"nonceStr":"MPzteIbCc04iSRDWxsTQ",
"reqMsgId":"394b83504cfFDSSDSedbb6af8e92417a9d6b",
"data":{
"businessId": "923947685818540032",
"itemId":"932235285394247680"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
itemId | String | 10 | Y | 项目编码 | |
itemTypeId | String | 10 | Y | 项目类型编码 | |
parkId | String | Y | 园区编码 | ||
itemTitle | String | 200 | Y | 项目名称 | |
commissionType | String | 5 | Y | 结算方式 01-日结,02-次日结,03-周结,04-月结 |
|
commissionLow | int | Y | 佣金单次结算最低值(整数,单位:分) | ||
commissionHigh | int | Y | 佣金单次结算最高值(整数,单位:分) | ||
itemPeriod | String | Y | 项目分期 01-不分期,02-二期,03-三期,04-不限制 |
||
firstPeriodStart | String | C | 2022-02-22 | 一期(不分期)开始时间(项目分期01时必填) | |
firstPeriodEnd | String | C | 2022-02-22 | 一期(不分期)结束时间(项目分期01时必填) | |
secondPeriodStart | String | C | 2022-02-22 | 二期开始时间(项目分期02时必填) | |
secondPeriodEnd | String | C | 2022-02-22 | 二期结束时间(项目分期02时必填) | |
threePeriodStart | String | C | 2022-02-22 | 三期开始时间(项目分期03时必填) | |
threePeriodEnd | String | C | 2022-02-22 | 三期结束时间(项目分期03时必填) | |
checkRequire | String | 5 | Y | 验收时间类型 01-定期验收,02-完结验收 |
|
checkPeriod | String | 5 | C | 定期验收频率 1-按月,2-按周,3-按日 |
|
checkDateStart | String | 10 | C | 2022-02-22 | 验收开始时间 |
checkDateEnd | String | 10 | C | 2022-02-22 | 验收结束时间 |
taskInfo | Array | N | 任务信息 |
taskInfo 任务信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
taskId | String | 50 | Y | 任务编码 | |
taskTitle | String | 200 | 任务名称(同一企业 不可重复) | ||
taskTypeId | String | 10 | Y | 任务类型 | |
commissionType | String | 5 | Y | 结算方式 01-日结,02-次日结,03-周结,04-月结 |
|
commissionLow | int | Y | 佣金单次结算最低值(整数,单位:分) | ||
commissionHigh | int | Y | 佣金单次结算最高值(整数,单位:分) | ||
taskPeriod | String | Y | 任务分期 01-不分期,02-二期,03-三期,04 不限制 |
||
firstPeriodStart | String | 10 | C | 2022-02-22 | 一期(不分期)开始时间(任务分期01时必填) |
firstPeriodEnd | String | 10 | C | 2022-02-22 | 一期(不分期)结束时间(任务分期01时必填) |
secondPeriodStart | String | 10 | C | 2022-02-22 | 二期开始时间(任务分期02时必填) |
secondPeriodEnd | String | 10 | C | 2022-02-22 | 二期结束时间(任务分期02时必填) |
threePeriodStart | String | 10 | C | 2022-02-22 | 三期开始时间(任务分期03时必填) |
threePeriodEnd | String | 10 | C | 2022-02-22 | 三期结束时间(任务分期03时必填) |
checkRequire | String | 5 | Y | 验收时间类型 01-定期验收,02-完结验收 |
|
checkPeriod | String | 5 | C | 定期验收频率 1-按月,2-按周,3-按日 |
|
checkDateStart | String | 10 | C | 验收开始时间 | |
checkDateEnd | String | 10 | C | 验收结束时间 | |
recruitType | String | 5 | Y | 招募模式 1-自由招募,2-定向招募 |
|
deliveryType | String | 5 | Y | 交付模式 1-自由职业者小程序交付,2-统一上传交付 |
|
status | String | 5 | Y | 状态 00-终止,01-暂停,02-待审核,03-审核通过(进行中), 04-审核拒绝,05-已失效,10-完工 |
- 响应示例
{
"code": "200",
"data": {
"rows": [
{
"checkDateEnd": "",
"checkDateStart": "",
"checkRequire": "01",
"commissionHigh": 20000,
"commissionLow": 10000,
"commissionType": "01",
"firstPeriodEnd": "2022-01-26",
"firstPeriodStart": "2022-01-12",
"issueTime": "2022-01-16 11:30:12",
"itemDesc": "我公司需要开展房地产/建筑项目,项目不分期完成,预计完成时间为2022-01-12至2022-01-26,需要自由职业者提供企业服务,咨询服务,学术/科研服务,工程施工/勘察服务,工程设计服务,新闻/出版服务,计算机软件服务等服务",
"itemId": "932235285394247680",
"itemPeriod": "01",
"itemTitle": "项目发布测试2",
"itemTypeId": "11",
"itemTypeName": "房地产/建筑",
"status": "01",
"taskInfo": [
{
"checkPeriod": "2",
"checkRequire": "01",
"commissionHigh": 20000,
"commissionLow": 10000,
"commissionType": "01",
"firstPeriodEnd": "2022-01-20",
"firstPeriodStart": "2022-01-06",
"issueTime": "2022-01-16 11:30:49",
"itemPeriod": "02",
"parkId": "2",
"parkName": "uat测试园区",
"secondPeriodEnd": "2022-02-03",
"secondPeriodStart": "2022-01-20",
"status": "02",
"taskDesc": "我公司需要开展企业服务,咨询服务,学术/科研服务,工程施工/勘察服务,工程设计服务,新闻/出版服务,计算机软件服务项目,现面向自由职业者发布工程勘察勘探任务;任务二期完成,一期完成时间为2022-01-06至2022-01-20,二期完成时间为2022-01-20至2022-02-03,需要自由职业者提供咨询服务,学术/科研服务,工程施工/勘察服务,工程设计服务,新闻/出版服务,计算机软件服务,诚邀具备企业服务,咨询,学术/科研,工程施工/勘察,广告/公关/会展,技术服务,计算机服务的自由职业者",
"taskId": "932235441678209024",
"taskTitle": "任务测试2",
"taskType": "172",
"taskTypeName": "工程勘察勘探",
"verifyStandard": "按周完成任务计划规定范围内各项工作内容,提交符合行业标准和任务目标的工作成果,包括测试及验收报告等"
},
{
"checkPeriod": "1",
"checkRequire": "01",
"commissionHigh": 20000,
"commissionLow": 10000,
"commissionType": "01",
"firstPeriodEnd": "2022-01-28",
"firstPeriodStart": "2022-01-07",
"issueTime": "2022-01-20 20:55:01",
"itemPeriod": "01",
"parkId": "2",
"parkName": "uat测试园区",
"status": "03",
"taskDesc": "我公司需要开展企业服务,咨询服务,学术/科研服务,工程施工/勘察服务,计算机软件服务项目,现面向自由职业者发布工程勘察勘探任务;任务不分期完成,预计完成时间为2022-01-07至2022-01-28,需要自由职业者提供咨询服务,学术/科研服务,工程施工/勘察服务,计算机软件服务,诚邀具备企业服务,咨询,学术/科研,工程施工/勘察,广告/公关/会展,技术服务,计算机服务的自由职业者",
"taskId": "933826975498489856",
"taskTitle": "房地产任务",
"taskType": "172",
"taskTypeName": "工程勘察勘探",
"verifyStandard": "按月完成任务计划规定范围内各项工作内容,提交符合行业标准和任务目标的工作成果,包括测试及验收报告等"
}
],
"verifyStandard": "按周完成项目计划规定范围内各项工作内容,提交符合行业标准和项目目标的工作成果"
}
]
},
"message": "操作成功",
"nonceStr": "j1Y1IJYMHmxD8bMQyTsG",
"timestamp": 1646900575504
}
5.4企业任务信息
5.4.1企业发布任务信息
- 说明
企业首先需要发布项目,然后在项目下发布任务。发布任务需要平台进行审核,审核通过之后方可对任务进行自由职业者招募。其他注意事项请参考创建项目说明中与任务相关的内容。
建议对接方发布任务时,上送回调URL,这样平台在任务审核状态发生变化时,可第一时间通知对接方。
- 前置条件
已发布项目
- 接口API
/interface/task/create
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
itemId | Long | Y | 项目编码 | ||
taskTitle | String | 50 | Y | 任务名称(同一企业,不可重复) | |
taskTypeId | String | 10 | Y | 任务类型 | |
commissionType | String | 2 | Y | 结算方式 01-日结,02-次日结,03-周结,04-月结 |
|
commissionLow | int | Y | 佣金单次结算最低值(整数,单位:分) | ||
commissionHigh | int | Y | 佣金单次结算最高值(整数,单位:分) | ||
taskPeriod | String | 2 | Y | 任务分期 01-不分期,02-二期,03-三期,04-不限制 |
|
firstPeriodStart | String | C | 2022-02-22 | 一期(不分期)开始时间(任务分期01时必填) | |
firstPeriodEnd | String | C | 2022-02-22 | 一期(不分期)结束时间(任务分期01时必填) | |
secondPeriodStart | String | C | 2022-02-22 | 二期开始时间(任务分期02时必填) | |
secondPeriodEnd | String | C | 2022-02-22 | 二期结束时间(任务分期02时必填) | |
threePeriodStart | String | C | 2022-02-22 | 三期开始时间(任务分期03时必填) | |
threePeriodEnd | String | C | 2022-02-22 | 三期结束时间(任务分期03时必填) | |
checkRequire | String | 2 | Y | 验收时间类型 01-定期验收,02-完结验收 |
|
checkPeriod | String | 2 | C | 定期验收频率 1-按月,2-按周,3-按日 |
|
checkDateStart | String | 10 | C | 2022-02-22 | 验收开始时间 |
checkDateEnd | String | 10 | C | 2022-02-22 | 验收结束时间 |
recruitType | String | 2 | Y | 招募模式 1-自由招募,2-定向招募 |
|
deliveryType | String | 2 | Y | 交付模式 1-自由职业者小程序交付,2-统一上传交付 |
|
callBackUrl | String | 100 | N | 回调 URL |
- 请求示例
{
"sign": "5645612345",
"appid": "14561212",
"signType": "MD5",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiSRDWxsTQ",
"reqMsgId": "394b83504cfDFDSSDSedbb6af8e9247a9d6b",
"data": {
"businessId": "923947685818540032",
"itemId":"932235285394247680",
"taskTitle": "导出自由职业者项目22222",
"taskTypeId": "172",
"commissionType": "01",
"commissionLow": "10000",
"commissionHigh": "20000",
"taskPeriod": "04",
"firstPeriodStart": "",
"firstPeriodEnd": "",
"secondPeriodStart": "",
"secondPeriodEnd": "",
"threePeriodStart": "",
"threePeriodEnd": "",
"checkRequire": "01",
"checkPeriod": "1",
"checkDateStart": "2022-02-03",
"checkDateEnd": "2022-03-03",
"recruitType": "2",
"deliveryType": "2",
"callBackUrl": "https://www.baidu.com"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
taskId | String | 50 | Y | 任务编码 | |
taskTitle | String | 200 | Y | 任务名称(同一企业 不可重复) | |
status | String | 5 | Y | 状态 00-终止,01-暂停,02-待审核,03-审核通过(进行中), 04-审核拒绝,05-已失效,10-完工 |
- 响应示例
{
"code": "200",
"data": {
"status": "02",
"taskId": "951522764807618560",
"taskTitle": "导出自由职业者项目22222"
},
"message": "操作成功",
"nonceStr": "lGQimJKcNesNWseCfquu",
"timestamp": 1646902306251
}
5.4.2企业查询任务信息
- 说明
查询企业发布任务信息,分页返回。
- 接口API
/interface/task/mytask
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
itemId | Long | Y | 项目编码 | ||
businessId | String | 50 | Y | 企业编码 | |
taskId | String | 30 | N | 任务编码(不传默认查该项目下所有任务) |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgt+Qo+gl9s+6okHOL186+Mr+DW8eNVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "14561212",
"data": {
"itemId": "932235285394247680",
"businessId": "923947685818540032",
"taskId": "951522764807618560"
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
businessId | String | Y | 企业编码 | |
taskId | String | Y | 任务编码 | |
taskTitle | String | Y | 任务名称(同一企业 不可重复) | |
taskTypeId | String | Y | 任务类型 | |
commissionType | String | Y | 结算方式 01-日结,02-次日结,03-周结,04-月结 |
|
commissionLow | int | Y | 佣金单次结算最低值(整数,单位:分) | |
commissionHigh | int | Y | 佣金单次结算最高值(整数,单位:分) | |
taskPeriod | String | Y | 任务分期 01-不分期,02-二期,03-三期,04-不限制 |
|
firstPeriodStart | String | C | yyyy-MM-dd | 一期(不分期)开始时间(任务分期01时必填) |
firstPeriodEnd | String | C | yyyy-MM-dd | 一期(不分期)结束时间(任务分期01时必填) |
secondPeriodStart | String | C | yyyy-MM-dd | 二期开始时间(任务分期02时必填) |
secondPeriodEnd | String | C | yyyy-MM-dd | 二期结束时间(任务分期02时必填) |
threePeriodStart | String | C | yyyy-MM-dd | 三期开始时间(任务分期03时必填) |
threePeriodEnd | String | C | yyyy-MM-dd | 三期结束时间(任务分期03时必填) |
checkRequire | String | Y | 验收时间类型 01-定期验收,02-完结验收 |
|
checkPeriod | String | C | 定期验收频率 1-按月,2-按周,3-按日 |
|
checkDateStart | String | C | 验收开始时间 | |
checkDateEnd | String | C | 验收结束时间 | |
recruitType | String | Y | 招募模式 1-自由招募,2-定向招募 |
|
deliveryType | String | Y | 交付模式 1-自由职业者小程序交付,2-统一上传交付 |
|
callBackUrl | String | Y | 回调 URL | |
status | String | Y | 状态 00-终止,01-暂停,02-待审核,03-审核通过(进行中), 04-审核拒绝,05-已失效,10-完工 |
- 响应示例
{
"total": 1,
"code": "200",
"message": "操作成功",
"data": [
{
"checkPeriod": "1",
"checkRequire": "01",
"commissionHigh": 20000,
"commissionLow": 10000,
"commissionType": "01",
"issueTime": "2022-03-10 16:51:45",
"itemPeriod": "04",
"parkId": "2",
"parkName": "uat测试园区",
"status": "02",
"taskDesc": "我公司需要开展工程施工/勘察服务项目,现面向自由职业者发布工程勘察勘探任务;任务不限制完成需要自由职业者提供工程施工/勘察服务等服务,诚邀具备工程施工/勘察的自由职业者",
"taskId": "951522764807618560",
"taskTitle": "导出自由职业者项目22222",
"taskType": "172",
"taskTypeName": "工程勘察勘探",
"verifyStandard": "按月完成项目计划规定范围内各项工作内容,提交符合行业标准和项目目标的工作成果,包括测试及验收报告等"
}
],
"nonceStr": "hWb3nWROwBxh6vtiKkEC",
"timestamp": 1646902423635
}
5.4.3企业任务审核结果回调通知
- 说明
若创建任务时上送了回调URL,则在任务审核状态发生变化时,平台会自动调用回调URL通知企业。
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
taskId | String | 30 | Y | 任务编码 | |
taskTitle | String | 50 | Y | 任务名称 | |
taskTypeId | String | 10 | Y | 任务类型 | |
status | String | 2 | Y | 状态 00-终止,01-暂停,02-待审核,03-审核通过(进行中), 04-审核拒绝,05-已失效,10-完工 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"data": {
"businessId":"923947685818540032",
"taskId":"951522764807618560",
"taskTitle": "导出自由职业者项目22222"
"taskTypeId":"172",
"status":"03"
}
}
- 响应参数
code | 说明 |
---|---|
200 | 通知成功不再回调 |
非200 | 2、4、5、10、15分钟间隔回调,五次回调均无响应成功则不再进行回调 |
- 响应示例
{
"code": "200",
"message": "请求成功"
}
5.5自由职业者定向招募
5.5.1定向招募(批量)
- 说明
1.发布的任务审核通过之后,可基于此任务进行招募,当前版本API接口仅支持定向招募;
2.本接口结果通过异步方式进行调用,通过上送回调地址URL通知对接方招募结果;
3.每个批次最多支持5000条自由职业者信息。 平台根据身份证号进行重复校验,仅第一条成功;
4.定向招募包含的主要后台操有实名认证、签约、与任务关联。自由职业者首先进行实名认证,不通过则回调通知对接方,通过后则进行电子签约并与任务关联;
5.自由职业者与任务关联之后,进行工作任务,对接方在自由职业者完成任务或者达到阶段验收标准时,可对自由职业者进行结算。
- 前置条件
已发布任务
- 接口API
/interface/recruit/recruitBatch
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
taskId | String | 30 | Y | 任务编码 | |
outBatchNo | String | 200 | Y | 招募批次号,要求企业内唯一 | |
notityUrl | String | 100 | Y | 回调地址 | |
total | int | Y | 批次总笔数 | ||
freelancers | Array | Y | 招募信息 |
freelancers 招募信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
outSeqNo | String | 50 | Y | 序列号,同一个批次号中唯一 | |
name | String | 30 | Y | 姓名 | |
idno | String | 20 | Y | 身份证号,单个批次内不可重复 | |
mobile | String | 15 | Y | 电话 | |
idCardFace | String | Y | 可访问URL | 身份证照片人像面 | |
idCardEmblem | String | Y | 可访问URL | 身份证照片国徽面 | |
subAppid | String | N | 商户应用ID | ||
openid | String | N | 商户应用下对应OpenId |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d5i1OpL014550223",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"taskId":"949014714065793024",
"businessId":"923947685818540032",
"outBatchNo": "RENYJ8aN0d579i1OpL0155032",
"notityUrl":"http://47.112.129.249:12121/interfacecallback/callback",
"total":2,
"freelancers" :[
{
"name":"李珊",
"idno":"110101199003076894",
"mobile":"13000000002",
"idCardFace":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1648437243133.HEIC",
"idCardEmblem":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1648437257807.HEIC",
"subAppid":"wx978192182648",
"openid":"o-RENYJ8aN0d5i1OpL014550223"
},
{
"name":"李珊2",
"idno":"110101199003073677",
"mobile":"13000000003",
"idCardFace":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1648437243133.HEIC",
"idCardEmblem":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1648437257807.HEIC",
"subAppid":"wx978192182648",
"openid":"o-RENYJ8aN0d5i1OpL014550223"
}
]
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
code | String | Y | 返回状态编码 | |
massage | String | Y | 返回状态描述 |
- 响应示例
{
"code": "200",
"data": "951848379804172288",
"message": "操作成功",
"nonceStr": "Fbycg0v73fGECOL4Tyh3",
"timestamp": 1646979939211
}
5.5.2 定向招募(单个)
- 说明
针对单个自由职业者进行招募,为批量招募的补充接口。本接口实时(同步)返回招募结果信息。
返回签约链接需联系运营配置 图片建议压缩,接口响应速度与图片大小成正比 若您需要使用微信小程序签约,请在上线之前与我们联系处理跨域问题- 前置条件
已发布任务
- 接口API
/interface/recruit/recruitOne
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
taskId | String | 30 | Y | 任务编码 | |
outBatchNo | String | 200 | Y | 招募批次号,要求企业内唯一 | |
name | String | 30 | Y | 自由职业者姓名 | |
idno | String | 20 | Y | 自由职业者证件号码 | |
mobile | String | 15 | Y | 电话 | |
idCardFace | String | Y | Base64图片(图片不能大于2M)/可访问URL | 身份证人像面 | |
idCardEmblem | String | Y | Base64图片(图片不能大于2M)/可访问URL | 身份证国徽面 | |
isUrl | String | N | 是否返回签约URL 若配置签约方式是发送签约短信,该参数使用 “1” 则会返回签约使用的URL | ||
redirectUrl | String | N | 签约后跳转页面地址 | ||
subAppid | String | N | 商户应用ID | ||
openid | String | N | 商户应用下对应OpenId |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "RENYJ8aN0d579i1OpL01455028",
"appid": "111",
"timestamp": "1645770163620",
"businessId": "923947685818540032",
"data": {
"taskId": "925394812432265216",
"outBatchNo": "RENYJ8aN0d579i1OpL01455028",
"name": "测试09",
"idno": "450329197504076135",
"mobile": "13000000002",
"subAppid":"wx978192182648",
"openid":"o-RENYJ8aN0d5i1OpL014550223"
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
code | String | Y | 返回状态编码 | |
massage | String | Y | 返回状态描述 | |
data | String | Y | 业务数据 |
data
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
signUrl | String | N | 签约合同链接或已签约查看合同链接 | |
signDownloadUrl | String | N | 已签约的会返回合同下载链接 | |
hasSign | String | Y | 签约状态 0-未签约,1-已签约,2-已解约 |
|
idCardPic | String | Y | 是否有身份证照片 1-已有 0- 没有 |
- 响应示例
{
"code": "200",
"data": {
"hasSign": "0",
"signUrl": "https://textapi26.fadada.com/api2//viewdocs.action?app_id=501568×tamp=20220421114359&v=2.0&msg_digest=NjgwQTY0RTA3NTVBNzU5MDdFNTJEQjRGQUE4NkVEQTI5MjJBOTZENA==&transaction_id=966665479453499392&send_app_id=null"
},
"appid": "959767136190091264",
"signType": "RSA",
"message": "签约成功",
"nonceStr": "bIPRstPcP0RPCsQTesci",
"timestamp": "1645770163620",
"reqMsgId": "4c4f1dss45ds1ssd4544sscs5f1ssc"
}
5.5.3批量结算
- 说明
自由职业者完成企业发布的任务或者达到任务阶段性验收标准,企业验收后通过此接口对自由职业者发起结算。结算需要注意的事项如下:
1.结算结果平台通过异步回调的方式通知对接方,需要对接方上送回调URL地址;
2.批量结算每个批次最多支持5000条;
3.每条结算金额不可超过企业账号所归属支付通道(银行)的单笔限额(账户查询接口);
4.结算自由职业者账户必须是自由职业者本人的银行卡或者支付宝账户;
5.结算时平台将服务费和结算费用一起扣除。若企业账户余额不足,则整个批次无法发起支付,结算单自动关闭。
6.单笔不得超过银行打款限额,超过限额需自行拆单,限额请在5.1.2 入驻结果查询- 前置条件
1.企业对已发布任务;
2.招募自由职业者;
3.完成签约。
- 接口API
/interface/settle/settleBatch
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
taskId | String | 30 | Y | 任务编码 | |
acctNo | String | 40 | Y | 结算子账户 | |
outBatchNo | String | 200 | Y | 结算批次号,要求企业内唯一 | |
notityUrl | String | 100 | Y | 回调地址 | |
clearingForm | String | 100 | Y | 结算方式(1:接口立即结算,2:页面操作结算) | |
totalSettleFee | int | Y | 批次总金额(整数,单位:分) | ||
total | int | Y | 批次总笔数 | ||
freelancers | Array | Y | 结算信息 |
freelancers 结算信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
outSeqNo | String | 50 | Y | 同一批次交易里面,序列号不允许重复 | |
name | String | 30 | 姓名 | ||
idno | String | 20 | Y | 自由职业者身份证 | |
acctNo | String | 40 | Y | 银行账号/支付宝账号/微信OpenId | |
bankName | String | 30 | N | 银行名称/商户名称 | |
settleFee | int | Y | 结算金额(整数,单位:分) | ||
remark | String | 200 | N | 备注 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "RENYJ8aN0d579i1OpL01455015",
"appid": "111",
"timestamp": "1645770163620",
"data": {
"businessId": "923947685818540032",
"taskId": "925394812432265216",
"acctNo": "30206465066036",
"outBatchNo": "RENYJ8aN0d579i1OpL01455015",
"notityUrl": "http://47.112.129.249:12121/callback/callback",
"totalSettleFee": 20,
"total": 2,
"freelancers": [{
"name": "测试09",
"idno": "450329197504076135",
"outSeqNo": "11908013708393840654",
"acctNo": "6222849380986918",
"settleFee": 10,
"remark": ""
},
{
"name": "测试10",
"idno": "51132519510718598X",
"outSeqNo": "11908013708393840655",
"acctNo": "6222849422929926",
"settleFee": 10,
"remark": ""
}
]
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
code | String | Y | 返回状态编码 | |
massage | String | Y | 返回状态描述 |
- 响应示例
{
"code": "200",
"message": "招募成功"
}
5.5.4定向招募&批量结算
- 说明
批量招募与批量结算的合并接口,先进行批量招募然后自动进行批量结算。
单笔不得超过银行打款限额,超过限额需自行拆单了,限额请在5.1.2 入驻结果查询- 接口API
/interface/recruit/recruitSettleBatch
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
taskId | String | 30 | Y | 任务编码 | |
outBatchNo | String | 200 | Y | 招募批次号,要求企业内唯一 | |
acctNo | String | 40 | Y | 支付账号 | |
notityUrl | String | 100 | N | 回调URL | |
clearingForm | String | 100 | Y | 结算方式(1:接口立即结算,2:页面操作结算) | |
totalSettleFee | long | Y | 结算金额(整数,单位:分) | ||
total | int | Y | 结算笔数 | ||
freelancers | array | Y | 自由职业者信息 |
freelancers 自由职业者信息
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
outSeqNo | String | Y | 序列号,同一个批次号中唯一 | |
name | String | Y | 姓名 | |
idno | String | Y | 自由职业者信息 | |
mobile | String | Y | 电话 | |
acctNo | String | Y | 银行卡号或支付宝账号或微信OpenId | |
settleFee | long | Y | 结算金额(整数,单位:分) | |
remark | String | N | 备注 | |
idCardFace | String | Y | Base64图片(图片不能大于2M)/可访问URL | 身份证照片人像面 |
idCardEmblem | String | Y | Base64图片(图片不能大于2M)/可访问URL | 身份证照片国徽面 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455088",
"appid":"111",
"timestamp":"1645770163620",
"businessId":"923947685818540032",
"data":{
"taskId":"925394812432265216",
"acctNo":"30206465066036",
"outBatchNo": "RENYJ8aN0d579i1OpL01455088",
"notityUrl":"http://47.112.129.249:12121/callback/callback",
"totalSettleFee":20,
"total":2,
"freelancers":[
{
"name":"测试09",
"idno":"450329197504076135",
"outSeqNo":"11908013708393840654",
"mobile":"15000000000",
"acctNo":"6222849380986918",
"settleFee":10,
"idCardFace":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1648437243133.HEIC",
"idCardEmblem":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1648437257807.HEIC",
"remark":""
},
{
"name":"测试10",
"idno":"51132519510718598X",
"outSeqNo":"11908013708393840655",
"acctNo":"6222849422929926",
"mobile":"15000000001",
"settleFee":10,
"idCardFace":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1648437243133.HEIC",
"idCardEmblem":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/web/file1648437257807.HEIC",
"remark":""
}
]
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
code | String | Y | 状态码 | |
message | String | Y | 状态描述 |
- 响应示例
{
"code": "200",
"data": "951848379804172288",
"message": "操作成功",
"nonceStr": "Fbycg0v73fGECOL4Tyh3",
"timestamp": 1646979939211
}
5.5.5定向招募结果查询
- 说明
可根据任务ID 和批次号进行查询,若批次号为空则返回指定任务招募成功的自由职业者信息,若批次号不为空,则分会指定批次的招募详情。返回结果分页。
若任务编号为空,则返回该企业已关联的所有自由职业者
- 接口API
/interface/recruit/queryBatch
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
taskId | String | 30 | N | 任务编码 | |
outBatchNo | String | 200 | 批次号 | ||
pageNum | int | 当前页码,不填默认为1 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455088",
"appid":"952212545266184192",
"timestamp":"1645770163620",
"data":{
"businessId":"950709751405330432",
"taskId":"954313364803301376",
"outBatchNo":"230000198903172903"
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
data | Object | Y | 返回的业务数据 |
data 参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
total | Int | Y | 总条数 | |
rows | array | Y | 数据数组 |
rows 参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
name | String | 30 | Y | 姓名 | |
idno | String | 20 | Y | 身份证号 | |
mobile | String | 15 | Y | 电话 | |
message | String | 500 | Y | 信息 | |
hasAuth | String | 5 | Y | 实名认证状态 | |
authTime | String | 20 | N | 实名认证时间 | |
hasSign | String | 5 | Y | 签约状态 0-未签约,1-已签约,2-已解约 |
|
signChannel | String | 20 | N | 签约渠道 | |
signContractUrl | String | N | 合同查看链接 | ||
signType | String | 5 | N | 签约类型 | |
signTime | String | 20 | N | 签约时间 | |
status | String | 5 | Y | 招募状态 1-招募成功,0-招募失败 |
|
idCardPic | String | 1 | N | 是否有身份证照片 1-已有 0-未有 |
- 响应示例
{
"code": "200",
"data": {
"total": 10,
"rows": [
{
"authTime": "2022-03-31 11:48:25",
"hasAuth": "2",
"hasSign": "1",
"idno": "110101200503070195",
"mobile": "15000000000",
"name": "杨艳",
"signChannel": "01",
"signContractUrl": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/bblg2021/pdf/%E6%9D%A8%E8%89%B3-110101200503070195-20220331114828.pdf?Expires=1964058509&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=MPHTW3wNr0ODOcrVidiLUyYQAhE%3D",
"signTime": "2022-03-31 11:48:30",
"signType": "3",
"status": "1"
},
{
"idno": "110101200503074639",
"mobile": "15000000000",
"msg": "与现有姓名[顾芳]不匹配",
"name": "张三",
"status": "0"
},
{
"authTime": "2022-03-31 11:25:25",
"hasAuth": "2",
"hasSign": "1",
"idno": "110101200503076095",
"mobile": "15000000000",
"name": "江芳",
"signChannel": "01",
"signContractUrl": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/bblg2021/pdf/%E6%B1%9F%E8%8A%B3-110101200503076095-20220331112534.pdf?Expires=1964057136&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=cNzaWLWyMhnCKvBC6E5oh6Zmhr8%3D",
"signTime": "2022-03-31 11:25:36",
"signType": "3",
"status": "1"
},
{
"authTime": "2022-03-31 11:25:25",
"hasAuth": "2",
"hasSign": "1",
"idno": "110101200503073978",
"mobile": "15000000000",
"name": "秦涛",
"signChannel": "01",
"signContractUrl": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/bblg2021/pdf/%E7%A7%A6%E6%B6%9B-110101200503073978-20220331112537.pdf?Expires=1964057137&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=Q1BzciH8oqt1ETt0kY2kXuBWlws%3D",
"signTime": "2022-03-31 11:25:38",
"signType": "3",
"status": "1"
},
{
"authTime": "2022-03-31 11:25:25",
"hasAuth": "2",
"hasSign": "1",
"idno": "110101200503076837",
"mobile": "15000000000",
"name": "高艳",
"signChannel": "01",
"signContractUrl": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/bblg2021/pdf/%E9%AB%98%E8%89%B3-110101200503076837-20220331112538.pdf?Expires=1964057139&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=kwA5bOxUC09FFaASrH9Xe%2BGJen8%3D",
"signTime": "2022-03-31 11:25:40",
"signType": "3",
"status": "1"
},
{
"authTime": "2022-03-31 11:25:25",
"hasAuth": "2",
"hasSign": "1",
"idno": "110101200503072158",
"mobile": "15000000000",
"name": "汤勇",
"signChannel": "01",
"signContractUrl": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/bblg2021/pdf/%E6%B1%A4%E5%8B%87-110101200503072158-20220331112537.pdf?Expires=1964057137&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=vnWYilk56NcCfsAtoSX6SjnlXQM%3D",
"signTime": "2022-03-31 11:25:38",
"signType": "3",
"status": "1"
},
{
"authTime": "2022-03-31 11:25:25",
"hasAuth": "2",
"hasSign": "1",
"idno": "110101200503071470",
"mobile": "15000000000",
"name": "廖军",
"signChannel": "01",
"signContractUrl": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/bblg2021/pdf/%E5%BB%96%E5%86%9B-110101200503071470-20220331112538.pdf?Expires=1964057139&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=ExQB7ls0%2BKJDuf939OabBJ6dtuo%3D",
"signTime": "2022-03-31 11:25:40",
"signType": "3",
"status": "1"
},
{
"authTime": "2022-03-31 11:25:25",
"hasAuth": "2",
"hasSign": "1",
"idno": "110101200503077434",
"mobile": "15000000000",
"name": "贾涛",
"signChannel": "01",
"signContractUrl": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/bblg2021/pdf/%E8%B4%BE%E6%B6%9B-110101200503077434-20220331112540.pdf?Expires=1964057141&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=sKXICfH2HYfPPKR0lIXQBPj7bBk%3D",
"signTime": "2022-03-31 11:25:41",
"signType": "3",
"status": "1"
},
{
"authTime": "2022-03-31 11:25:25",
"hasAuth": "2",
"hasSign": "1",
"idno": "110101200503077258",
"mobile": "15000000000",
"name": "万洋",
"signChannel": "01",
"signContractUrl": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/bblg2021/pdf/%E4%B8%87%E6%B4%8B-110101200503077258-20220331112542.pdf?Expires=1964057142&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=qjAMPbM%2FIJFd6DA3iMsS773HjZs%3D",
"signTime": "2022-03-31 11:25:43",
"signType": "3",
"status": "1"
},
{
"authTime": "2022-03-31 11:25:25",
"hasAuth": "2",
"hasSign": "1",
"idno": "110101200503075199",
"mobile": "15000000000",
"name": "陆刚",
"signChannel": "01",
"signContractUrl": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/bblg2021/pdf/%E9%99%86%E5%88%9A-110101200503075199-20220331112540.pdf?Expires=1964057141&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=BlNqPDLzFu3oM4aSwFdDJ47GUY0%3D",
"signTime": "2022-03-31 11:25:41",
"signType": "3",
"status": "1"
}
]
},
"appid": "952212545266184192",
"signType": "RSA",
"message": "操作成功",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"timestamp": "1645770163620",
"reqMsgId": "RENYJ8aN0d579i1OpL01455088"
}
5.5.6批量结算结果查询
- 说明
按批次查询结算结果
- 接口API
/interface/settle/queryBatch
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outBatchNo | String | 200 | Y | 结算批次号,要求企业内唯一 | |
outSeqNo | String | 50 | N | 批次内序列号 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"outBatchNo": "RENYJ8aN0d579i1OpL01455015"
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
code | String | Y | 状态代码 | |
message | String | Y | 状态描述 | |
data | Object | Y | 业务数据对象 |
data 业务数据对象
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outBatchNo | String | 200 | Y | 结算批次号,企业内唯一 | |
taskId | String | 30 | Y | 任务编码 | |
acctNo | String | 40 | Y | 结算子账户 | |
successSettleFee | long | Y | 成功金额(整数,单位:分) | ||
serviceFee | long | Y | 服务费(整数,单位:分) | ||
successNum | int | Y | 成功数量 | ||
failNum | int | Y | 失败金额(整数,单位:分) | ||
freelancers | array | Y | 结算自由职业者信息 |
freelancers 结算自由职业者信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 | |
---|---|---|---|---|---|---|
outSeqNo | String | 50 | Y | 同一批次交易里面,序列号唯一 | ||
name | String | 30 | Y | 姓名 | ||
idno | String | 20 | Y | 自由职业者信息 | ||
mobile | String | 15 | Y | 电话 | ||
acctNo | String | 40 | Y | 银行账号/支付宝账号/微信OpenId | ||
settleFee | long | Y | 结算金额(整数,单位:分) | |||
serviceRate | String | N | 服务费率(四位小数) | |||
serviceFee | long | N | 服务费(整数,单位:分) | |||
bjServiceFee | long | N | 补缴服务费(整数,单位:分) | |||
status | String | 5 | Y | 支付状态 0-失败,1-成功,2-支付中 |
||
msg | String | 200 | N | 失败原因或成功描述 | ||
remark | String | 200 | N | 备注 |
- 响应示例
{
"code": "200",
"message": "操作成功",
"data": {
"businessId": "923947685818540032",
"outBatchNo": "RENYJ8aN0d579i1OpL01455015",
"acctNo": "30206465066036",
"serviceFee": 0,
"successNum": 0,
"successSettleFee": 0,
"taskId": "925394812432265216",
"total": 2,
"totalSettleFee": 20
"failNum": 0,
"freelancers": [{
"acctNo": "6222849380986918",
"bankName": "交通银行",
"bjServiceFee": 0,
"idno": "450329197504076135",
"mobile": "17726758405",
"name": "测试09",
"outBatchNo": "RENYJ8aN0d579i1OpL01455015",
"remark": "",
"serviceFee": 1,
"serviceRate": 6,
"settleFee": 10,
"status": "01"
},
{
"acctNo": "6222849422929926",
"bankName": "交通银行",
"bjServiceFee": 0,
"idno": "51132519510718598X",
"mobile": "13299923010",
"name": "测试10",
"outBatchNo": "RENYJ8aN0d579i1OpL01455015",
"remark": "",
"serviceFee": 1,
"serviceRate": 6,
"settleFee": 10,
"status": "01"
}
]
}
}
5.5.7招募结算回调
- 说明
当招募、结算失败或者成功时,平台会自动根据对接方上送的回调URL地址发送回调请求,通知对接方招募或结算的动态信息、若失败则停止后续操作。
- 接口API
批量招募、批量结算、批量招募&结算 上送数据中的回调URL。
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
outBatchNo | String | 200 | Y | 结算批次号,企业内唯一 | |
outSeqNo | String | 50 | Y | 同一批次交易里面,序列号唯一 | |
name | String | 30 | Y | 自由职业者姓名 | |
idno | String | 20 | Y | 自由职业者身份证号 | |
mobile | String | 15 | N | 自由职业者联系方式 | |
status | String | 2 | Y | 状态 1-成功,0-失败 |
|
msg | String | 200 | N | 描述 | |
settleFee | long | N | 结算金额(整数,单位:分) | ||
serviceRate | long | N | 服务费率(四位小数) | ||
serviceFee | long | N | 服务费(整数,单位:分) | ||
bjServiceFee | long | N | 补缴服务费(整数,单位:分) |
- 请求示例
{
"outBatchNo": "QrIe8t8aN0d579i1OpL0145510",
"outSeqNo":"AERFE454A5FA55645465AW",
"name": "测试09",
"idno": "450329197504076135",
"status": "02",
"acctNo": "6222849380986918",
"serviceFee": 1,
"settleFee": 10,
"serviceRate": 6,
"bjServiceFee": 0,
"msg": "模拟交易成功"
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
code | String | Y | 状态代码 | |
message | String | Y | 状态描述 |
- 响应示例
{
"code": "200",
"message": "成功"
}
5.5.8 签约回调
- 说明
当自由职业者使用短信完成签约时,通过该回调通知对接方
- 接口API
任何在该企业下自由职业者完成签约均会出发该回调
- 请求参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
businessId | String | Y | 企业编码 | |
name | String | Y | 自由职业者姓名 | |
idNo | String | Y | 自由职业者身份证号 | |
hasSign | String | Y | 签约状态 0-未签约,1-已签约,2-已解约 |
|
viewContractUrl | String | Y | 合同签约链接或合同预览链接 | |
downloadContractUrl | String | Y | 合同下载链接 |
- 请求示例
{
"data": {
"viewContractUrl": "https://testapi.fadada.com:8443/api//viewdocs.action?app_id=405769×tamp=20220425094748&v=2.0&msg_digest=OEU4QThDQ0VDNkEzNzM0MEM0QTJGQzBDNTEyOTBDMjRGMEYxMUMyRQ==&transaction_id=968085413812236288&send_app_id=null",
"name": "陈玲",
"businessId": "956855132958670848",
"idNo": "320304196507150846",
"hasSign": "1"
},
"appid": "964132147940167680",
"nonceStr": "8lx1e25aum3rD1jwWW3v",
"reqMsgId": "968086072028557312",
"timestamp": "1650851305870"
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
code | String | Y | 状态代码 | |
message | String | Y | 状态描述 |
- 响应示例
{
"code": "200",
"message": "成功"
}
5.5.9 自由职业者签约查询
- 说明
在签约前使用该接口确认签约状态
接口API
/interface/recruit/signFind
请求参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
businessId | String | Y | 企业编码 | |
idNo | String | Y | 自由职业者身份证号 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"idNo": "210681199803070397"
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
data | Y | 返回业务数据 |
data参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
businessId | String | Y | 企业编码 | |
idNo | String | Y | 身份证号 | |
sign | String | Y | 签约状态 0-未签约;1-已签约;2-已解约 | |
signUrl | String | N | 签约链接 | |
idCardPic | String | Y | 是否有身份证照片 1-已有 0- 没有 |
- 响应示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "RENYJ8aN0d579i1OpL01455015",
"appid": "111",
"timestamp": "1645770163620",
"data": {
"businessId": "923947685818540032",
"idNo": "210681199803070397",
"sign": "1",
"signUrl": "https://testapi.fadada.com:8443/api//viewdocs.action?app_id=405769×tamp=20220425094748&v=2.0&msg_digest=OEU4QThDQ0VDNkEzNzM0MEM0QTJGQzBDNTEyOTBDMjRGMEYxMUMyRQ==&transaction_id=968085413812236288&send_app_id=null"
}
}
5.6查询企业账户信息
5.6.1查询企业账户信息
- 说明
查询企业账户基本信息及实时余额信息
- 接口API
/interface/acct/queryAll
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
zfCode | String | 50 | N | 支付通道 | |
acctNo | String | 40 | N | 企业子账户 | |
parkId | Long | N | 园区编码 | ||
status | String | N | 状态 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"appid": "156412124",
"timestamp": "1645770163620",
"nonceStr":"ID0tIWCsDJRWRzRJteJe",
"reqMsgId":"s5cd5c14dd5544d4dd5ssff54s1",
"data": {
"businessId": "950687944577482752",
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
zfCode | String | 30 | N | 支付渠道编码 | |
acctNo | String | 40 | Y | 账户 | |
acctName | String | 100 | Y | 账户名 | |
bankName | String | 100 | Y | 银行名称 | |
status | String | 5 | Y | 账户状态 1-正常,0-冻结 |
|
balanceFee | int | Y | 账户可用余额(整数,单位:分) | ||
frozenFee | int | Y | 账户冻结金额(整数,单位:分) | ||
unBalanceFee | int | Y | 账户不可用余额(整数,单位:分) | ||
limitFee | long | Y | 单笔最大限额(整数,单位:分) |
- 响应示例
{
"code": "200",
"data": [
{
"acctNo": "30206465066100",
"zfCode": "pa_pay",
"unBalanceFee": 200000,
"balanceFee": 400000,
"frozenFee": 0,
"bankName": "前端数据支持测试江西讫酉有限公司",
"acctName": "北京接口科技有限公司",
"status": "1"
}
],
"message": "操作成功",
"nonceStr": "S3b7Xbaz926fEi6DGZqk",
"timestamp": 1646910950753
}
5.6.2查询企业账户流水
- 说明
查询企业账户流水,结算流水返回批次统计数据,同个批次返回一条结算金额统计和服务费统计信息。结算发放明细通过下个接口调用查询,分页返回。
- 接口API
/interface/acct/tranHist
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
acctNo | String | 40 | N | 企业子账户 | |
dealType | String | 5 | N | 账户交易类型 详见《账户交易类型字典》 |
|
startTime | String | 20 | Y | yyyy-MM-dd hh:mm:ss | 起始时间 |
endTime | String | 20 | Y | yyyy-MM-dd hh:mm:ss | 结束时间 |
pageNum | int | N | 默认为1 | 页码 |
- 请求示例
{
"sign": "dsfdsfdsgsdfds",
"signType": "MD5",
"appid": "156412121",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiS9DWxsTQ",
"reqMsgId": "394b83504cfDFuSSDSedbb6af8e9247a9d64",
"data": {
"businessId": "923947685818540032",
"startTime": "2021-06-07 15:02:01",
"endTime": "2022-09-03 15:02:01",
"pageNum": "1"
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
data | Object | Y | 业务数据 |
data 业务数据
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
total | Int | Y | 总条数 | |
rows | Array | Y | 数据数组 |
rows 数据数组
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
acctNo | String | Y | 企业子账号 | |
balance | String | Y | 交易后可用余额(整数,单位:分) | |
dealFee | String | Y | 交易金额(整数,单位:分) | |
dealTime | String | Y | 交易时间 | |
dealType | String | Y | 账户交易类型 详见《账户交易类型字典》 |
|
isDeal | String | Y | 是否需要处理 1-处理,0-不处理 |
|
parkId | String | Y | 园区编码 | |
uNBalance | String | Y | 交易后不可用余额(整数,单位:分) | |
zfCode | String | Y | 支付通道编码 | |
counterpartyAcctName | String | Y | 对方账户账户名称 | |
counterpartyAcctNo | String | Y | 对方账户账户 | |
counterpartyBankName | String | Y | 对方账户银行名称 |
- 响应示例
{
"code": "200",
"data": {
"total": 30,
"rows": [
{
"acctNo": "30206465066117",
"balance": 1000,
"counterpartyAcctName": "上海麦克风文化传媒有限公司",
"counterpartyAcctNo": "6212261901014812729",
"counterpartyBankName": "中国工商银行",
"dealFee": 1000,
"dealId": "Z952175609189158912",
"dealTime": "2022-03-12 00:00:00",
"dealType": "01",
"isDeal": "0",
"parkId": 2,
"uNBalance": 0,
"zfCode": "pa_pay"
},
{
"acctNo": "30206465066117",
"balance": 1001000,
"counterpartyAcctName": "上海麦克风文化传媒有限公司",
"counterpartyAcctNo": "6212261901014812729",
"counterpartyBankName": "中国工商银行",
"dealFee": 1000000,
"dealId": "Z952226879182655488",
"dealTime": "2022-03-12 00:00:00",
"dealType": "01",
"isDeal": "0",
"parkId": 2,
"uNBalance": 0,
"zfCode": "pa_pay"
},
{
"acctNo": "30206465066117",
"balance": 997505.3,
"dealFee": 3300,
"dealId": "95223182655713689604",
"dealTime": "2022-03-12 15:49:32",
"dealType": "04",
"isDeal": "0",
"parkId": 2,
"uNBalance": 0,
"zfCode": "pa_pay"
},
{
"acctNo": "30206465066117",
"balance": 997505.3,
"counterpartyAcctName": "手续费子账户",
"counterpartyAcctNo": "30206465001112",
"dealFee": 194.7,
"dealId": "95223182655713689603",
"dealTime": "2022-03-12 15:49:32",
"dealType": "03",
"isDeal": "0",
"parkId": 2,
"uNBalance": 0,
"zfCode": "pa_pay"
},
{
"acctNo": "30206465066117",
"balance": 1997505.3,
"counterpartyAcctName": "上海麦克风文化传媒有限公司",
"counterpartyAcctNo": "6212261901014812729",
"counterpartyBankName": "中国工商银行",
"dealFee": 1000000,
"dealId": "Z952274925920636928",
"dealTime": "2022-03-12 00:00:00",
"dealType": "01",
"isDeal": "0",
"parkId": 2,
"uNBalance": 0,
"zfCode": "pa_pay"
}
]
},
"appid": "952156277277065216",
"signType": "MD5",
"message": "操作成功",
"nonceStr": "Izs00tWtWcWsTzxbWCRs",
"timestamp": "1645770163620",
"reqMsgId": "15d4sscs5sdffsf4s1c5ds54ddcf"
}
5.6.3查询结算明细
- 说明
查询企业账户发放明细流水
- 接口API
/interface/acct/settleHist
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
acctNo | String | 40 | N | 企业子账户 | |
startTime | String | 20 | Y | yyyy-MM-dd hh:mm:ss | 起始时间 |
endTime | String | 20 | Y | yyyy-MM-dd hh:mm:ss | 结束时间 |
pageNum | int | N | 默认为1 | 页码 |
- 请求示例
{
"sign":"dsfdsfdsgsdfds",
"signType":"MD5",
"appid":"156412121",
"timestamp":"1645770163620",
"nonceStr":"MPzteIbCc0JiSRDWxsTQ",
"reqMsgId":"394b83504cfDFDSSDSedbb6af8e9247a9d64",
"data":{
"businessId":"897186468647141376",
"startTime":"2021-06-07 00:00:00",
"endTime":"2023-09-03 23:23:23",
"pageNum":"1"
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
data | Object | Y | 返回的业务数据 |
data 业务数据
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
total | Int | Y | 总条数 | |
rows | Array | Y | 数据数组 |
rows 数据数组
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
outSeqNo | String | 50 | Y | 批次内 | |
seqNo | String | 50 | Y | 系统批次内 | |
acctNo | String | 40 | Y | 自由职业者账户 | |
name | String | 30 | Y | 自由职业者姓名 | |
mobile | String | 15 | Y | 自由职业者电话 | |
settleFee | Integer | Y | 结算金额(整数,单位:分) | ||
serviceRate | String | Y | 服务费率(四位小数) | ||
serviceFee | Integer | Y | 服务费(整数,单位:分) | ||
bjServiceFee | Integer | Y | 补缴服务费(整数,单位:分) | ||
status | String | 5 | Y | 支付状态 见下表 | |
msg | String | 200 | N | 支付信息 | |
remark | String | 200 | N | 备注 | |
limitLevel | String | 5 | Y | 大小额限制 1-小额,2-大额 |
- 响应示例
{
"code": "200",
"data": {
"total": 24,
"rows": [
{
"acctNo": "6212261901014812729",
"bjServiceFee": 0,
"idno": "430521199805246631",
"mobile": "15678922063",
"msg": "模拟交易成功",
"name": "xx",
"outSeqNo": "O202203121548000001",
"remark": "测试123456",
"seqNo": "952231873877274624",
"serviceFee": 1180,
"serviceRate": "0.0590",
"settleFee": 20000,
"status": "02"
},
{
"acctNo": "6212261901014812729",
"bjServiceFee": 0,
"idno": "430521199805246631",
"mobile": "15678922063",
"msg": "模拟交易成功",
"name": "xx",
"outSeqNo": "O202203121548000002",
"remark": "测试123456",
"seqNo": "952231873877274625",
"serviceFee": 1770,
"serviceRate": "0.0590",
"settleFee": 30000,
"status": "02"
},
{
"acctNo": "6212261901014812729",
"bjServiceFee": 0,
"idno": "430521199805246631",
"mobile": "15678922063",
"msg": "模拟交易成功",
"name": "xx",
"outSeqNo": "O202203121548000003",
"remark": "测试123456",
"seqNo": "952231873877274626",
"serviceFee": 2360,
"serviceRate": "0.0590",
"settleFee": 40000,
"status": "02"
},
{
"acctNo": "6212261901014812729",
"bjServiceFee": 0,
"idno": "430521199805246631",
"mobile": "15678922063",
"msg": "模拟交易成功",
"name": "xx",
"outSeqNo": "O202203121548000004",
"remark": "测试123456",
"seqNo": "952231873877274627",
"serviceFee": 3540,
"serviceRate": "0.0590",
"settleFee": 60000,
"status": "02"
},
{
"acctNo": "6212261901014812729",
"bjServiceFee": 0,
"idno": "430521199805246631",
"mobile": "15678922063",
"msg": "模拟交易成功",
"name": "xx",
"outSeqNo": "O202203121548000005",
"remark": "测试123456",
"seqNo": "952231873877274628",
"serviceFee": 4720,
"serviceRate": "0.0590",
"settleFee": 80000,
"status": "02"
}
]
},
"appid": "952156277277065216",
"signType": "MD5",
"message": "操作成功",
"nonceStr": "J0TWMxDbibC0CDQIRQcz",
"timestamp": "1645770163620",
"reqMsgId": "4f541dsdsddfsfs45ffddf5f"
}
5.6.4企业来账通知
- 说明
企业账户充值后回调通知
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
acctNo | String | 40 | Y | 企业子账号 | |
dealFee | Long | Y | 入账金额(整数,单位:分) | ||
dealType | String | 5 | Y | 入账类型 详见《账户交易类型字典》 |
|
balance | int | Y | 账户可用余额(整数,单位:分) | ||
isDeal | String | 2 | Y | 是否需要去处理 1-是,0-否 |
|
UNBalance | int | Y | 账户不可用余额(整数,单位:分) | ||
dealTime | String | 10 | Y | 入账时间 | |
counterpartyAcctNo | String | 40 | Y | 对方账号 | |
counterpartyAcctName | String | 50 | Y | 对方账户名称 | |
counterpartyBankName | String | 200 | N | 对方银行名称 | |
dealId | String | 50 | Y | 交易流水号 | |
parkId | Long | Y | 园区编码 | ||
parkName | String | 100 | Y | 园区名称 | |
zfCode | String | 50 | Y | 支付通道编码 | |
zfName | String | 50 | Y | 支付通道名称 | |
remark | String | 200 | N | 备注 |
- 请求示例
{
"parkName": "uat测试园区",
"dealId": "Z952289579908648960",
"businessId": "952168772687507456",
"dealFee": 1000000.0,
"dealType": "01",
"counterpartyAcctNo": "6212261901014812729",
"parkId": 2,
"acctNo": "30206465066117",
"dealTime": 1647014400000,
"zfCode": "pa_pay",
"UNBalance": 0.0,
"isDeal": 0,
"counterpartyAcctName": "上海麦克风文化传媒有限公司",
"counterpartyBankName": "中国工商银行"
}
- 响应参数
code | 说明 |
---|---|
200 | 通知成功不再回调 |
非200 | 2、4、5、10、15分钟间隔回调,五次回调均无响应成功则不再进行回调 |
- 响应示例
{
"code": "200",
"message": "请求成功"
}
5.7交付
5.8开票
5.8.1可开票信息查询
- 说明
可开票信息查询
- 接口API
/interface/invoice/availableBalance
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "2022022800001",
"data": {
"businessId": "111111111"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
parkId | String | Y | 园区编码 | ||
parkName | String | 100 | Y | 园区名称 | |
invoice | Array | Y | 开票信息 |
invoice 开票信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
oneObjectName | String | 100 | Y | 发票一级类目名称 | |
twoObjectName | String | 100 | Y | 发票二级类目名称 | |
hasInvoiceFee | int | Y | 已开票金额(整数,单位:分) | ||
applyInvoiceFee | int | Y | 申请中开票金额(整数,单位:分) | ||
ableInvoiceFee | int | Y | 可开票金额(整数,单位:分) |
- 响应示例
{
"code": "200",
"data": [
{
"parkName": "uat测试园区",
"invoice": [
{
"ableInvoiceFee": 263092543,
"applyInvoiceFee": 18250,
"hasInvoiceFee": 800,
"oneObjectName": "研发和技术服务",
"twoObjectName": "工程勘察勘探服务"
},
{
"ableInvoiceFee": 89853368,
"applyInvoiceFee": 3536236,
"hasInvoiceFee": 43548,
"oneObjectName": "研发和技术服务",
"twoObjectName": "数据研发技术服务"
},
{
"ableInvoiceFee": 10867,
"applyInvoiceFee": 6400,
"hasInvoiceFee": 68800,
"oneObjectName": "设计服务",
"twoObjectName": "工程设计服务"
}
],
"parkId": 2
},
{
"parkName": "qh测试",
"invoice": [
{
"ableInvoiceFee": 1,
"applyInvoiceFee": 0,
"hasInvoiceFee": 0,
"oneObjectName": "研发和技术服务",
"twoObjectName": "合同能源管理服务"
}
],
"parkId": 6
}
],
"message": "操作成功",
"nonceStr": "fMuPUW0a0rtnZDlW4jRK",
"timestamp": 1646899936240
}
5.8.2开票申请
- 说明
开票申请
- 接口API
/interface/invoice/apply
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outOrderNo | String | 18 | Y | 申请订单号 | |
parkId | Long | Y | 园区ID | ||
oneObjectName | String | 50 | Y | 发票一级类目名称 | |
twoObjectName | String | 50 | Y | 发票二级类目名称 | |
invoiceTotalFee | Long | Y | 开票金额(含税)(整数,单位:分) | ||
invoiceType | String | 5 | Y | 发票类型 详见《发票类型字典》 |
|
invoiceAddress | String | 200 | N | 发票抬头地址(专票必填) | |
invoicePhone | String | 20 | N | 发票抬头电话(专票必填) | |
invoiceAcctNo | String | 30 | N | 发票抬头银行账户(专票必填) | |
invoiceBankName | String | 50 | N | 发票抬头开户行(专票必填) | |
postalAddress | String | 100 | C | 邮递接收地址(非电子发票必填) | |
postalMobile | String | 20 | C | 邮递接收电话(非电子发票必填) | |
postalUserName | String | 30 | C | 收件人名称(非电子发票必填) | |
postalEmail | String | 200 | C | 电子发票接收电子邮箱(不填不发邮件) | |
remark | String | 200 | N | 备注 | |
postRemark | String | 100 | N | 邮寄备注 | |
callBackUrl | String | 100 | Y | 回调URL |
- 请求示例
{
"sign": "nisi",
"signType": "labore qui Excepteur",
"timestamp": "2016-01-02 19:10:24",
"nonceStr": "13077019832592220035",
"reqMsgId": "19621104533972982320788225792085",
"appid": "1004",
"data": {
"businessId": "950687944577482752",
"outOrderNo": "525713419905370516",
"parkId": 15,
"oneObjectName": "安全保护服务",
"twoObjectName": "安全保护服务",
"invoiceTotalFee": "1000",
"invoiceType": "3",
"invoiceAddress": "黑龙江省长治市钦北区",
"invoicePhone": "18120063804",
"invoiceAcctNo": "13024512563",
"invoiceBankName": "中国农业银行",
"postalAddress": "黑龙江省长治市钦北区",
"postalMobile": "18167126416",
"postalUserName": "常平",
"postalEmail": "n.pym@qq.com",
"remark": "proident laborum eiusmod ullamco cupidatat",
"postRemark": "sunt elit mollit in",
"callBackUrl": "http://baidu.com"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outOrderNo | String | 200 | Y | 申请订单号 | |
parkId | String | Y | 园区ID | ||
oneObjectName | String | 100 | Y | 发票一级类目名称 | |
twoObjectName | String | 100 | Y | 发票二级类目名称 | |
invoiceTotalFee | int | Y | 开票金额(含税)(整数,单位:分) | ||
invoiceType | String | 5 | Y | 发票类型 详见《发票类型字典》 |
|
invoiceAddress | String | 200 | N | 发票抬头地址(专票必填) | |
invoicePhone | String | 20 | N | 发票抬头电话(专票必填) | |
invoiceAcctNo | String | 40 | N | 发票抬头银行账户(专票必填) | |
invoiceBankName | String | 100 | N | 发票抬头开户行(专票必填) | |
postalAddress | String | C | 邮递接收地址(非电子发票必填) | ||
postalMobile | String | C | 邮递接收电话(非电子发票必填) | ||
postalUserName | String | C | 收件人名称(非电子发票必填) | ||
postalEmail | String | C | 电子发票接收电子邮箱(不填不发邮件) | ||
remark | String | 200 | N | 备注 | |
postRemark | String | 200 | N | 邮寄备注 | |
callBackUrl | String | 100 | Y | 回调 URL | |
status | String | 5 | Y | 状态 01-待审核,02-审核通过(待开票),03-驳回作废, 04-已开票,05-作废重开 |
|
message | String | 200 | N | 审核意见 |
- 响应示例
{
"code": "200",
"message": "操作成功",
"nonceStr": "U38zzTjAFxgYpQGcw3qq",
"timestamp": 1646794213393
}
5.8.3发票信息查询
- 说明
已申请的发票信息查询
- 接口API
/interface/invoice/myInvoice
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outOrderNo | String | 18 | Y | 申请订单号 |
- 请求示例
{
"appid": "2022030713000002",
"data": {
"businessId": "950687944577482752",
"outOrderNo":"951069391180107776"
},
"nonceStr": "NaFc54bnlQhUWCa34Rmx",
"reqMsgId": "286ebd3ebb3f4036ae1b3e391b17bb68",
"sign": "E51701238995FD0ECFEA0CB2637F4C33",
"signType": "MD5",
"timestamp": 1646798376200
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outOrderNo | String | 200 | Y | 申请订单号 | |
parkId | String | Y | 园区ID | ||
parkName | String | 100 | Y | 园区名称 | |
oneObjectName | String | 100 | Y | 发票一级类目名称 | |
twoObjectName | String | 100 | Y | 发票二级类目名称 | |
invoiceTotalFee | int | Y | 开票金额(含税)(整数,单位:分) | ||
invoiceType | String | 5 | Y | 发票类型(见下表) | |
invoiceAddress | String | 100 | Y | 发票抬头地址 | |
invoicePhone | String | 20 | Y | 发票抬头电话 | |
invoiceAcctNo | String | 40 | Y | 发票抬头银行账户 | |
invoiceBankName | String | 100 | Y | 发票抬头开户行 | |
postalAddress | String | C | 邮递接收地址(非电子发票必填) | ||
postalMobile | String | C | 邮递接收电话(非电子发票必填) | ||
postalUserName | String | C | 收件人名称(非电子发票必填) | ||
postalEmail | String | C | 电子发票接收电子邮箱(不填不发邮件) | ||
remark | String | 200 | N | 备注 | |
postRemark | String | N | 邮寄备注 | ||
status | String | 5 | Y | 状态 01-待审核,02-审核通过(待开票),03-驳回作废, 04-已开票,05-作废重开 |
|
message | String | 200 | N | 审核意见 | |
invoiceNums | Array | N | 发票编码 | ||
invoiceUrls | Array | N | 发票图片 | ||
postNumber | String | N | 快递单号 | ||
postName | String | N | 快递公司 | ||
postTime | String | N | 邮寄时间 | ||
invoiceTime | String | N | 开票时间 | ||
applyTime | String | Y | 申请时间 |
invoices 发票信息
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
invoiceNum | String | Y | 发票号 | |
invoiceUrl | String | Y | 发票URL |
- 响应示例
{
"code": "200",
"data": {
"applyTime": "2022-03-09 10:50:13",
"invoiceAcctNo": "13024512563",
"invoiceAddress": "黑龙江省长治市钦北区",
"invoiceBankName": "中国农业银行",
"invoicePhone": "18120063804",
"invoiceTotalFee": 1000,
"invoiceType": "3",
"invoices": [
{}
],
"message": "",
"oneObjectName": "安全保护服务",
"outOrderNo": "951069391180107776",
"parkId": 15,
"postalAddress": "黑龙江省长治市钦北区",
"postalEmail": "n.pym@qq.com",
"postalMobile": "18167126416",
"postalUserName": "常平",
"remark": "proident laborum eiusmod ullamco cupidatat",
"status": "02",
"twoObjectName": "安全保护服务"
},
"message": "操作成功",
"nonceStr": "OXaoYUV2x3VLmgvtHC7K",
"timestamp": 1646817553720
}
5.8.4开票结果回调
- 说明
根据申请填写URL进行回调
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outOrderNo | String | 18 | Y | 申请订单号 | |
parkId | Long | Y | 园区ID | ||
oneObjectId | Long | Y | 发票一级类目 | ||
twoObjectId | Long | Y | 发票二级类目 | ||
invoiceTotalFee | Long | Y | 开票金额(含税)(整数,单位:分) | ||
invoiceType | String | 5 | Y | 发票类型(见下表) | |
invoiceAddress | String | 200 | Y | 发票抬头地址 | |
invoicePhone | String | 20 | Y | 发票抬头电话 | |
invoiceAcctNo | String | 30 | Y | 发票抬头银行账户 | |
invoiceBankName | String | 50 | Y | 发票抬头开户行 | |
postalAddress | String | 100 | C | 邮递接收地址(非电子发票必填) | |
postalMobile | String | 20 | C | 邮递接收电话(非电子发票必填) | |
postalUserName | String | 30 | C | 收件人名称(非电子发票必填) | |
postalEmail | String | 100 | C | 电子发票接收电子邮箱(不填不发邮件) | |
remark | String | 200 | N | 备注 | |
postRemark | String | 100 | N | 邮寄备注 | |
callBackUrl | String | 100 | Y | 回调 URL | |
status | String | 2 | Y | 状态见下表 | |
message | String | 100 | N | 审核意见 |
- 请求示例
- 响应参数
code | 说明 |
---|---|
200 | 通知成功不再回调 |
非200 | 2、4、5、10、15分钟间隔回调,五次回调均无响应成功则不再进行回调 |
- 响应示例
{
"code": "200",
"message": "请求成功"
}
5.9自由职业者白名单
5.9.1申请自由职业者白名单
- 说明
申请自由职业者白名单
- 接口API
/interface/whitelist/apply
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
freelancerInfo | Array | Y | 自由职业者信息 |
freelancerInfo 自由职业者信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
freeName | String | 30 | Y | 姓名 | |
idno | String | 20 | Y | 身份证号 | |
mobile | String | 15 | Y | 电话 | |
acctNo | String | 40 | N | 银行卡号 | |
remark | String | 200 | N | 备注 | |
listType | String | 2 | Y | 白名单类型见下表 | |
idnoFront | String | N | Base64图片(图片不能大于2M)/可访问URL | 身份证人像面 | |
idnoBack | String | N | Base64图片(图片不能大于2M)/可访问URL | 身份证国徽面 | |
other | String | N | Base64图片(图片不能大于2M)/可访问URL | 其他证明材料 |
listType 白名单类型
码值 | 说明 |
---|---|
1 | 实名 |
2 | 银行卡校验 |
3 | 董监高 |
4 | 年龄限制 |
- 请求示例
{
"appid": "2022030713000002",
"data": {
"businessId": "950687944577482752",
"freelancerInfo": [
{
"acctNo": "xxxxxxxx",
"idno": "622926199xxxxxxxx",
"listType": "1",
"mobile": "17319525282",
"freeName": "王五",
"remark": "实名认证"
}
]
},
"nonceStr": "NaFc54bnlQhUWCa34Rmx",
"reqMsgId": "286ebd3ebb3f4036ae1b3e391b17bb68",
"sign": "E51701238995FD0ECFEA0CB2637F4C33",
"signType": "MD5",
"timestamp": 1646798376200
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
data | Object | N | 返回业务数据 |
data 业务数据
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
freelancerInfo | Array | Y | 自由职业者信息 |
freelancerInfo 自由职业者信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
freeName | String | 30 | Y | 姓名 | |
idno | String | 20 | Y | 身份证号 | |
mobile | String | 15 | N | 电话 | |
acctNo | String | 40 | N | 银行卡号/支付宝账号/微信OpenId | |
remark | String | 200 | Y | 备注 | |
listType | String | 5 | Y | 白名单类型同前面 | |
status | String | 5 | Y | 状态见下表 | |
message | String | 200 | N | 审核意见或错误描述 |
status 状态
码值 | 说明 |
---|---|
00 | 待审核 |
01 | 审核通过 |
02 | 审核拒绝 |
500 | 申请失败 |
- 响应示例
{
"code": "200",
"data": {
"businessId": "950687944577482752",
"freelancerInfo": [
{
"acctNo": "6210814230000086387",
"idno": "622926199711151017",
"listType": "1",
"massage": "审核中",
"mobile": "17319525282",
"remark": "实名认证",
"status": "00"
}
]
},
"message": "操作成功",
"nonceStr": "0L7qqar5Y1UbsSFWYXCm",
"timestamp": 1646807367624
}
5.9.2自由职业者添加白名单结果查询
- 说明
自由职业者添加白名单后查询审核结果
- 接口API
/interface/whitelist/query
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
freelancerInfo | Array | Y | 自由职业者信息 最大100条 | ||
listType | String | 2 | N | 类型 |
freelancerInfo 自由职业者信息
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
idno | String | Y | 自由职业者信息 |
- 请求示例
{
"appid": "2022030713000002",
"data": {
"businessId": "950687944577482752",
"listType":"2",
"freelancerInfo": [
{
"idno": "622926199711151017",
"freeName": "xxxx",
}
]
},
"nonceStr": "NaFc54bnlQhUWCa34Rmx",
"reqMsgId": "286ebd3ebb3f4036ae1b3e391b17bb68",
"sign": "E51701238995FD0ECFEA0CB2637F4C33",
"signType": "MD5",
"timestamp": 1646798376200
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
businessId | String | Y | 企业编码 | |
freelancerInfo | Array | Y | 自由职业者信息 |
freelancerInfo 自由者业者信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
freeName | String | 30 | Y | 姓名 | |
idno | String | 20 | Y | 身份证号 | |
mobile | String | 15 | N | 电话 | |
acctNo | String | 40 | N | 银行卡号/支付宝账号/微信OpenId | |
listType | String | 5 | Y | 白名单类型同前面 | |
remark | String | 200 | Y | 备注 | |
status | String | 5 | Y | 状态见下表 | |
message | String | 200 | N | 审核意见 |
status 状态
码值 | 说明 |
---|---|
00 | 待审核 |
01 | 审核通过 |
02 | 审核拒绝 |
- 响应示例
{
"code": "200",
"data": {
"businessId": "950687944577482752",
"freelancerInfo": [
{
"acctNo": "6210814230000086387",
"idno": "622926199711151017",
"listType": "2",
"mobile": "17319525282",
"name": "xxxx",
"remark": "实名认证",
"status": "00"
}
]
},
"message": "操作成功",
"nonceStr": "X01zPF1ruWlDmgRXFeyU",
"timestamp": 1646817372883
}
5.10完税证明
5.10.1完税证明下载
- 说明
已完税信息查询
- 接口API
/interface/taxpay/proveInfo
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
date | String | 8 | Y | 2022-03 | 日期 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "2022022800001",
"data": {
"businessId": "923947685818540032",
"date": "2022-02"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
date | String | 8 | Y | 2022-03 | 日期 |
parkName | String | 100 | Y | 园区名称 | |
invoiceUrl | String | 100 | N | 可访问的URL |
- 响应示例
{
"code": "200",
"data": [
{
"date": "2022-02",
"parkName": "qh测试",
"invoiceUrl": "http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/taxProveUrls/6cd4aa9f71194d39a2e009a8e2899418.jpg",
"businessId": "923947685818540032",
}
],
"message": "操作成功",
"nonceStr": "3l7tdmURH4wiBjUpHQMw",
"timestamp": 1646969068874
}
5.11同步自由职业者电子合同
5.11.1同步自由职业者电子合同
- 说明
同步自由职业者电子合同
- 接口API
/interface/contract/sync
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
idno | String | 20 | Y | 自由职业者身份证号 | |
contract | String | Y | Base64图片(图片不能大于2M)/可访问URL | 合同(pdf) |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId": "394b83504cf947edbb6af8e9247a9d6b",
"appid": "2022022800001",
"data": {
"businessId": "923947685818540032",
"idno": "148004199610025279",
"contract": "https://uat2.oss-cn-shanghai.aliyuncs.com/%E5%85%B1%E4%BA%AB%E7%BB%8F%E6%B5%8E%E6%9C%8D%E5%8A%A1%E5%8D%8F%E8%AE%AE-%E8%87%AA%E7%94%B1%E8%81%8C%E4%B8%9A%E8%80%85%E6%96%B0.pdf"
}
}
- 响应示例
{
"code": "200",
"message": "同步成功",
"nonceStr": "aDWxHScWfDvR74cklG4B",
"timestamp": 1646968632665
}
5.12下载结算凭证
5.12.1下载结算凭证
- 说明
下载结算凭证
- 接口API
/interface/utils/downloadSettlementVoucher
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outBatchNo | String | 200 | Y | 批次号 | |
outSeqNo | String | 50 | N | 批次内序列号 |
- 请求示例
{
"appid": "2022030713000002",
"data": {
"businessId": "950709751405330432",
"outBatchNo": "950709751405330432_55fccddc5c",
"outSeqNo":""
},
"nonceStr": "{% mock 'string', 'MPzteIbCc0JiJRDWxsTQ', 20, 20 %}",
"reqMsgId": "{% mock 'string', '44fdsf45dsf4s51cdfsd4s5c1', 20, 30 %}",
"sign": "E51701238995FD0ECFEA0CB2637F4C33",
"signType": "MD5",
"timestamp": 1646798376200
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outBatchNo | String | 200 | Y | 批次号 | |
detail | Array | 详细信息 |
detail详细信息
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
outSeqNo | String | 50 | Y | 批次内序列号 | |
certificate | String | 500 | N | 凭证URL |
- 响应示例
{
"code": "200",
"data": {
"outBatchNo": "950709751405330432_55fccddc5c",
"businessId": "950709751405330432",
"detail": [
{
"outSeqNo": "11908013708393840654",
"certificate": "http://prenlos2.oss-cn-shanghai.aliyuncs.com/freework/receipt/3240792203103800916698_15544747690095_20220310_120.pdf?Expires=1962261950&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=HCq%2FgT9SoZNiNd1iGYouTzE74rA%3D"
}
]
},
"message": "操作成功",
"nonceStr": "fi7btvOGSVW6tZffz2hC",
"timestamp": 1646967015757
}
5.13同步自由职业者身份证照片
5.13.1同步自由职业者身份证照片
- 说明
同步自由职业者身份证照片
若该自由职业者已有身份证照片,则直接返回成功
- 接口API
/interface/utils/syncIdCardPic
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
idno | String | 20 | Y | 身份证号 | |
idCardFace | String | Y | Base64图片(图片不能大于2M)/可访问URL | 身份证人像面 | |
idCardEmblem | String | Y | Base64图片(图片不能大于2M)/可访问URL | 身份证国徽面 |
- 请求示例
{
"appid": "2022030713000002",
"data": {
"businessId": "950687944577482752",
"idno":"140201198109055094",
"idCardFace":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/urls496b3ace787342f7954b7045b8b06804.jpeg",
"idCardEmblem":"http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/urls496b3ace787342f7954b7045b8b06804.jpeg",
},
"nonceStr": "NaFc54bnlQhUWCa34Rmx",
"reqMsgId": "286ebd3ebb3f4036ae1b3e391b17bb68",
"sign": "E51701238995FD0ECFEA0CB2637F4C33",
"signType": "MD5",
"timestamp": 1646798376200
}
- 响应示例
{
"code": "200",
"message": "操作成功",
"nonceStr": "PnyQtzUYysFBeabctWxS",
"timestamp": 1646815973066
}
5.14公共查询工具
5.14.1银行名称查询
- 说明
使用银行账号查询对应银行名称
- 接口API
/interface/utils/queryBankName
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
accountNo | String | 40 | Y | 银行卡号 | |
businessId | String | 50 | Y | 企业编码 |
- 请求示例
{
"appid": "2022030713000002",
"data": {
"accountNo": "6216910215680940",
"businessId": "950687944577482752",
},
"nonceStr": "NX46jQJbADRDT1pDQaSp",
"reqMsgId": "ff943b74588644afaa42c1f2b4bf27f8",
"sign": "379D3A050A4DCB7E7F99F423C6F86984",
"signType": "MD5",
"timestamp": 1646796141572
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
accountNo | String | 40 | Y | 银行账号 | |
bankName | String | 100 | Y | 银行名称 |
- 响应示例
{
"code": "200",
"data": {
"accountNo": "6216910215680940",
"bankName": "民生银行"
},
"message": "操作成功",
"nonceStr": "1Gp2TwIm7OnkO89X1Nty",
"timestamp": 1646809485315
}
5.14.2实名认证
- 说明
身份证二要素 验证 1001 姓名+身份证号;
身份证三要素 验证 1002 姓名+身份证号+电话;
银行卡二要素 验证 1003 姓名+卡号;
银行卡三要素 验证 1004 姓名+身份证号+卡号。
- 接口API
/interface/utils/realNameAuth
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
name | String | 30 | Y | 姓名 | |
idno | String | 20 | C | 身份证号 | |
acctNo | String | 40 | C | 银行卡 | |
mobile | String | 15 | C | 电话 | |
type | String | 2 | Y | 验证类型见下表 |
type验证类型
码值 | 说明 |
---|---|
1001 | 姓名+身份证号 |
1002 | 姓名+身份证号+电话 |
1003 | 姓名+卡号 |
1004 | 姓名+身份证号+卡号 |
- 请求示例
{
"appid": "2022030713000002",
"data": {
"acctNo": "6216910215680940",
"businessId": "950687944577482752",
"idno": "430521199xxxxxxx",
"mobile": "15678922063",
"name": "王五",
"type": "1001"
},
"nonceStr": "NX46jQJbADRDT1pDQaSp",
"reqMsgId": "ff943b74588644afaa42c1f2b4bf27f8",
"sign": "379D3A050A4DCB7E7F99F423C6F86984",
"signType": "MD5",
"timestamp": 1646796141572
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
name | String | 30 | Y | 姓名 | |
idno | String | 20 | C | 身份证号 | |
acctNo | String | 40 | C | 银行卡 | |
mobile | String | 15 | C | 电话 | |
type | String | 5 | Y | 验证类型见前面 | |
code | String | 5 | Y | 验证结果见下表 | |
massage | String | 200 | Y | 验证信息 |
code 验证结果
码值 | 说明 |
---|---|
200 | 验证通过 |
500 | 验证失败 |
- 响应示例
{
"appid": "2022030713000002",
"data": {
"acctNo": "xxxxxx",
"businessId": "950687944577482752",
"idno": "xxxxxx",
"mobile": "xxxxxx",
"name": "xxxxxx",
"type": "1001"
},
"nonceStr": "NX46jQJbADRDT1pDQaSp",
"reqMsgId": "ff943b74588644afaa42c1f2b4bf27f8",
"sign": "379D3A050A4DCB7E7F99F423C6F86984",
"signType": "MD5",
"timestamp": 1646796141572
}
5.14.3 身份证照片转存
- 说明
因未上传身份证照片的自由职业者无法结算成功,且批量接口无法接受大量BASE64 图片,可在该接口上传BASE64 照片并获取URL ,在批量招募时使用。
在上传成功后请及时招募,该接口链接只保留24小时。
- 接口API
/interface/utils/idCardUpload
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
image | String | Y | Base64图片(图片不能大于2M)/可访问URL |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"nonceStr": "{% mock 'string', 'MPzteIbCc0JiJRDWxsTQ', 20, 20 %}",
"reqMsgId": "{% mock 'string', '44fdsf45dsf4s51cdfsd4s5c1', 20, 30 %}",
"appid": "952212545266184192",
"timestamp": "1645770163620",
"data": {
"businessId": "950709751405330432",
"image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wAARCALQAU0DASIAAhEBAxEB/8QAHQAAAAcBAQEAAAAAAAAAAAAAAQIDBAUGBwAICf/EAFcQAAIBAwIDBQUEBgUJBQUGBwECAwAEERIhBTFBBhMiUWEHMnGBkRQjQqEVUrHB0fAIYnKC4RYkM0OSosLS8Rc0U7LDNWNzdIMlV"
}
}
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
data | object | 业务参数 |
data业务参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
url | string | 业务参数 |
- 响应示例
{
"code": "200",
"data": {
"url": "http://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/idCardTempDic/FKd10oS2QLKjnMg.jpg"
},
"appid": "952212545266184192",
"signType": "RSA",
"message": "操作成功",
"nonceStr": "iMDWittxcPCecziiT00D",
"timestamp": "1645770163620",
"reqMsgId": "sfffc4d45css5fdds5c4"
}
5.15 业务确认单
5.15.1 业务确认单模板下载
- 说明
根据企业配置的业务确认单的确认方式 该接口 有以下效果
- 线下上传 返回业务确认单的状态和下载链接,可以通过下载链接下载业务确认单模板文件,盖章后通过上传接口进行上传
- 线上确认 发起线上确认流程,向企业的授权人发送业务确认单 确认短信,并返回确认链接
授权人授权现只能在页面进行
- 接口API
/interface/waitDeal/downloadOutcome
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
month | String | 8 | Y | 业务确认单的月份 yyyy-MM 格式 | |
parkId | Long | N | 园区编码 下载当前园区的业务确认单 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "IbcPIebJiJbWWIItJCJi",
"reqMsgId": "f5s4dc4s5fsc5csfd4d5",
"appid": "964132147940167680",
"data": {
"businessId": "923947685818540032",
"month": "2022-05",
"parkId": "11"
}
}
线上上传的企业 只会返回CODE 和 MESSAGE
- 响应参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
data | object | N | 业务参数 线上上传不返回 |
data业务参数
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
seqNo | string | 业务确认单编码 | ||
file | string | 业务确认单模板下载链接 线下上传 返回业务确认单模板下载链接 线上确认 返回在线确认链接,同时 发送短信给企业的授权人 | ||
status | string | 业务确认单状态 01-待上传(待确认),02-已上传(已确认;待审核),03-已短信确认(电子签),04-(审核通过),05-(审核拒绝),06 - 已发送短信(线上确认)" |
- 响应示例
{
"code": "200",
"data": [
{
"file": "https://uat2.oss-cn-shanghai.aliyuncs.com/bblg2021/companyComeOutInfo/%E4%B8%9A%E5%8A%A1%E7%A1%AE%E8%AE%A4%E5%8D%95_%E6%B5%8B%E8%AF%95%E4%BC%81%E4%B8%9Arxt02_HAI%E6%B5%8B%E8%AF%95%E5%9B%AD%E5%8C%BA_2022%E5%B9%B405%E6%9C%88.pdf?Expires=1970460845&OSSAccessKeyId=LTAI4Fi1uQq4A26wEMjLJLr9&Signature=rcSyr3K4B1zF8NodwNpxn4W7S6o%3D",
"seqNo": 270,
"status": "01"
}
],
"appid": "964132147940167680",
"signType": "RSA",
"message": "操作成功",
"nonceStr": "IbcPIebJiJbWWIItJCJi",
"timestamp": "1645770163620",
"reqMsgId": "f5s4dc4s5fsc5csfd4d5"
}
5.15.2 业务确认单上传
- 说明
线下确认的业务确认单 打印盖章后 通过该接口上传
- 接口API
/interface/waitDeal/uploadOutcome
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
url | String | 300 | Y | 上传的业务确认单 链接, 只支持链接 | |
seqNo | String | 50 | Y | 业务确认单编码 | |
fileName | String | 50 | Y | 文件名 业务确认单的文件名 带后缀 | |
callBack | String | 100 | N | 业务确认单审核回调地址,不传不回调 |
- 请求示例
{
"sign": "fh5bg2w6fvsUsgEwI98RHIFO6/XApGgbVpuepnUOB0fLF",
"signType": "RSA",
"timestamp": "1645770163620",
"nonceStr": "JseiCTeRQbWIJJxTJMeD",
"reqMsgId": "d1c1sscs555fdsd441dfc1c",
"appid": "964132147940167680",
"data": {
"businessId": "923947685818540032",
"url": "https://s2.seikim.com/i/2022/06/16/imfhgo.png",
"seqNo": "270",
"fileName": "微信截图_20220615142534.png",
"callBack": "http://47.112.129.249:8880/interfacecallback/send"
}
}
线上上传的企业 只会返回CODE 和 MESSAGE
响应参数 公共参数
响应示例
{
"code": "200",
"appid": "964132147940167680",
"signType": "RSA",
"message": "操作成功",
"nonceStr": "JseiCTeRQbWIJJxTJMeD",
"timestamp": "1645770163620",
"reqMsgId": "d1c1sscs555fdsd441dfc1c"
}
5.15.3 业务确认单审核回调
- 说明
业务确认单 审核结果回调
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
message | String | C | 审核信息 审核拒绝必传 | ||
status | string | Y | 业务确认单状态 01-待上传(待确认),02-已上传(已确认;待审核),03-已短信确认(电子签),04-(审核通过),05-(审核拒绝),06 - 已发送短信(线上确认)" | ||
seqNo | String | Y | 文件名 业务确认单的文件名 带后缀 |
- 请求示例
{
"data": {
"seqNo": "275",
"message": "",
"status": "04"
},
"appid": "964132147940167680",
"nonceStr": "jNI2U2NpLw7TMwKTEOda",
"reqMsgId": "986641969322545152",
"timestamp": "1655275376422"
}
- 响应参数
code | 说明 |
---|---|
200 | 通知成功不再回调 |
非200 | 2、4、5、10、15分钟间隔回调,五次回调均无响应成功则不再进行回调 |
- 响应示例
{
"code": "200",
"message": "请求成功"
}
响应参数
响应示例
{
"code":"200",
"message":"操作成功"
}
5.16 灵工保险
5.16.1 保险套餐查询
- 说明
查询所有的保险套餐
- 接口API
/interface/ins/insPackage
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 |
- 请求示例
`
json
- **响应参数**
|参数名|类型|长度|是否必填|示例|说明|
|----|-----|---|-------|-----|---|
|data|object||Y||业务参数|
**data参数**
|参数名|类型|长度|是否必填|示例|说明|
|-----|----|----|------|----|----|
|mealId|String|18|Y||套餐编码|
|mealName|String|20|Y||套餐名称|
|deathOrDIsability|int|20|Y||意外身故/残疾 单位 (分)|
|medicalCare|int|20|Y||意外医疗 单位 (分)|
|hospitalizationBenefit|int|20|Y||意外住院津贴 单位(分)|
|dayPrice|int|20|Y||按天计 保费单价 单位 (分)|
|monthPrice|int|20|Y||按月计 保费单间 单位 (分)|
|remark|Stirng|200|Y||备注|
- **响应示例**
```json
5.16.2 保单试算
说明
因保单价格计算方式较为复杂,提供该接口结算最终的订单价格 该接口不保存 请求的保单信息
接口API
/interface/ins/trial/
请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
mealId | String | 18 | Y | 套餐编码 | |
startTime | String | 10 | Y | 保单开始时间 时间格式 yyyy-MM-dd HH:mm:ss | |
days | int | 2 | Y | 保险天数 应小于等于30 大于等于1 | |
freelances | arrya | Y | 购买保险的自由职业者信息 |
freelances 参数 |参数名|类型|长度|是否必填|示例|说明| |-----|----|----|------|----|-----| |name |string|20|Y||姓名| |idno| string|18|Y||身份证号| |mobile|string|11|Y||手机号|
请求示例
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
data | object | Y | 业务参数 |
data参数 |参数名|类型|长度|是否必填|示例|说明| |-----|-----|----|-----|-----|---| |businessId|string|50|Y||企业编码| |mealId|String|18|Y||套餐编码| |startTime|String|10|Y||保单开始时间 时间格式 yyyy-MM-dd HH:mm:ss| |days|int|2|Y||保险天数 应小于等于30 大于等于1| |unitPrice|int|20|Y||单价 每个人的应付金额 单位(分)| |totalPrice|int|20|Y||总价 该笔订单的总价 单位 (分)| |total|int|20|Y||人数|
- 响应示例
`
json
### 5.16.3 投保
- **说明**
保单投保
<font color="red" > **保单开始时间 必须大于提交时间 一个小时** </font>
- **接口API**
/interface/ins/insured/
- **请求参数**
|参数名|类型|长度|是否必填|示例|说明|
|-----|----|----|------|-----|----|
|businessId|String|50|Y||企业编码|
|outBatchNo|String|20|Y||订单批次编号|
|mealId|String|18|Y||套餐编码|
|acctNo|String|18|Y||支付子账号|
|startTime|String|10|Y||保单开始时间 时间格式 yyyy-MM-dd HH:mm:ss|
|placeOfWork|string|20|Y||工作地点|
|days|int|2|Y||保险天数 应小于等于30 大于等于1|
|callback|string|100|Y||回调地址|
|freelances|arrya||Y||购买保险的自由职业者信息|
**freelances 参数**
|参数名|类型|长度|是否必填|示例|说明|
|-----|----|----|------|----|-----|
|outSeqNo|String|20|Y||订单编号|
|name |string|20|Y||姓名|
|idno| string|18|Y||身份证号|
|mobile|string|11|Y||手机号|
|workTypeId|string|20|Y||行业工种|
[行业工种字典](https://prenlos2.oss-cn-shanghai.aliyuncs.com/bblg2021/%E6%97%A0%E5%BF%A7%E4%BF%9D%E5%B7%A5%E7%A7%8D%E7%B1%BB%E5%88%AB%E8%A1%A8.xlsx)
**请求示例**
```json
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
data | object | Y | 业务参数 |
data参数 |参数名|类型|长度|是否必填|示例|说明| |-----|-----|----|-----|-----|---| |businessId|string|50|Y||企业编码| |mealId|String|18|Y||套餐编码| |outBatchNo|String|20|Y||订单批次编号| |startTime|String|10|Y||保单开始时间 时间格式 yyyy-MM-dd HH:mm:ss| |days|int|2|Y||保险天数 应小于等于30 大于等于1| |unitPrice|int|20|Y||单价 每个人的应付金额 单位(分)| |totalPrice|int|20|Y||总价 该笔订单的总价 单位 (分)| |total|int|20|Y||人数| |payStatus|string|3|Y||支付状态| |payMessage|string|100|Y||支付信息|
- 响应示例
`
json
### 5.16.4 订单查询
- **说明**
查询已投保的订单信息
- **接口API**
/interface/ins/query/
- **请求参数**
|参数名|类型|长度|是否必填|示例|说明|
|-----|----|----|------|-----|----|
|businessId|String|50|Y||企业编码|
|outBatchNo|String|20|Y||订单批次编号|
|outSeqNo|String|20|N||订单编号|
|detailStatus|String|5|N||保单状态(01:保障未开始,02:承保中,03:保障已到期,04:已退保,05:投保失败) |
**请求示例**
```json
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
data | object | Y | 业务参数 |
data参数 |参数名|类型|长度|是否必填|示例|说明| |-----|-----|----|-----|-----|---| |businessId|string|50|Y||企业编码| |mealId|String|18|Y||套餐编码| |outBatchNo|String|20|Y||订单批次编号| |startTime|String|10|Y||保单开始时间 时间格式 yyyy-MM-dd HH:mm:ss| |days|int|2|Y||保险天数 应小于等于30 大于等于1| |totalPrice|int|20|Y||总价 该笔订单的总价 单位 (分)| |payStatus|string|3|Y||支付状态| |payMessage|string|100|Y||支付信息| |total|int|20|Y||保单条数| |policys|Array||Y||保单信息|
- policys 参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
outSeqNo | string | 20 | Y | 订单编号 | |
name | string | 20 | Y | 被保人姓名 | |
idno | string | 18 | Y | 被保人身份证号 | |
mobile | string | 11 | Y | 被保人手机号 | |
insPrice | int | 20 | Y | 保单单价 单位 (分) | |
insPriceTotal | int | 20 | Y | 保单价格 单位 (分) | |
DetailStatus | string | 5 | Y | 保单状态:保单状态(01:保障未开始,02:承保中,03:保障已到期,04:已退保,05:投保失败,06:待支付,07:待提交) | |
elecInsFile | string | 300 | N | 电子保单链接 | |
failReason | string | 100 | C | 投保失败原因 投保失败必填 |
5.16.5 保单回调
说明
投保结果回调,投保成功或者失败都会触发该回调
接口API
投保时的回调地址
- 请求参数 |参数名|类型|长度|是否必填|示例|说明| |-----|----|----|------|-----|----| |businessId|String|50|Y||企业编码| |outSeqNo|string|20|Y||订单编号| |mealId|String|18|Y||套餐编码| |name|string|20|Y||被保人姓名| |idno|string|18|Y||被保人身份证号| |startTime|String|10|Y||保单开始时间 时间格式 yyyy-MM-dd HH:mm:ss| |days|int|2|Y||保险天数 应小于等于30 大于等于1| |mobile|string|11|Y||被保人手机号| |insPrice|int|20|Y||保单单价 单位 (分)| |insPriceTotal|int|20|Y||保单价格 单位 (分)| |DetailStatus|string|5|Y||保单状态:保单状态(01:保障未开始,02:承保中,03:保障已到期,05:投保失败)| |elecInsFile|string|300|N||电子保单链接| |failReason|string|100|C|| 投保失败原因 投保失败必填|
请求示例
- 响应参数
code | 说明 |
---|---|
200 | 通知成功不再回调 |
非200 | 2、4、5、10、15分钟间隔回调,五次回调均无响应成功则不再进行回调 |
- 响应示例
{
"code": "200",
"message": "请求成功"
}
5.16.6 保险发票
5.16.6.1 可开票查询
说明
查询可开票
接口API
/interface/ins/invoice/availableBalance/
- 请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
parkId | int | 10 | N | 园区编码 |
请求示例
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
data | object | Y | 业务参数 |
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
parkId | int | 10 | Y | 园区编码 | |
parkName | string | 20 | Y | 园区名称 | |
invoice | array | Y | 可开票信息 |
invoice 参数 |参数名|类型|长度|是否必填|示例|说明| |-----|-----|----|-----|-----|---| |oneObjectName|string|20|Y||一级类目| |twoObjectName|string|20|Y||二级类目| |ableInvoiceFee|int|20|Y||可开票金额 单位 (分)| |hasInvoiceFee|int | 20|Y||已开票金额 单位 (分)| |applyInvoiceFee|int|20|Y||申请中金额 单位 (分)|
- 响应示例
`
json
#### 5.16.6.2 开票申请
- **说明**
查询可开票
- **接口API**
/interface/ins/invoice/apply/
- **请求参数**
| **参数名** | **类型** | 长度 | **是否必填** | **示例** | **说明** |
| --------------- | -------- | ---- | ------------ | -------- | ---------------------------------- |
| businessId | String | 50 | Y | | 企业编码 |
| outOrderNo | String | 18 | Y | | 申请订单号 |
| parkId | Long | | Y | | 园区ID |
| oneObjectName | String | 50 | Y | | 发票一级类目名称 |
| twoObjectName | String | 50 | Y | | 发票二级类目名称 |
| invoiceTotalFee | Long | | Y | | 开票金额(含税)(整数,单位:分) |
| invoiceType | String | 5 | Y | | 发票类型<br/>详见《发票类型字典》 |
| invoiceAddress | String | 200 | N | | 发票抬头地址(专票必填) |
| invoicePhone | String | 20 | N | | 发票抬头电话(专票必填) |
| invoiceAcctNo | String | 30 | N | | 发票抬头银行账户(专票必填) |
| invoiceBankName | String | 50 | N | | 发票抬头开户行(专票必填) |
| postalAddress | String | 100 | C | | 邮递接收地址(非电子发票必填) |
| postalMobile | String | 20 | C | | 邮递接收电话(非电子发票必填) |
| postalUserName | String | 30 | C | | 收件人名称(非电子发票必填) |
| postalEmail | String | 200 | C | | 电子发票接收电子邮箱(不填不发邮件) |
| remark | String | 200 | N | | 备注 |
| postRemark | String | 100 | N | | 邮寄备注 |
| callBackUrl | String | 100 | Y | | 回调URL |
**请求示例**
```json
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outOrderNo | String | 200 | Y | 申请订单号 | |
parkId | String | Y | 园区ID | ||
oneObjectName | String | 100 | Y | 发票一级类目名称 | |
twoObjectName | String | 100 | Y | 发票二级类目名称 | |
invoiceTotalFee | int | Y | 开票金额(含税)(整数,单位:分) | ||
invoiceType | String | 5 | Y | 发票类型 详见《发票类型字典》 |
|
invoiceAddress | String | 200 | N | 发票抬头地址(专票必填) | |
invoicePhone | String | 20 | N | 发票抬头电话(专票必填) | |
invoiceAcctNo | String | 40 | N | 发票抬头银行账户(专票必填) | |
invoiceBankName | String | 100 | N | 发票抬头开户行(专票必填) | |
postalAddress | String | C | 邮递接收地址(非电子发票必填) | ||
postalMobile | String | C | 邮递接收电话(非电子发票必填) | ||
postalUserName | String | C | 收件人名称(非电子发票必填) | ||
postalEmail | String | C | 电子发票接收电子邮箱(不填不发邮件) | ||
remark | String | 200 | N | 备注 | |
postRemark | String | 200 | N | 邮寄备注 | |
callBackUrl | String | 100 | Y | 回调 URL | |
status | String | 5 | Y | 状态 01-待审核,02-审核通过(待开票),03-驳回作废, 04-已开票,05-作废重开 |
|
message | String | 200 | N | 审核意见 |
- 响应示例
`
json
#### 5.16.6.3 发票信息查询
- **说明**
已申请的发票信息查询
- **接口API**
/interface/ins/invoice/myInvoice
- **请求参数**
- | **参数名** | **类型** | 长度 | **是否必填** | **示例** | **说明**
| ---------- | ------ | ---- | ---- | ---- | ---------- |
| businessId | String | 50 | Y | | 企业编码 |
| outOrderNo | String | 18 | Y | | 申请订单号 |
**请求示例**
```json
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outOrderNo | String | 200 | Y | 申请订单号 | |
parkId | String | Y | 园区ID | ||
parkName | String | 100 | Y | 园区名称 | |
oneObjectName | String | 100 | Y | 发票一级类目名称 | |
twoObjectName | String | 100 | Y | 发票二级类目名称 | |
invoiceTotalFee | int | Y | 开票金额(含税)(整数,单位:分) | ||
invoiceType | String | 5 | Y | 发票类型(见下表) | |
invoiceAddress | String | 100 | Y | 发票抬头地址 | |
invoicePhone | String | 20 | Y | 发票抬头电话 | |
invoiceAcctNo | String | 40 | Y | 发票抬头银行账户 | |
invoiceBankName | String | 100 | Y | 发票抬头开户行 | |
postalAddress | String | C | 邮递接收地址(非电子发票必填) | ||
postalMobile | String | C | 邮递接收电话(非电子发票必填) | ||
postalUserName | String | C | 收件人名称(非电子发票必填) | ||
postalEmail | String | C | 电子发票接收电子邮箱(不填不发邮件) | ||
remark | String | 200 | N | 备注 | |
postRemark | String | N | 邮寄备注 | ||
status | String | 5 | Y | 状态 01-待审核,02-审核通过(待开票),03-驳回作废, 04-已开票,05-作废重开 |
|
message | String | 200 | N | 审核意见 | |
invoiceNums | Array | N | 发票编码 | ||
invoiceUrls | Array | N | 发票图片 | ||
postNumber | String | N | 快递单号 | ||
postName | String | N | 快递公司 | ||
postTime | String | N | 邮寄时间 | ||
invoiceTime | String | N | 开票时间 | ||
applyTime | String | Y | 申请时间 |
invoices 发票信息
参数名 | 类型 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|
invoiceNum | String | Y | 发票号 | |
invoiceUrl | String | Y | 发票URL |
- 响应示例
`
json
#### 5.16.6.4 开票结果回调
- **说明**
发票开票结果回调
- **接口API**
根据申请填写URL进行回调
| **参数名** | **类型** | 长度 | **是否必填** | **示例** | **说明** |
| --------------- | -------- | ---- | ------------ | -------- | ----|
| businessId | String | 50 | Y | | 企业编码 |
| outOrderNo | String | 18 | Y | | 申请订单号 |
| parkId | Long | | Y | | 园区ID |
| oneObjectId | Long | | Y | | 发票一级类目 |
| twoObjectId | Long | | Y | | 发票二级类目 |
| invoiceTotalFee | Long | | Y | | 开票金额(含税)(整数,单位:分) |
| invoiceType | String | 5 | Y | | 发票类型(见下表) |
| invoiceAddress | String | 200 | Y | | 发票抬头地址 |
| invoicePhone | String | 20 | Y | | 发票抬头电话 |
| invoiceAcctNo | String | 30 | Y | | 发票抬头银行账户 |
| invoiceBankName | String | 50 | Y | | 发票抬头开户行 |
| postalAddress | String | 100 | C | | 邮递接收地址(非电子发票必填) |
| postalMobile | String | 20 | C | | 邮递接收电话(非电子发票必填) |
| postalUserName | String | 30 | C | | 收件人名称(非电子发票必填) |
| postalEmail | String | 100 | C | | 电子发票接收电子邮箱(不填不发邮件) |
| remark | String | 200 | N | | 备注 |
| postRemark | String | 100 | N | | 邮寄备注 |
| callBackUrl | String | 100 | Y | | 回调 URL |
| status | String | 2 | Y | | 状态见下表 |
| message | String | 100 | N | | 审核意见 |
- **请求示例**
```json
- 响应参数
code | 说明 |
---|---|
200 | 通知成功不再回调 |
非200 | 2、4、5、10、15分钟间隔回调,五次回调均无响应成功则不再进行回调 |
- 响应示例
{
"code": "200",
"message": "请求成功"
}
5.16.7 退保
说明
生效后的保单,若未到保障时间,均可退保
接口API
/interface/ins/refund
请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
outBatchNo | String | 20 | Y | 订单批次编号 | |
outSeqNo | String | 20 | Y | 订单编号 |
- 请求示例
`
json
- **响应参数**
|参数名|类型|长度|是否必填|示例|说明|
|-----|----|----|------|-----|----|
|businessId|String|50|Y||企业编码|
|outSeqNo|string|20|Y||订单编号|
|outBatchNo|string|20|Y||订单批次编号|
|mealId|String|18|Y||套餐编码|
|name|string|20|Y||被保人姓名|
|idno|string|18|Y||被保人身份证号|
|startTime|String|10|Y||保单开始时间 时间格式 yyyy-MM-dd HH:mm:ss|
|days|int|2|Y||保险天数 应小于等于30 大于等于1|
|mobile|string|11|Y||被保人手机号|
|insPrice|int|20|Y||保单单价 单位 (分)|
|insPriceTotal|int|20|Y||保单价格 单位 (分)|
|DetailStatus|string|5|Y||保单状态:保单状态(01:保障未开始,02:承保中,03:保障已到期,04:已退保,05:投保失败)|
|elecInsFile|string|300|N||电子保单链接|
|failReason|string|100|C|| 投保失败原因 投保失败必填|
- **响应示例**
```json
5.17 代开发票
5.17.1 个人实名认证
- 说明
代开发票需要个人认证,税务内网认证需要t+1或t+2拿到结果;
接口API
/interface/invoice/free/auth
请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
idNo | String | 20 | Y | 身份证号码 | |
name | String | 20 | Y | 姓名 | |
mobile | String | 20 | Y | 性别 1男,2女 | |
idCardFace | String | 200 | Y | 身份证正面url | |
idCardEmblem | String | 200 | Y | 身份证反面url | |
faceUrl | String | 200 | Y | 人脸照片url | |
address | String | 50 | Y | 居住地 | |
idNoTimeStart | String | 20 | Y | 身份证有效期起yyyy-mm-dd | |
idNoTimeEnd | String | 20 | Y | 身份证有效期止yyyy-mm-dd | |
nation | String | 20 | Y | 民族 | |
issue | String | 20 | Y | 签发机关 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"idNo":"372930***",
"name":"张三",
"sex":"1",
"idCardFace":"https://cdn.hidongxin.com/dxkj-2022/web//deliverable/1684904956380.jpg",
"idCardEmblem":"https://cdn.hidongxin.com/dxkj-2022/web//deliverable/1684904962780.jpg",
"faceUrl":"http://dxkj-production.oss-cn-shanghai.aliyuncs.com/dxkj2022/face/123.jpg?Expires=1987734360",
"address":"中国",
"idNoTimeStart":"2023-01-01",
"idNoTimeEnd":"2023-12-12",
"nation":"汉",
"issue":"***公安局"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
string | 20 | Y | 接口请求状态 | ||
message | string | - | Y | 具体请求信息 | |
returnCode | string | 20 | Y | 响应编码00成功-1失败 | |
returnMessage | string | 100 | Y | 成功失败详情 |
- 响应示例
{
"appid": "1118222213935587328",
"code": "200",
"message": "{\"returnCode\":\"-1\",\"returnMessage\":\"请修改身份证有效期格式为 yyyy-MM-dd\"}",
"nonceStr": "2l2KXQ5hUhiPu13xEAUK",
"reqMsgId": "ee951d046f5d4fc8ad495014a5a4829d",
"signType": "RSA",
"timestamp": "1686721778266"
}
5.17.2 个人实名认证查询
- 说明
税务接口问题,查询返回sfysmrz字段为false情况可能为暂未处理,或认证失败,税务局人工处理问题无法拿到具体失败原因
接口API
/interface/invoice/free/query
请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
idNo | String | 20 | Y | 身份证号 | |
name | String | 20 | Y | 姓名 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"idNo":"372930***",
"name":"张三"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态20成功 | |
message | string | - | Y | 具体请求信息 |
参数名 | 说明 |
---|---|
content | 状态码00返回该参数 |
sfysmrz | 认证状态true为成功,false失败或未进行内网认证 |
sfzjhm | 身份证号码 |
xm | 姓名 |
returnCode | 响应编码00成功-1失败 |
returnMessage | 成功失败详情 |
- 响应示例
{
"appid": "1118222213935587328",
"code": "200",
"message": "{\"content\":{\"sfysmrz\":\"true\",\"sfzjhm\":\"372930***\",\"xm\":\"张三\"},\"returnCode\":\"00\",\"returnMessage\":\"success\"}",
"nonceStr": "jcIFaUCSY2GbvXBiVTY4",
"reqMsgId": "da54444591bb49c88dd829b62827f82e",
"signType": "RSA",
"timestamp": "1686722683603"
}
5.17.3 个人与开票网点绑定
- 说明
个人与网点绑定后才能在指定网点开票
接口API
/interface/invoice/free/bingding
请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
idNo | String | 20 | Y | 身份证号 | |
name | String | 20 | Y | 姓名 | |
mobile | String | 20 | Y | 手机号 | |
uuidxh | String | 20 | Y | 网点编号 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"idNo":"372930***",
"name":"张三",
"mobile":"13333333333",
"uuidxh":"123456",
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态200成功500失败 | |
message | string | - | Y | 具体请求信息 |
参数名 | 说明 |
---|---|
content | 状态码00返回该参数 |
sfzjhm | 身份证号码 |
returnCode | 响应编码00成功-1失败 |
returnMessage | 成功失败详情 |
- 响应示例
{
"code": "200",
"appid": "1118222213935587328",
"sign": "TCzSUcFTxCjW2JE8yVOB0WivdvHI3841LYjAMSGlwiqpmvZ194sB1PsP8G2tT43OYHakymg91sbCCWEWDzrjAEYWo+DqpG7soU4cf6NsP5bTVXC3lMoG9NGCKkoaFvHQHD3a5WarGVNlvGccHi7LZhBaeUcSQoJEnnJa2vAmq6I=",
"signType": "RSA",
"message": "{\"content\":{\"sfzjhm\":\"372930***\"},\"returnCode\":\"00\",\"returnMessage\":\"success\"}",
"nonceStr": "07Y5O5rpnw3N9tQSWrJc",
"timestamp": "1686724238452",
"reqMsgId": "a5f9224a58c94b6c924095d3869c85bf"
}
5.17.4 查询可开票类目信息
- 说明
税务提供接口模糊分页查询,查询出所有类目均为代征类目
接口API
/interface/invoice/get/type
请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
spxx | String | 20 | Y | 类目简称 | |
pageSize | String | 20 | Y | 每页数据条数 | |
pageNumber | String | 20 | Y | 分页页数 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"spxx":"水",
"pageSize":"1",
"pageNumber":"1"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态200成功500失败 | |
message | string | - | Y | 具体请求信息 |
message
参数名 | 说明 |
---|---|
content | 状态码00返回该参数 |
returnCode | 响应编码00成功-1失败 |
returnMessage | 成功失败详情 |
spList | 类目数据集合 |
spList
参数名 | 说明 |
---|---|
ggxh | 规格型号 |
jldw | 计量单位 |
rowId | 序号 |
spbm | 商品编码 |
spmc | 商品名称 |
zsl | 征收率 |
zspmDm | 征收品目代码 |
zspmmc | 征收品目名称 |
totalCount | 返回总数量 |
- 响应示例
{
"code": "200",
"appid": "1118222213935587328",
"sign": "J059KqXs0YgfZKsZLqVuCq/TOXPYvi15W5sJwzi9i/IW4xuXIHP7ZjvBT+fvl2uPikO98ZF0SmmYWu5Wg0E3W7rWnUCcs56IMtArv1klmDuK+o654WXkXWu5Aev4+75jbLzi5wjuMbOJU1KPgDXT2fhLfkBlgjGH4VaNH13t5X8=",
"signType": "RSA",
"message": "{\"content\":{\"spList\":[{\"ggxh\":\"\",\"isdzgrsds\":\"dz\",\"jldw\":\"\",\"rowId\":1,\"spbm\":\"99925\",\"spmc\":\"水管\",\"zsl\":\"0.01\",\"zspmDm\":\"101014006\",\"zspmmc\":\"商业\u00283%\u0029\"}],\"totalCount\":1},\"returnCode\":\"00\",\"returnMessage\":\"success\"}",
"nonceStr": "tOvot2zIWkiKhBgD7A05",
"timestamp": "1686726102358",
"reqMsgId": "ab0d0fbcaab94dfb9f9dc95f668c1b89"
}
5.17.5 计算税额
- 说明
计算出需要缴纳税额,申请创建发票接口会用到
接口API
/interface/invoice/jsse
请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
spmc | String | 20 | Y | 商品名称5.17.4 | |
invoiceFee | String | 20 | Y | 开票金算金额 | |
idNo | String | 20 | Y | 身份证号 | |
dksquuid | String | 32 | Y | 开票申请 uuid | |
zspmmc | String | 20 | Y | 征收品目名称5.17.4 | |
zspmDm | String | 20 | Y | 征收品目代码5.17.4 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"spmc":"水管",
"invoiceFee":"500.0",
"idNo":"372930***",
"dksquuid":"1118586525026643968",
"zspmmc":"商业",
"zspmDm":"101014006",
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态200成功500失败 | |
message | string | - | Y | 具体请求信息 |
message
参数名 | 说明 |
---|---|
bcse | 本次税额 |
bhsj | 不含税金额 |
dksquuid | 开票申请 uuid |
dsPmJo | 地税品目 |
hwmxJa | 货物明细 |
jshj | 价税合计 |
returnCode | 响应编码00成功-1失败 |
returnMessage | 成功失败详情 |
spZspmDm | 征收品目代码 |
ybtse | 应补退税额 |
zsl | 征收率 |
dsPmJo
参数名 | 说明 |
---|---|
totalSe | 地税税额 |
zspmList | 征收品目集合 |
zspmList
参数名 | 说明 |
---|---|
jmqse | 减免前税额 |
jmszldm | 减免税种类代码 |
jsgj | 计税根据 |
jsyj | 计税依据 |
phjmsbl | 品目减免税比例 |
phjmszldm | 品目减免税种类代码 |
qzd | 起征点 |
se | 税额 |
zsl | 征收率 |
zspmDm | 征收品目代码 |
zspmMc | 征收品目名称 |
zsxmDm | 征收项目代码 |
zsxmMc | 征收项目名称 |
zszmDm | 征收子目代码 |
zszmMc | 征收子目名称 |
hwmxJa
参数名 | 说明 |
---|---|
dj | 单价 |
dw | 单位 |
lx | 类型 |
mc | 名称 |
se | 税额 |
sl | 税率 |
status | 规格型号 |
xse | 销售额 |
zsl | 征收率 |
- 响应示例
{
"code": "200",
"appid": "1118222213935587328",
"sign": "IEPc3rn7hX8vcZaWkfgQ4vejVCz/SFjaO3mS2S9NazAnA3A3GXO95M1KsKR1idfA0XW/FrMC2fP8yYO6rAo9E14MhCkT/51KNtL6JVrL2eKFX6sH8CGN6wkdcMR118+JEcYcLEUlZnIwTyPKdu/pMVCI3zdOtdFDHdi2JMosxxw=",
"signType": "RSA",
"message": "{\"bcse\":\"0\",\"bhsj\":\"500.0\",\"dksquuid\":\"1118586525026643968\",\"dsPmJo\":{\"totalSe\":\"6.50\",\"zspmList\":[{\"jmqse\":\"0.0\",\"jmszldm\":\"\",\"jsgj\":\"0\",\"jsyj\":0.0,\"phjmsbl\":0.5,\"phjmszldm\":\"0007049901\",\"qzd\":\"\",\"se\":\"0.0\",\"zsl\":\"0.07\",\"zspmDm\":\"101090101\",\"zspmMc\":\"市区(增值税附征)\",\"zsxmDm\":\"10109\",\"zsxmMc\":\"城市维护建设税\",\"zszmDm\":\"\",\"zszmMc\":\"\"},{\"jmqse\":\"0.0\",\"jmszldm\":\"1\",\"jsgj\":\"0\",\"jsyj\":0.0,\"phjmsbl\":0.5,\"phjmszldm\":\"0099049901\",\"qzd\":100000,\"se\":\"0.0\",\"zsl\":\"0.02\",\"zspmDm\":\"302160100\",\"zspmMc\":\"增值税地方教育附加\",\"zsxmDm\":\"30216\",\"zsxmMc\":\"地方教育附加\",\"zszmDm\":\"\",\"zszmMc\":\"\"},{\"jmqse\":\"6.5\",\"jmszldm\":\"\",\"jsgj\":\"1\",\"jsyj\":500.0,\"phjmsbl\":0,\"phjmszldm\":\"0\",\"qzd\":\"\",\"se\":\"6.5\",\"zsl\":\"0.013\",\"zspmDm\":\"101060200\",\"zspmMc\":\"经营所得\",\"zsxmDm\":\"10106\",\"zsxmMc\":\"个人所得税\",\"zszmDm\":\"\",\"zszmMc\":\"\"},{\"jmqse\":\"0.0\",\"jmszldm\":\"1\",\"jsgj\":\"0\",\"jsyj\":0.0,\"phjmsbl\":0.5,\"phjmszldm\":\"0061049901\",\"qzd\":100000,\"se\":\"0.0\",\"zsl\":\"0.03\",\"zspmDm\":\"302030100\",\"zspmMc\":\"增值税教育费附加\",\"zsxmDm\":\"30203\",\"zsxmMc\":\"教育费附加\",\"zszmDm\":\"\",\"zszmMc\":\"\"}]},\"dtwd\":{\"djxh\":\"10213601880000296146\",\"kpkz\":\"0\",\"wdczryuuidxh\":\"C0591B500FA94A1D9F2562AC57D70728\",\"wddm\":\"33000401\",\"wdmc\":\"南昌市湾里邮政支局\"},\"hwmxJa\":[{\"dj\":500.0,\"dw\":\"个\",\"lx\":\"1\",\"mc\":\"水管\",\"se\":\"4.95\",\"sl\":\"1\",\"status\":\"P\",\"xse\":\"495.05\",\"zsl\":0.01}],\"jshj\":\"500.00\",\"returnCode\":\"00\",\"returnMessage\":\"\",\"spZspmDm\":\"101014006\",\"ybtse\":\"0.00\",\"zsl\":\"0.01\"}",
"nonceStr": "EGI5qFd1EvfEi5oN6FLA",
"timestamp": "1686733404140",
"reqMsgId": "f2feebc441ae415195a2e6b4ac474a25"
}
5.17.6 创建开票订单
- 说明
创建开票订单需要自然人
接口API
/interface/invoice/save
请求参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
businessId | String | 50 | Y | 企业编码 | |
idNo | String | 20 | Y | 身份证号 | |
name | String | 20 | Y | 姓名 | |
mobile | String | 20 | Y | 手机号 | |
companyMobile | String | 32 | Y | 企业电话 | |
companyName | String | 20 | Y | 企业名称 | |
companyAddr | String | 20 | Y | 企业地址 | |
creditCode | String | 20 | Y | 企业纳税人识别号 | |
bankAcct | String | 20 | Y | 银行卡号 | |
bankName | String | 20 | Y | 银行名称 | |
zspmDm | String | 20 | Y | 征收品目代码5.17.4 | |
totalSe | String | 20 | Y | 地税税额5.17.5 | |
jshj | String | 20 | Y | 价税合计5.17.5 | |
ybtse | String | 20 | Y | 应补退税额5.17.5 | |
uuidxh | String | 20 | Y | 网点编码 | |
dksquuid | String | 20 | Y | 开票申请 uuid | |
address | String | 20 | Y | 收票邮寄地址 | |
zsl | String | 20 | Y | 征收率5.17.5 | |
xse | String | 20 | Y | 销售额5.17.5 | |
se | String | 20 | Y | 税额5.17.5 | |
mc | String | 20 | Y | 名称5.17.4 | |
invoiceFee | String | 20 | Y | 开票金额 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"idNo":"372930***",
"name":"张三",
"mobile":"13333333333",
"companyMobile":"13000000000",
"companyName":"测试企业",
"companyAddr":"上海",
"creditCode":"99999999",
"bankAcct":"99999999",
"bankName":"测试银行",
"zspmDm":"101014006",
"totalSe":"6.50",
"jshj":"500.00",
"ybtse":"0.00",
"uuidxh":"33170401",
"dksquuid":"1118586525026643968",
"address":"上海",
"zsl":"0.03",
"xse":"495.05",
"se":"4.95",
"mc":"水管",
"invoiceFee":"500.00"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态200成功500失败 | |
message | string | - | Y | 具体请求信息 |
message
参数名 | 说明 |
---|---|
content | 状态码00返回该参数 |
returnCode | 响应编码00成功-1失败 |
returnMessage | 成功失败详情 |
content
参数名 | 说明 |
---|---|
dksquuidxh | 开票申请 uuid |
- 响应示例
{
"code": "200",
"appid": "1118222213935587328",
"sign": "bbMluT3MLb8E0STFwfHAvNOU0AYBNYGhzh07hlAaRvgWDwN7OnQyB64ygm1lS1UUNZ/1D8jeivYzNoAkMT7+vadf02kZ9BfirJlFFNxGVgF6we5zSTQIO7ZumuZhRq3RIHTwzmSwZXdfUdRndkqw3Be7o5TvINZZ3EqC+Q9/zrA=",
"signType": "RSA",
"message": "{\"content\":{\"dksquuidxh\":\"1118586525026643968\"},\"returnCode\":\"00\",\"returnMessage\":\"success\"}",
"nonceStr": "ibabLbsWS2KuIjsloTyj",
"timestamp": "1686738450045",
"reqMsgId": "8bdcb62c51954e2bbd2210bc1201e01f"
}
5.17.7 开票状态查询
- 说明
查询开票状态,
接口API
/interface/invoice/query
请求参数
参数名 | 类型 | 长度 | 是否必填 | 说明 | 说明 |
---|---|---|---|---|---|
businessId | string | 32 | Y | 企业编码 | |
dksquuid | string | 32 | Y | 开票申请 uuid |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"dksquuid":"1118586525026643968"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态200成功500失败 | |
message | string | - | Y | 具体请求信息 |
message
参数名 | 说明 |
---|---|
content | 状态码00返回该参数 |
returnCode | 响应编码00成功-1失败 |
returnMessage | 成功失败详情 |
content
参数名 | 说明 |
---|---|
bhsj | 不含税价 |
gmfMc | 购货方名称 |
gmfNsrsbh | 购货方纳税人识别号 |
hwlwmc | 货物类目名称 |
jshj | 价税合计 |
kddh | 快递单号 |
kdgs | 快递公司 |
lrrq | 录入日期 |
se | 税额 |
sqdztDm | 申请单状态代码 |
sqdztMc | 申请单状态名称 |
sqrq | 申请日期 |
uuidxh | 代开申请uuid |
wddm | 网点代码 |
xsfMc | 销售方名称 |
xsfNsrsbh | 销售方身份证号 |
yjje | 应缴金额 |
zfbz | 作废标志 |
- 响应示例
{
"code": "200",
"appid": "1118222213935587328",
"sign": "e8ZACGcYaeFMoL2aagsc/G+vEc46l9+YYnKDQK7XjGu3NkvzWf8MWRsvHm89gqbuNOmF/8dRYg1Qa9e+SwRSrUjqEo+wyGu2WFH6W+hbLrkMyylPAs/9I+sZJD2p2CE6Zqnm7nDvCtYFQoTtEcztsl8LR1ZrDA7mOfzLz1zvxQ8=",
"signType": "RSA",
"message": "{\"content\":{\"bhsj\":495.05,\"gmfMc\":\"测试企业\",\"gmfNsrsbh\":\"9999999\",\"hwlwmc\":\"水管\",\"jshj\":500,\"kddh\":\"\",\"kdgs\":\"\",\"lrrq\":1686738463000,\"se\":6.5,\"sqdztDm\":\"1\",\"sqdztMc\":\"已申请未扣款\",\"sqrq\":\"2023-06-14\",\"uuidxh\":\"1118586525026643968\",\"wddm\":\"33170401\",\"xsfMc\":\"张三\",\"xsfNsrsbh\":\"372930***\",\"yjje\":0,\"zfbz\":\"未作废\"},\"returnCode\":\"00\",\"returnMessage\":\"success\"}",
"nonceStr": "6cWstx1EPhHYF3k95E6z",
"timestamp": "1686798520805",
"reqMsgId": "0748d49550bc43a9954b374f258774da"
}
5.17.8 关闭开票订单
- 说明
每个人每月只可开5张,若申请不开会占用可开票数量
接口API
/interface/invoice/close
请求参数
参数名 | 类型 | 长度 | 是否必填 | 说明 | 说明 |
---|---|---|---|---|---|
businessId | string | 32 | Y | 企业编码 | |
dksquuid | string | 32 | Y | 开票申请 uuid |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"dksquuid":"1118586525026643968"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态200成功500失败 | |
message | string | - | Y | 具体请求信息 |
message
参数名 | 说明 |
---|---|
content | 状态码00返回该参数 |
returnCode | 响应编码00成功-1失败 |
returnMessage | 成功失败详情 |
- 响应示例
{
"appid": "1118222213935587328",
"code": "200",
"message": "{\"returnCode\":\"00\",\"returnMessage\":\"success\"}",
"nonceStr": "sUUTY5Age5lar7jnvCkU",
"reqMsgId": "133373e180944f4da2139daafcf0d4d1",
"signType": "RSA",
"timestamp": "1686801985205"
}
5.17.9 创建税金支付订单
- 说明
创建税金支付订单
接口API
/interface/invoice/create/payment
请求参数
参数名 | 类型 | 长度 | 是否必填 | 说明 | 说明 |
---|---|---|---|---|---|
businessId | string | 32 | Y | 企业编码 | |
batchId | string | 32 | Y | 不重复自拟批次id | |
totalAmount | BigDecimal | 10;2 | Y | 支付总金额 0.00 | |
time | Long | 4 | Y | 账单有效期,单位(分钟) | |
dxOutSubOrderNo | string | 32 | Y | 动鑫划分服务费单号 | |
serviceFee | BigDecimal | 10;2 | Y | 服务费金额 0.00 | |
yzOutSubOrderNo | string | 32 | Y | 税金划分单号 | |
taxes | BigDecimal | 10;2 | Y | 税金 0.00 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"batchId":"1213141516171819",
"totalAmount":"0.02",
"time":"15",
"dxOutSubOrderNo":"12131415161718",
"serviceFee":"0.01",
"yzOutSubOrderNo":"121314151617",
"taxes":"0.01"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态200成功500失败 | |
message | string | - | Y | 具体请求信息 |
message
参数名 | 说明 |
---|---|
code | 状态编码000000成功 |
msg | 成功失败详情 |
resp_time | 时间节点 |
resp_data | 账单详情 |
resp_data
参数名 | 说明 |
---|---|
merchant_no | 客户编号 |
channel_id | 渠道id |
out_order_no | 批次id |
order_create_time | 创建时间 |
order_efficient_time | 有效时间 |
pay_order_no | 订单支付单号 |
total_amount | 支付总金额(精确到分) 1为1分 |
counter_url | 支付账单地址 |
- 响应示例
{
"code": "200",
"appid": "1118222213935587328",
"sign": "C/vOulPqUXKSA1j9mcB8kyrVfSr2S4UIi5wqDugNeCf4OigFva7UtuUgoOljTkef6p1FFStO53MnwbQ+LTbCwYmjgcubHU+qubFKFay30ncByOi0DszVBtbCeTEeNM0cOfx6b0JmeLyWr7kjiIlvt8FGT+yFCM/bVx8aZD6i3xw=",
"signType": "RSA",
"message": "{\"code\":\"000000\",\"msg\":\"操作成功\",\"resp_time\":\"20230615155040\",\"resp_data\":{\"merchant_no\":\"82242109311001W\",\"channel_id\":\"95\",\"out_order_no\":\"1213141516171819\",\"order_create_time\":\"20230615155040\",\"order_efficient_time\":\"20230615160537\",\"pay_order_no\":\"23061511012001101011044496623\",\"total_amount\":\"2\",\"counter_url\":\"https://q.lakala.com/r/0000?pageStyle%3DV2%26token%3DCCSSDVzSg2qG7cEJUZLbg8gWwoxip1rVOYD88VZKXYGDvWebqCFtV0UVH4cy10sy1oZLx2vPIkcYI0rVUQ%3D%3D%26amount%3D2%26payOrderNo%3D23061511012001101011044496623\"}}",
"nonceStr": "a0t4aNjhSP0uoP2IAcw9",
"timestamp": "1686815430372",
"reqMsgId": "4bfb1ab74e114356922ba5f022972929"
}
5.17.10 查看账单状态
- 说明
账单支付账单状态,不支持回调,回调地址为税务局地址用于同步确认账单确实支付
接口API
/interface/invoice/pay/query
请求参数
参数名 | 类型 | 长度 | 是否必填 | 说明 | 说明 |
---|---|---|---|---|---|
businessId | string | 32 | Y | 企业编码 | |
batchId | string | 32 | Y | 账单id5.17.9 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"batchId":"1213141516171819"
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态200成功500失败 | |
message | string | - | Y | 具体请求信息 |
message
参数名 | 说明 |
---|---|
code | 状态编码000000成功 |
msg | 成功失败详情 |
resp_time | 时间节点 |
resp_data | 账单详情 |
resp_data
参数名 | 说明 |
---|---|
trans_merchant_no | 交易客户编号 |
merchant_no | 客户编号 |
trans_term_no | 交易终端号 |
term_no | 终端号 |
channel_id | 渠道id |
out_order_no | 批次id |
order_create_time | 创建时间 |
order_efficient_time | 有效时间 |
pay_order_no | 订单支付单号 |
total_amount | 支付总金额(精确到分) 1为1分 |
counter_url | 支付账单地址 |
order_info | 账单名称 |
order_status | 账单状态0待支付,1支付中,2支付成功,3支付失败,4已过期,5已取消,6已退款,7已关闭 |
settle_type | 账单类型 |
split_mark | 分账标志 |
out_split_info | 税金服务费分账明细 |
out_split_info
参数名 | 说明 |
---|---|
out_sub_order_no | 动鑫/分账订单号 |
merchant_no | 商户编码 |
term_no | 终端号 |
amount | 交易金额 |
settle_type | 分账类型 |
- 响应示例
{
"code": "200",
"appid": "1118222213935587328",
"sign": "Ed5XoYwiwWiu5Pd8xsvIN2yqG2EeLku6Mhm/Awh7PaSkr7vezguzraSzwkWIlD1TzRLgoZDLQgBlm+wiy0e5IrFe8TBGaiyycyeSDlpMcIlRY64frCnJsz7bMyy7Ymf3Iq3J7nqJv6/kZBrwYaXBST6wusUEvf6LmXO8R+Mm/tw=",
"signType": "RSA",
"message": "{\"code\":\"000000\",\"msg\":\"操作成功\",\"resp_time\":\"20230615162228\",\"resp_data\":{\"pay_order_no\":\"23061511012001101011044496623\",\"out_order_no\":\"1213141516171819\",\"channel_id\":\"95\",\"trans_merchant_no\":\"\",\"trans_term_no\":\"\",\"merchant_no\":\"82242109311001W\",\"term_no\":\"D9338694\",\"order_status\":\"4\",\"order_info\":\"代理开票订单创建\",\"total_amount\":2,\"order_create_time\":\"20230615155040\",\"order_efficient_time\":\"20230615160537\",\"settle_type\":\"0\",\"split_mark\":\"1\",\"counter_param\":null,\"counter_remark\":null,\"busi_type_param\":\"\",\"sgn_info\":[],\"goods_mark\":\"\",\"goods_field\":\"\",\"out_split_info\":[{\"out_sub_order_no\":\"12131415161718\",\"merchant_no\":\"82229009311000F\",\"term_no\":\"F0038801\",\"amount\":\"1\",\"settle_type\":\"0\"},{\"out_sub_order_no\":\"121314151617\",\"merchant_no\":\"82242109311001W\",\"term_no\":\"D9338694\",\"amount\":\"1\",\"settle_type\":\"0\"}]}}",
"nonceStr": "fwtd29xUR5hDsct1rx0t",
"timestamp": "1686817338911",
"reqMsgId": "dad637ab3be74431a5fc919dbe3dc3af"
}
5.17.11 推送税金支付成功
- 说明
用于税务局确认税金已经支付,不推送发票无法开出
接口API
/interface/invoice/pay/upload
请求参数
参数名 | 类型 | 长度 | 是否必填 | 说明 | 说明 |
---|---|---|---|---|---|
businessId | string | 32 | Y | 企业编码 | |
batchId | string | 32 | Y | 账单id-----5.17.9 | |
payOrderNo | string | 32 | Y | 拉卡拉订单号-----5.17.9 | |
totalAmount | BigDecimal | 10;2 | Y | 账单总金额------5.17.9 | |
yzOutSubOrderNo | string | 32 | Y | 税金单号------5.17.9 | |
taxes | BigDecimal | 10;2 | Y | 税额------5.17.9 | |
dksquuidxhs | List | Y | 发票编号,支持多个发票单号合并创建支付订单 |
dksquuidxhs
参数名 | 说明 |
---|---|
dksquuid | 开票申请 uuid-----5.17.6 |
- 请求示例
{
"sign": "111",
"signType": "RSA",
"nonceStr": "MPzteIbCc0JiJRDWxsTQ",
"reqMsgId":"RENYJ8aN0d579i1OpL01455015",
"appid":"111",
"timestamp":"1645770163620",
"data":{
"businessId":"923947685818540032",
"batchId":"1213141516171819",
"payOrderNo":"23061511012001101011044496623",
"totalAmount":"0.02",
"yzOutSubOrderNo":"121314151617",
"taxes":"0.01",
"dksquuidxhs":["1118586525026643968"],
}
}
- 响应参数
参数名 | 类型 | 长度 | 是否必填 | 示例 | 说明 |
---|---|---|---|---|---|
code | string | 20 | Y | 接口请求状态200成功500失败 | |
message | string | - | Y | 具体请求信息 |
message
参数名 | 说明 |
---|---|
content | 状态码00返回该参数 |
returnCode | 响应编码00成功-1失败 |
returnMessage | 成功失败详情 |
- 响应示例
{
"code": "200",
"appid": "1118222213935587328",
"sign": "J7u7CztHyGYbXVxc0iGaKAuPX6Ai7pIN6HQBCOHzcLLaUfhCrWONg1WaE66hrPVYd6U2WD+4V3U9DIB2g5nW+0ufZC0FGaQzEfepZ2y9ZpRG4iJf0S9lfbH48lzOfD8IswhXZvDkyGgpcDjS/V3w1ESA4CCCrDpIcNL8+Wp6WwM=",
"signType": "RSA",
"message": "{\"returnCode\":\"-1\",\"returnMessage\":\"税金核验失败,发送的税金 ==1||| 库中查询到的税金 ==650\"}",
"nonceStr": "SaXLIapc9IEgATTkRbsK",
"timestamp": "1686881275479",
"reqMsgId": "b1219c787f9d494387da1c547615f785"
}
6.公共字典说明
6.1灵活用工场景编码
码值 | 说明 |
---|---|
1 | 计算机软件服务 |
2 | 财务/审计/税务服务 |
3 | 人力资源服务 |
4 | 企业服务 |
5 | 技术服务 |
6 | 会展服务 |
7 | 酒店服务 |
8 | 信息/信息安全服务 |
9 | 运营商/增值服务 |
10 | 咨询服务 |
11 | 电子/半导体/集成电路服务 |
12 | 专利/商标/知识产权服务 |
13 | 翻译服务 |
14 | 安保服务 |
15 | 广告/公关服务 |
16 | 学术/科研服务 |
17 | 法律服务 |
18 | 检测/认证/鉴证服务 |
19 | 物流/仓储服务 |
20 | 交通/运输服务 |
21 | 其他服务 |
22 | 文化/体育/娱乐/影视服务 |
23 | 家政/物业服务 |
24 | 婚庆/摄影服务 |
25 | 环保服务 |
26 | 美容/美发服务 |
27 | 音视频服务 |
28 | 汽车服务 |
29 | 餐饮服务 |
30 | 工程施工/勘察服务 |
31 | 经纪代理服务 |
32 | 专业设计服务 |
33 | 工程设计服务 |
34 | 新闻/出版服务 |
35 | 招标/投标服务 |
36 | 旅游服务 |
6.2账户交易类型字典
码值 | 说明 |
---|---|
01 | 充值 |
02 | 提现 |
03 | 结算服务费 |
04 | 结算佣金 |
05 | 调账(转入) |
06 | 调账(转出) |
07 | 异名充值 |
08 | 发放退款 |
09 | 提现手续费 |
10 | 错误充值 |
11 | 错误充值退款 |
12 | 提现手续费冲正 |
13 | 佣金手续费冲正 |
14 | 结算银行退汇 |
15 | 提现银行退汇 |
6.3发票类型字典
码值 | 说明 |
---|---|
1 | 增值税普通发票 |
2 | 增值税专用发票 |
3 | 增值税普通电子发票 |
4 | 增值税专用电子发票 |
6.4白名单类型
码值 | 说明 |
---|---|
1 | 实名 |
2 | 银行卡校验 |
3 | 董监高 |
4 | 年龄限制 |
7.错误编码
编码 | 说明 |
---|---|
100-0001-001 | 签名为空 |
100-0001-002 | 签名验证失败 |
100-0002-001 | 签名类型为空 |
100-0002-002 | 签名类型不支持 |
100-0003-001 | 请求时间戳为空 |
100-0003-002 | 请求时间戳校验失败 |
100-0004-001 | 批次ID为空 |
100-0004-002 | 批次ID已存在 |
100-0004-003 | 批次ID超长 |
100-0005-001 | 开始时间已存在 |
100-0006-001 | 请求编码为空 |
100-0006-002 | 请求编码超长 |
100-0006-003 | 请求编码已存在 |
100-0007-001 | 平台编码为空 |
100-0008-001 | 日期为空 |
100-0008-002 | 日期格式错误 |
100-0008-003 | 日期超长 |
100-0009-001 | 回调URL为空 |
100-0009-002 | 回调URL超长 |
100-0010-001 | 序列号为空 |
100-0010-002 | 序列号超长 |
100-0011-001 | 远端IP非法 |
100-0012-001 | APPID错误 |
100-0013-001 | 备注超长 |
100-0014-001 | 随机字符串为空 |
100-0014-002 | 随机字符串超长 |
100-0014-003 | 随机字符串校验失败 |
101-0001-001 | 自由职业者姓名为空 |
101-0001-002 | 自由职业者姓名超长 |
101-0002-001 | 自由职业者证件号码为空 |
101-0002-002 | 自由职业者证件号码超长 |
101-0002-003 | 自由职业者证件号码格式错误 |
101-0003-001 | 自由职业者联系方式为空 |
101-0003-002 | 自由职业者联系方式超长 |
101-0003-003 | 自由职业者联系方式格式错误 |
101-0004-001 | 自由职业者银行卡号或支付宝账号为空 |
101-0004-002 | 自由职业者银行卡号不支持 |
101-0004-003 | 自由职业者银行卡号或支付宝账号超长 |
101-0005-001 | 自由职业者结算金额为空 |
101-0005-002 | 自由职业者结算金额非数字 |
101-0006-001 | 自由职业者认证类型为空 |
101-0006-002 | 自由职业者认证类型非法 |
101-0006-003 | 自由职业者认证类型超长 |
101-0007-001 | 自由职业者签约未签约 |
101-0008-001 | 自由职业者不存在 |
101-0009-001 | 自由职业者合同为空 |
103-0001-001 | 招募数量为空 |
103-0002-001 | 招募数据为空 |
103-0002-002 | 招募数据不完整 |
103-0002-003 | 招募数据不能超过5000条 |
103-0003-001 | 批次号不存在 |
103-0004-001 | 回单地址未生成 |
103-0005-001 | 结算总金额为空 |
103-0006-001 | 结算总笔数为空 |
103-0007-001 | 结算子账户为空 |
103-0007-002 | 结算子账户超长 |
103-0007-003 | 结算子账户非法 |
103-0007-004 | 结算子账户余额不足 |
103-0007-005 | 结算子账户已冻结 |
103-0008-001 | 支付通道超长 |
104-0001-001 | 企业名称为空 |
104-0001-002 | 企业名称超长 |
104-0002-001 | 企业征信编码为空 |
104-0002-002 | 企业征信编码超长 |
104-0003-001 | 企业地址为空 |
104-0003-002 | 企业地址超长 |
104-0004-001 | 企业电话为空 |
104-0004-002 | 企业电话超长 |
104-0005-001 | 灵活用工场景为空 |
104-0006-001 | 企业注册资本为空 |
104-0006-001 | 企业注册资本格式化失败,需为数字 |
104-0007-001 | 企业注册时间为空 |
104-0007-002 | 企业注册时间超长 |
104-0007-003 | 企业注册时间格式化错误 |
104-0008-001 | 企业开户行为空 |
104-0008-002 | 企业开户行超长 |
104-0009-001 | 企业银行账户为空 |
104-0009-002 | 企业银行账户超长 |
104-0010-001 | 企业开户行行号为空 |
104-0010-002 | 企业开户行行号超长 |
104-0011-001 | 企业联系人为空 |
104-0011-002 | 企业联系人超长 |
104-0012-001 | 企业联系人电话为空 |
104-0012-002 | 企业联系人电话超长 |
104-0013-001 | 企业法人姓名为空 |
104-0013-002 | 企业法人姓名超长 |
104-0014-001 | 企业法人证件号码为空 |
104-0014-002 | 企业法人证件号码超长 |
104-0015-001 | 企业营业执照为空 |
104-0016-001 | 企业开户许可证为空 |
104-0017-001 | 办公场地门头照为空 |
104-0018-001 | 办公场地照片为空 |
104-0019-001 | 办公场地前台照为空 |
104-0020-001 | 企业已注册 |
104-0021-001 | 企业不存在 |
104-0022-001 | 企业编码为空 |
104-0022-002 | 企业编码超长 |
104-0023-001 | 企业邮箱超长 |
104-0024-001 | 经营范围超长 |
104-0025-001 | 所属行业超长 |
104-0026-001 | 推荐码超长 |
104-0027-001 | 回调通知url超长 |
105-0001-001 | 企业开票信息不存在 |
105-0001-001 | 园区编码为空 |
106-0001-001 | 项目类型为空 |
106-0001-002 | 项目类型不支持 |
106-0002-001 | 项目标题为空 |
106-0002-002 | 项目标题已存在 |
106-0002-003 | 项目标题超长 |
106-0003-001 | 项目结算方式为空 |
106-0003-002 | 项目结算方式超长 |
106-0004-001 | 项目佣金最低值为空 |
106-0004-002 | 项目佣金最低值超限制 |
106-0005-001 | 项目佣金最高值超限制 |
106-0006-001 | 项目分期为空 |
106-0006-002 | 项目分期超长 |
106-0006-003 | 项目分期不支持 |
106-0007-001 | 项目验收时间类型为空 |
106-0007-002 | 项目验收时间类型超长 |
106-0008-001 | 验收频率为空 |
106-0008-002 | 验收频率超长 |
106-0009-001 | 项目编码为空 |
106-0009-002 | 项目编码不存在 |
106-0010-001 | 项目分期时间为空 |
106-0010-002 | 项目分期时间格式不正确 |
106-0011-001 | 项目验收时间为空 |
106-0011-002 | 项目验收时间格式不正确 |
106-0011-003 | 项目验收时间超长 |
106-0012-001 | 项目状态为空 |
106-0012-002 | 项目状态不支持 |
107-0001-001 | 任务类型为空 |
107-0001-002 | 任务类型不支持 |
107-0001-003 | 任务类型超长 |
107-0002-001 | 任务标题为空 |
107-0002-002 | 任务标题已存在 |
107-0002-003 | 任务标题超长 |
107-0003-001 | 任务结算方式为空 |
107-0003-002 | 任务结算方式超长 |
107-0004-001 | 任务佣金最低值为空 |
107-0005-001 | 任务分期为空 |
107-0005-002 | 任务分期超长 |
107-0006-001 | 任务验收时间类型为空 |
107-0006-002 | 任务验收时间类型超长 |
107-0007-001 | 招募模式为空 |
107-0007-002 | 招募模式超长 |
107-0008-001 | 交付模式为空 |
107-0008-002 | 交付模式超长 |
107-0008-001 | 交付模式不支持 |
107-0009-001 | 任务编码为空 |
107-0009-002 | 任务不存在 |
107-0009-003 | 任务编码已存在 |
107-0009-004 | 任务编码超长 |
107-0011-001 | 招募方式不支持 |
107-0012-001 | 任务分期时间为空 |
107-0012-002 | 任务分期时间格式不正确 |
107-0013-001 | 任务验收时间为空 |
107-0013-002 | 任务验收时间格式不正确 |
107-0013-003 | 任务验收频率错误 |
107-0013-004 | 任务验收频率为空 |
106-0014-001 | 任务状态不可招募 |
107-0010-001 | 任务描述超长 |
112-0001-001 | 发票申请订单号为空 |
112-0001-002 | 发票申请订单号超长 |
112-0001-003 | 发票申请订单号不存在 |
112-0001-003 | 发票申请订单号已存在 |
112-0002-001 | 一级开票类目为空 |
112-0002-002 | 一级开票类目不匹配 |
112-0002-003 | 一级开票类目超长 |
112-0003-001 | 二级开票类目为空 |
112-0003-002 | 二级开票类目不匹配 |
112-0003-003 | 二级开票类目企业不支持 |
112-0003-004 | 二级开票类目超长 |
112-0004-001 | 发票金额为空 |
112-0004-002 | 发票金额低于最低开票限制 |
112-0005-001 | 发票类型为空 |
112-0005-002 | 发票类型非法 |
112-0005-003 | 发票类型超长 |
112-0006-001 | 发票抬头地址为空 |
112-0007-001 | 发票抬头电话为空 |
112-0008-001 | 发票抬头开户行为空 |
112-0009-001 | 可开票金额未查到 |
112-0009-002 | 可开票金额不足 |
112-0010-001 | 发票邮寄用户名为空 |
112-0011-001 | 发票邮寄用户手机号为空 |
112-0012-001 | 发票邮寄地址为空 |
112-0013-001 | 发票抬头银行账户为空 |
113-0001-001 | 白名单类型为空 |
113-0001-002 | 白名单类型非法 |
113-0001-003 | 白名单类型超长 |
113-0002-001 | 白名单数量不能超过100条 |
114-0001-001 | 身份证照片不匹配 |
114-0001-002 | 身份证照片识别失败 |
115-0001-001 | 身份证照片为空 |
115-0002-001 | 文件上传失败 |
999-9999-999 | 系统异常请联系管理员 |