2.0-结算管理

与第三方系统同步灵活就业结算信息

2.1 机构查询接口

简要描述

• 获取对应产品编号下所有机构信息

请求 URL

• /settlement/openapi/v3/org/find_by_productCode

请求方式

• GET

返回类型

• JSON

请求参数说明

参数名称	参数类型	必填	参数说明	备注
productCode	string	Y	产品编号

返回参数说明

参数名称	参数类型	参数说明	备注
msg	string	返回结果描述
code	string	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	list	返回数据	机构信息列表

机构信息列表参数说明

参数名称	参数类型	参数说明	备注
orgId	Long	机构id
orgName	string	机构名称
phone	string	企业电话
bankName	string	开户银行
bankAccount	string	银行账号
categoryNames	List	开票类目信息列表

正确返回示例

{
  "requestId": "8cee4b50f2597fa7",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": [
    {
      "orgId": 1,
      "orgName": "纽业态（上海）信息科技有限公司",
      "phone": 16643567898,
      "bankName": "上海招商银行",
      "bankAccount": 6214831154817511,
      "categoryNames": [
        "*信息技术服务*信息系统增值服务",
        "*物流辅助服务*装卸搬运服务",
        "现代服务*技术服务",
        "*信息技术服务*软件维护服务",
        "*物流辅助服务*运输组织服务",
        "*生活服务*家政服务",
        "*体育服务*体育管理服务",
        "*会展服务*会议服务",
        "*其他咨询服务*教育信息咨询",
        "*文化服务*文化服务",
        "*现代服务*市场推广",
        "*现代服务*渠道搭建及使用",
        "*信息技术服务*相关电路技术支持服务",
        "*信息技术服务*业务流程管理服务",
        "*会展服务*展览服务",
        "*信息技术服务*软件开发服务",
        "*生活服务*家居产品维保",
        "*信息技术服务*电路设计服务",
        "*现代服务*市场营销",
        "现代服务*信息服务",
        "*信息技术服务*电子商务平台服务",
        "*信息技术服务*信息系统服务",
        "*文化服务*文艺创作服务",
        "*教育辅助服务*招生服务",
        "*生活服务*代驾服务",
        "现代服务*其他现代服务",
        "*信息技术服务*技术服务费",
        "*信息技术服务*电路测试服务",
        "*企业管理服务*其他企业管理服务",
        "*设计服务*专业设计服务",
        "*设计服务*文印晒图服务",
        "*一般税务咨询*咨询服务",
        "*其他咨询服务*技术咨询",
        "*体育服务*体育指导服务",
        "*物流辅助服务*收派服务",
        "*生活服务*植物养护服务",
        "*其他咨询服务*咨询服务",
        "*会计咨询*咨询服务",
        "设计服务*设计制作费",
        "设计服务*设计优化咨询服务",
        "*生活服务*外卖配送服务",
        "*现代服务*营销策划服务费",
        "*现代服务*推广服务费",
        "*现代服务*音视频服务",
        "*物流辅助服务*货物打包整理",
        "*生活服务*保洁服务",
        "*生活服务*洗车服务",
        "*生活服务*其他居民日常服务",
        "物流辅助服务*配送服务费",
        "*信息技术服务*软件测试服务"
      ]
    }
  ],
  "errorData": null
}

错误返回示例

{
  "msg": "参数缺失",
  "code": "010001",
  "success": false,
  "data": null
}

2.2 发放信息查询接口

简要描述

• 发放信息查询接口(仅支持查看支付和退款的记录)
• 退款的明细订单与原订单的映射关系：退款明细订单的subExtraCode字段=原明细订单的subOrderCode

请求 URL

• /settlement/openapi/v3/order/page

请求方式

• GET

返回类型

• JSON

请求参数说明

参数名称	参数类型	必填	参数说明	备注
createDateStart	string	Y	开始时间 yyyy-MM-dd
createDateEnd	string	Y	结束时间 yyyy-MM-dd
productCode	string	Y	产品编号
orgId	Long	N	机构id
orderType	string	Y	订单类型:2支付 5退款
pageNo	Integer	Y	页码 默认：1
pageSize	Integer	Y	每页数量 默认：20

返回参数说明

参数名称	参数类型	参数说明	备注
msg	string	返回结果描述
code	string	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	object	返回数据	分页对象

分页对象参数说明

参数名称	参数类型	参数说明	备注
pageNo	integer	页码
pageSize	integer	分页条数
pageCount	integer	总页数
totalCount	integer	总数
entityList	list	明细列表

明细参数说明

参数名称	参数类型	参数说明	备注
orgId	Long	机构id
productCode	string	产品编号
orderCode	string	订单编号
orderType	string	订单类型:2支付 5退款
totalAmount	BigDecimal	总金额
totalTaskServiceAmount	BigDecimal	任务服务费总金额
orderStatus	string	订单状态：3部分成功4全部成功5失败
orderDetails	list	订单明细列表
orderDetails.subOrderCode	string	子订单号
orderDetails.subOrderStatus	string	子订单状态：1待处理2成功3失败
orderDetails.oppositeAccountName	string	对方开户名
orderDetails.oppositeCardNo	string	身份证
orderDetails.oppositePhone	string	手机号
orderDetails.oppositeAccountNo	string	对方账户号
orderDetails.amount	BigDecimal	交易金额
orderDetails.subExtraCode	string	子外部编码
orderDetails.taskServiceAmount	BigDecimal	任务服务费金额
orderDetails.remark	string	备注
orderDetails.failMsg	string	失败原因
orderDetails.createTime	string	创建时间 yyyy-MM-dd HH:mm:ss

正确返回示例

{
  "requestId": "94b958ea66323d67",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": {
    "pageNo": 1,
    "pageSize": 3,
    "pageCount": 1,
    "totalCount": 3,
    "entityList": [
      {
        "orgId": 289,
        "productCode": "P202000401",
        "orderCode": "2230414000000002",
        "orderType": "2",
        "totalAmount": 1.23,
        "orderStatus": "6",
        "totalTaskServiceAmount": 0.09,
        "orderDetails": [
          {
            "subOrderCode": "3230414000000002",
            "subOrderStatus": "1",
            "oppositeAccountName": "吴客",
            "oppositeCardNo": "32083019810311583X",
            "oppositePhone": "18221961478",
            "oppositeAccountNo": "6214831154817511",
            "amount": 1.23,
            "subExtraCode": null,
            "taskServiceAmount": 0.09,
            "remark": null,
            "createTime": "2023-04-14 13:33:50",
            "failMsg": null
          }
        ]
      },
      {
        "orgId": 289,
        "productCode": "P202000401",
        "orderCode": "2230414000000001",
        "orderType": "2",
        "totalAmount": 0.02,
        "orderStatus": "6",
        "totalTaskServiceAmount": 0.01,
        "orderDetails": [
          {
            "subOrderCode": "3230414000000001",
            "subOrderStatus": "1",
            "oppositeAccountName": "吴客",
            "oppositeCardNo": "32083019810311583X",
            "oppositePhone": "18221961478",
            "oppositeAccountNo": "6214831154817511",
            "amount": 0.02,
            "subExtraCode": null,
            "taskServiceAmount": 0.01,
            "remark": null,
            "createTime": "2023-04-14 13:22:18",
            "failMsg": null
          }
        ]
      },
      {
        "orgId": 289,
        "productCode": "P202000401",
        "orderCode": "2230404000000001",
        "orderType": "2",
        "totalAmount": 0.02,
        "orderStatus": "4",
        "totalTaskServiceAmount": 0.01,
        "orderDetails": [
          {
            "subOrderCode": "3230404000000001",
            "subOrderStatus": "2",
            "oppositeAccountName": "颜钲奇",
            "oppositeCardNo": "320721198911180812",
            "oppositePhone": "18221961125",
            "oppositeAccountNo": "6214830219951485",
            "amount": 0.02,
            "subExtraCode": "DTL230404000000000001",
            "taskServiceAmount": 0.01,
            "remark": null,
            "createTime": "2023-04-04 11:18:43",
            "failMsg": null
          }
        ]
      }
    ],
    "firstEntityIndex": 0,
    "needPage": true
  },
  "errorData": null
}

错误返回示例

{
  "msg": "参数缺失",
  "code": "010001",
  "success": false,
  "data": null
}

2.3 发票列表查询接口

简要描述

• 发票列表查询接口
• 只支持查看已申请、已开票、已驳回、已邮寄的发票

请求 URL

• /settlement/openapi/v3/invoice/page

请求方式

• GET

返回类型

• JSON

请求参数说明

参数名称	参数类型	必填	参数说明	备注
createDateStart	string	Y	开始时间 yyyy-MM-dd
createDateEnd	string	Y	结束时间 yyyy-MM-dd
productCode	string	Y	产品编号
orgId	Long	N	机构id
status	string	N	发票状态:2已申请 3已开票 5已邮寄 6已驳回
pageNo	Integer	Y	页码 默认：1
pageSize	Integer	Y	每页数量 默认：20

返回参数说明

参数名称	参数类型	参数说明	备注
msg	string	返回结果描述
code	string	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	object	返回数据	分页对象

分页对象参数说明

参数名称	参数类型	参数说明	备注
pageNo	integer	页码
pageSize	integer	分页条数
pageCount	integer	总页数
totalCount	integer	总数
entityList	list	明细列表

明细参数说明

参数名称	参数类型	参数说明	备注
orgId	Long	机构id
productCode	string	产品编号
invoiceCode	string	发票编号
companyName	string	企业名称
realAmount	BigDecimal	实际发票金额
status	string	发票状态:2已申请 3已开票 5已邮寄 6已驳回
title	string	发票抬头
taxNo	string	税号
address	string	注册地址
categoryName	string	发票开票类目名称
applyInvoiceCount	Integer	申请发票张数
remark	string	备注
bankName	string	开户银行
bankAccount	string	银行账号
postName	string	收件人姓名
postPhone	string	收件人手机号
postAddress	string	收件人地址
invoiceFiles	list	附件地址
createTime	string	创建时间 yyyy-MM-dd HH:mm:ss

附件地址参数说明

参数名称	参数类型	参数说明	备注
invoicefileCode	string	地址

正确返回示例

{
  "requestId": "44bb5e680d903bb3",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": {
    "pageNo": 1,
    "pageSize": 20,
    "pageCount": 1,
    "totalCount": 2,
    "entityList": [
      {
        "orgId": 401,
        "productCode": "P202102003",
        "invoiceCode": "4230511000000004",
        "companyName": "灵涌测试机构",
        "realAmount": 123123.0000,
        "status": "3",
        "title": "灵涌测试机构",
        "taxNo": "20230505001",
        "address": "上海市浦东新区博成路568号中国黄金大厦B座7楼703室",
        "categoryName": "*信息技术服务*电路设计服务",
        "applyInvoiceCount": 1,
        "remark": "123",
        "bankName": "招商银行",
        "bankAccount": "3290",
        "postName": "李先生",
        "postPhone": "18222223333",
        "postAddress": "上海市浦东新区博成路568号中国黄金大厦B座7楼703室",
        "invoiceFiles": [
          {
            "invoicefileCode": "https://js.alitatest.cn/anon/file/download/116e21eb44974f32a8032dca29dbfff1"
          },
          {
            "invoicefileCode": "https://js.alitatest.cn/anon/file/download/6a67c27c3f0a4018b4ac70273c356144"
          }
        ],
        "createTime": "2023-05-11 13:51:11"
      },
      {
        "orgId": 289,
        "productCode": "P202102003",
        "invoiceCode": "4230511000000001",
        "companyName": "颜钲奇测试机构",
        "realAmount": 0.0000,
        "status": "3",
        "title": "颜钲奇测试机构",
        "taxNo": "颜钲奇测试机构",
        "address": "颜钲奇测试机构",
        "categoryName": null,
        "applyInvoiceCount": 0,
        "remark": null,
        "bankName": "颜钲奇测试机构",
        "bankAccount": "颜钲奇测试机构",
        "postName": "颜钲奇测试机构",
        "postPhone": "12312312311",
        "postAddress": "颜钲奇测试机构",
        "invoiceFiles": null,
        "createTime": "2023-05-11 09:47:36"
      }
    ],
    "needPage": true,
    "firstEntityIndex": 0
  },
  "errorData": null
}

错误返回示例

{
  "msg": "参数缺失",
  "code": "010001",
  "success": false,
  "data": null
}

2.4 开票结果回调接口

简要描述

• 开票结果回调接口

请求 URL

• /settlement/openapi/v3/invoice/open

请求方式

• POST

请求类型

• form-data

返回类型

• JSON

请求参数说明

参数名称	参数类型	必填	参数说明	备注
invoiceCode	string	Y	发票code
openInvoiceCount	Integer	Y	实际开票张数
files	List.MultipartFile	Y	发票文件数组

返回参数说明

参数名称	参数类型	参数说明	备注
msg	string	返回结果描述
code	string	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	object	返回数据

正确返回示例

{
  "requestId": "95211f436f3a51c1",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": null,
  "errorData": null
}

错误返回示例

{
  "msg": "参数缺失",
  "code": "010001",
  "success": false,
  "data": null
}

2.5 签约用户信息查询接口

简要描述

• 签约用户信息查询接口

请求 URL

• /settlement/openapi/v3/user/page

请求方式

• GET

返回类型

• JSON

请求参数说明

参数名称	参数类型	必填	参数说明	备注
orgId	Long	N	机构id
productCode	string	Y	产品编号
pageNo	Integer	Y	页码 默认：1
pageSize	Integer	Y	每页数量 默认：20

返回参数说明

参数名称	参数类型	参数说明	备注
msg	string	返回结果描述
code	string	返回状态码	200 成功，其他均为失败
success	boolean	是否成功	true/false
data	object	返回数据	分页对象

分页对象参数说明

参数名称	参数类型	参数说明	备注
pageNo	integer	页码
pageSize	integer	分页条数
pageCount	integer	总页数
totalCount	integer	总数
entityList	list	明细列表

明细参数说明

参数名称	参数类型	参数说明	备注
realName	string	姓名
cardNo	string	身份证号
phone	string	手机号
contractFinalFilecode	string	合同下载链接

正确返回示例

{
  "requestId": "4290aa9e82e4458f",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": {
    "pageNo": 1,
    "pageSize": 11,
    "pageCount": 1,
    "totalCount": 1,
    "entityList": [
      {
        "realName": "张三",
        "cardNo": "230421198504121110",
        "phone": "18588261247",
        "contractFinalFilecode": "https://js.alitatest.cn/anon/file/download/01f485d680354e1ca96a1c61797661eb"
      }
    ],
    "needPage": true,
    "firstEntityIndex": 0
  },
  "errorData": null
}

错误返回示例

{
  "msg": "参数缺失",
  "code": "010001",
  "success": false,
  "data": null
}

2.6 账户列表

2.6.1 简要描述

账户信息列表

2.6.2 请求 URL

• /regulator/openapi/v3/prod_account/list

请求方式

• GET

返回类型

• JSON

2.6.3 请求参数

参数名称	参数类型	必填	参数说明	备注
productCode	String	Y	产品编号
orgId	Long	N	机构id

2.6.4 返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述
code	String	响应状态码	数据字典-0001-响应状态码
success	boolean	是否成功	true/false
data	Object	返回数据	详情见下表

返回数据明细（data）

参数名称	参数类型	参数说明	备注
orgId	Long	机构id
payAccountNo	String	账户号码
accountStatus	Integer	账户状态	1 –正常，2-挂失，3-冻结，4-销户
accountBalance	BigDecimal	账户余额
availableBalance	BigDecimal	可用余额
frozenAmount	BigDecimal	冻结金额
productCode	String	产品编号
abilityTypeCode	Integer	能力类型编号	10 -招商云直联 11 -支付宝 15 -微信
rechargeAccountNo	String	充值账号
rechargeAccountName	String	充值账号名
rechargeBankName	String	充值银行名称
rechargeBankBranchNo	String	充值银行支行号
rechargeBankAddress	String	充值银行开户地
remark	String	备注

2.6.5 接口成功返回示例

{
  "requestId": "01729f9cf0325f67",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": [
    {
      "orgId": 100,
      "payAccountNo": "221010121120001001",
      "accountStatus": 1,
      "accountBalance": 1000000,
      "availableBalance": 999818.74,
      "frozenAmount": 181.26,
      "productCode": "P202110001",
      "abilityTypeCode": 22,
      "rechargeAccountNo": "898901627110203",
      "rechargeAccountName": "上海",
      "rechargeBankName": "上海",
      "rechargeBankBranchNo": "1",
      "rechargeBankAddress": "898",
      "remark": null
    }
  ],
  "errorData": null
}

2.6.6 备注

更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码

2.7 账户充值流水查询（分页）

2.7.1 简要描述

查询账户充值流水

2.7.2 请求 URL

• /regulator/openapi/v3/prod_trade_detail/recharge/page

请求方式

• GET

返回类型

• JSON

2.7.3 请求参数(GET)

按照参数条件查询

参数名称	参数类型	必填	参数说明	备注
pageNo	Integer	N	页码	默认 1
pageSize	Integer	N	页数	默认 20 最大2000
productCode	String	Y	产品编号
payAccountNo	String	Y	交易账号	1.1接口中返回的账户号码
createTimeStart	String	N	创建时间起	格式 yyyy-MM-dd HH:mm:ss
createTimeEnd	String	N	创建时间止	格式 yyyy-MM-dd HH:mm:ss
tradeAmountStart	BigDecimal	N	交易金额起
tradeAmountEnd	BigDecimal	N	交易金额止

2.7.4 返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述
code	String	响应状态码	数据字典-0001-响应状态码
success	Boolean	是否成功	true/false
data	Object	返回数据	详情见下表

返回数据明细（data）

参数名称	参数类型	参数说明	备注
transactionSeq	String	交易流水号
amount	BigDecimal	交易金额
createTime	String	创建时间
remark	String	备注
oppositeAccountName	String	对方户名
oppositeBankName	String	对方银行
oppositeAccountNo	String	对方账户

2.7.5 接口成功返回示例

无参数

{
  "requestId": "478d1de4bc83a5ce",
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": {
    "pageNo": 1,
    "pageSize": 20,
    "pageCount": 1,
    "totalCount": 1,
    "entityList": [
      {
        "transactionSeq": "267186133104115722",
        "amount": 1000000,
        "createTime": "2021-12-19 10:29:46",
        "remark": null,
        "relationName": "版本票据测试9",
        "relationBank": "中国民生银行股份有限公司长春民丰大街支行",
        "relationAccount": "690035085"
      }
    ],
    "firstEntityIndex": 0,
    "needPage": true
  },
  "errorData": null
}

2.7.6 备注

更多返回错误代码请看首页的错误代码描述——数据字典-0001-响应状态码