6 计费API
API列表
6.0: 通用-查询用户信息
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/common/queryUserInfo
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
msgId | BODY | STRING | 是 | 随便填 |
请求Body描述(非Form表单数据)
{
"123": "123"
}
JSON
返回结果示例
{
"code": 200,
"data": {
"sign": 1,
"cityId": 308,
"type": 2,
"addressId": 1412296,
"communityTel": "0757-26337801",
"password": "",
"ico": "https://dctest.mideadc.com/pfile/group1/M00/92/29/ChBXR11Sm4iAdGFTAAAoqxtivCg233.png",
"province": "广东省",
"communityName": "美的翰诚嘉园",
"tel": "13825576676",
"jobCommunity": 1003837,
"jobName": "",
"qq": "",
"level": "",
"isCommunitySignExpress": "NO",
"provinceId": 1,
"telTagFlag": 1,
"profileFinishFlag": 1,
"name": "陈慧丽",
"organId": "0",
"levelUrl": "",
"organType": "",
"extFieldStr": "",
"job": "0",
"region": "顺德区",
"jobNumber": "",
"desc": "是的!这位邻居忘记说点什么了",
"status": "1",
"birthday": "",
"houseId": 14470652,
"city": "佛山市",
"houseList": [
{
"houseName": "物业服务中心一单元301",
"houseId": 14470652,
"roomNo": "301",
"custId": 15797170,
"custType": 1000,
"unitId": 68111,
"buildId": 68102,
"communityName": "美的翰诚嘉园",
"communityId": 0
}
],
"houseName": "美的翰诚嘉园物业服务中心一单元301",
"communityTagFlag": 1,
"submitAuthFlag": "1",
"identity": "",
"organCode": "",
"custId": "15797170",
"nickname": "陆建华",
"isDoor": "N",
"authType": 1,
"communityId": "1003837",
"email": "",
"sendExpressServiceTel": "小区未开通寄快递服务.",
"address": "",
"integalValue": 0,
"sex": "1",
"userDesc": "是的!这位邻居忘记说点什么了",
"userId": 300360626,
"masterUserId": "-1",
"organName": "",
"regionId": 323,
"growth": 0,
"subUserId": 0,
"age": 0,
"defaultAddress": "美的翰诚花园物业服务中心1单元0001"
},
"message": "success"
}
6.1: 通用-查询客户关联资源列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/common/queryResListByCustId
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实小区ID |
houseId | BODY | STRING | 是 | 房屋ID |
resInstType | BODY | STRING | 是 | 资源类型 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"custId": "客户ID",
"resInstType": "资源类型:1房屋、2车位"
}
{
"communityId":"1003837",
"custId":"4042630",
"houseId":"529086"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0 成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"resultList": [{
"resInstType": "资源类型:1房屋、2车位",
"resInstId": "资源ID",
"resInstName": "资源名称",
"resInstCode": "资源编码"
}]
}
}
6.2: 通用-查询资源关联客户列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/common/queryCustListByResId
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实小区ID |
resInstType | BODY | STRING | 是 | 资源类型 |
custType | BODY | STRING | 是 | 查询主业主:custType传1000、mainFlag传1 查询主业主和主租户:custType传空、mainFlag传1 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"resInstId": "资源ID",
"resInstType": "资源类型:1房屋、2车位",
"custType": "客户类型,1000业主、1001业主成员、2000租户、2001租户成员、4000访客(取值来源字典表code为CUSTOMER_TYPE)
",
"mainFlag": "是否主业主/主租户,1是,0否"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0 成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"resultList": [{
"custId": "客户ID",
"custName": "客户名称",
"custType": "客户类型",
"custStatus": "客户状态",
"mainFlag": "是否主业主/主租户,1是,0否"
}]
}
}
6.3: 缴费-查询总欠费
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/billPay/queryOwesTotal
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实小区ID |
houseId | BODY | STRING | 是 | 房屋ID |
resInstType | BODY | STRING | 是 | 资源类型 |
owesFlag | BODY | STRING | 是 | 只查询存在欠费的账期下所有账单,1:是、0或其他:否 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"custId": "客户ID",
"houseId": "房屋ID"
}
{
"communityId":"1003837",
"custId":"4042630",
"houseId":"529086"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"totalOwesFee": "总欠费金额",
"curMonthOwesFee": "本月欠费金额"
}
}
6.4: 缴费-查询账单列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/billPay/queryBillList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实小区ID |
houseId | BODY | STRING | 是 | 房屋ID |
custId | BODY | STRING | 是 | 客户ID |
resInstType | BODY | STRING | 否 | 资源类型 1房屋、2车位 |
resInstId | BODY | STRING | 否 | 资源ID |
owesFlag | BODY | STRING | 否 | 只查询存在欠费的账期下所有账单,1:是、0或其他:否 |
billingCycleYear | BODY | STRING | 否 | 查询年份 |
billingCycleStart | BODY | STRING | 否 | 开始账期 |
billingCycleEnd | BODY | STRING | 否 | 截止账期 |
请求Body描述(非Form表单数据)
{
"communityId":"1003837",
"custId":"4042630",
"houseId":"529086"
}
{
"communityId": "真实项目ID",
"custId": "客户ID",
"houseId": "房屋ID",
"resInstType": "资源类型,1房屋、2车位",
"resInstId": "资源ID",
"billingCycleYear": "查询年份,格式YYYY,例如:2019",
"billingCycleStart": "开始账期,格式YYYYMM,例如:201905",
"billingCycleEnd": "截止账期,格式YYYYMM,例如:201905",
"owesFlag": "只查询存在欠费的账期下所有账单,1:是、0或其他:否"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data":[{
"totalOwesFee":"",//总欠费金额
"curMonthOwesFee":"",//本月欠费金额
"cycleInfo":[,//各个月欠费
{
"cyclePayState": "2", //类型:String 必有字段 备注:0未支付,1:支付完成 ,2 支付部分
"acctPaidAmount": "2", //类型:String 必有字段 备注:已缴金额
"acctAmount": "4", //类型:String 必有字段 备注:帐单总额
"billCycle": "201908", //类型:String 必有字段 备注:账期ID
"acctUnAmount": "2", //类型:String 必有字段 备注:实际应付金额 = 未付金额 - 限制未付金额
"payFlag": "1", //类型:String 必有字段 备注:支付标识 0: 不能支付1:可以支付
"detail": [ //各个条目
{
"acctItemStr": "64140040-64140357", //类型:String 必有字段 备注:帐单id 串
"feeItemTypeId": "9248", //类型:String 必有字段 备注:费用科目
"feeItemTypeName": "20", //类型:String 必有字段 备注:费用科目名称
"fee": "33399900", //类型:String 必有字段 备注:帐单金额
"paidFee": "26710", //类型:String 必有字段 备注:已缴金额
"billPayState": "2", //类型:String 必有字段 备注:帐单付费状态 ( 0: 未付费 1:已付费 2:部分付费 )
"paidLfree": "0", //类型:String 必有字段 备注:已缴滞纳金
"lfree": "0", //类型:String 必有字段 备注:滞纳金
"lfreePayState": "1" //类型:String 必有字段 备注:滞纳金付费状态( 0: 未付费 1:已付费 2:部分付费 )
}
]
}
]
}]
}
6.5: 缴费-查询缴费记录列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/billPay/queryPayLogList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实小区ID |
houseId | BODY | STRING | 是 | 房屋ID |
custId | BODY | STRING | 是 | 客户ID |
pageLimit | BODY | STRING | 是 | 每页记录数 |
pageNo | BODY | STRING | 是 | 当前页数 |
userId | BODY | STRING | 是 | C端用户ID |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"custId": "客户ID",
"userId": "C端用户ID",
"payDateYear": "查询年份,格式YYYY,例如:2019",
"pageLimit": "每页记录数",
"pageNo": "当前页数"
}
{
"communityId": "1003837",
"custId": "4042630",
"userId": "42",
"payDateYear": "2019",
"pageLimit": "10",
"pageNo": "1"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"paginator": {
"pageLimit": 10,
"pageNo": 1,
"totalCount": 121,
"totalPage": 13
},
"resultList": [{
"paySerialNbr": "缴费流水号",
"payMethod": "支付方式编码",
"payMethodName": "支付方式名称",
"payAmont": "缴费金额",
"payDate": "缴费时间,格式:2016-12-03 00:00:00",
"transactionNo": "交易流水号",
"resInstName": "资源名称"
}]
}
}
6.6: 缴费-查询缴费记录明细列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/billPay/queryPayLogDetailList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实小区ID |
paySerialNbr | BODY | STRING | 是 | 缴费流水号 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"paySerialNbr": "缴费流水号"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "0",
"message": "success",
"data": {
"cycleDetail": [{
"billingCycle": "账期,格式:201612",
"cycleTotalFee": "账期小计金额(fee+lfree)",
"billDetail": [{
"acctItemStr ": "账单ID串",
"feeItemTypeId": "费用科目ID",
"feeItemTypeName": "费用科目名称",
"fee": "本金",
"lfree": "违约金"
}]
}]
}
}
6.7: 缴费-查询欠费
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/billPay/queryOwes
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实小区ID |
custId | BODY | STRING | 是 | 客户ID |
houseId | BODY | STRING | 是 | 房屋ID |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"custId": "客户ID",
"houseId": "房屋ID"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code":"0", //类型:String 必有字段 备注:无
"message":"success", //类型:String 必有字段 备注:无
"data": - { //类型:Object 必有字段 备注:无
"acctAmount ":"342432",
"disAmount":"-12", //类型:String 必有字段 备注:无
"payAmount":"342420", //类型:String 必有字段 备注:无
"ruleName":"缴一年减一月, 缴一年减一月", //类型:String 必有字段 备注:无
"ruleId":"1-2", //类型:String 必有字段 备注:无
"billDetail": - [ //类型:Array 必有字段 备注:无
- { //类型:Object 必有字段 备注:无
"billingCycle":"201606", //类型:String 必有字段 备注:无
"cycleAmount":"100", //类型:String 必有字段 备注:无
"billingStr":"164552-164553-164554-164555", //类型:String 必有字段 备注:无
"monthDetail": - [ //类型:Array 必有字段 备注:无
- { //类型:Object 必有字段 备注:无
"acctItemStr":"164552-164553", //类型:String 必有字段 备注:无
"feeItemTypeId":"6352", //类型:String 必有字段 备注:无
"feeItemTypeName":"物业管理费", //类型:String 必有字段 备注:无
"fee":"90", //类型:String 必有字段 备注:无
"lfree":"10", //类型:String 必有字段 备注:无
"taxRate":"10", //类型:String 必有字段 备注:无
"taxFee":"10", //类型:String 必有字段 备注:无
"acctBeginTime":"20151206000000", //类型:String 必有字段 备注:无
"acctEndTime":"20151231235959" //类型:String 必有字段 备注:无
},
- { //类型:Object 必有字段 备注:无
"acctItemStr":"164554-164555", //类型:String 必有字段 备注:无
"feeItemTypeId":"6352", //类型:String 必有字段 备注:无
"feeItemTypeName":"物业管理费", //类型:String 必有字段 备注:无
"fee":"90", //类型:String 必有字段 备注:无
"lfree":"10", //类型:String 必有字段 备注:无
"taxRate":"10", //类型:String 必有字段 备注:无
"taxFee":"10", //类型:String 必有字段 备注:无
"acctBeginTime":"20151206000000", //类型:String 必有字段 备注:无
"acctEndTime":"20151231235959" //类型:String 必有字段 备注:无
}
]
}
],
"disInfo": - [ //类型:Array 必有字段 备注:无
- { //类型:Object 必有字段 备注:无
"houseId":"284", //类型:String 必有字段 备注:无
"disFee": - [ //类型:Array 必有字段 备注:无
- { //类型:Object 必有字段 备注:无
"groupId":"1", //类型:String 必有字段 备注:无
"ruleId":"11", //类型:String 必有字段 备注:无
"ruleName":"缴一年减一月", //类型:String 必有字段 备注:无
"houseId":"123", //类型:String 必有字段 备注:无
"acctItemTypeId":"12", //类型:String 必有字段 备注:无
"feeItemTypeId":"12", //类型:String 必有字段 备注:无
"disfee":"-12", //类型:String 必有字段 备注:无
"dislfree":"0", //类型:String 必有字段 备注:无
"cycles":"3", //类型:String 必有字段 备注:无
"disType":"1", //类型:String 必有字段 备注:无
"billList":"164556-164557, 164558-164559" //类型:String 必有字段 备注:无
},
- { //类型:Object 必有字段 备注:无
"groupId":"1", //类型:String 必有字段 备注:无
"ruleId":"12", //类型:String 必有字段 备注:无
"ruleName":"缴一年减10元", //类型:String 必有字段 备注:无
"houseId":"123", //类型:String 必有字段 备注:无
"acctItemTypeId":"12", //类型:String 必有字段 备注:无
"feeItemTypeId":"12", //类型:String 必有字段 备注:无
"disfee":"-10", //类型:String 必有字段 备注:无
"dislfree":"0", //类型:String 必有字段 备注:无
"cycles":"1", //类型:String 必有字段 备注:无
"disType":"1", //类型:String 必有字段 备注:无
"billList":"164556-164557" //类型:String 必有字段 备注:无
},
- { //类型:Object 必有字段 备注:无
"groupId":"2", //类型:String 必有字段 备注:无
"ruleId":"13", //类型:String 必有字段 备注:无
"ruleName":"缴一年减10元", //类型:String 必有字段 备注:无
"houseId":"123", //类型:String 必有字段 备注:无
"acctItemTypeId":"12", //类型:String 必有字段 备注:无
"feeItemTypeId":"12", //类型:String 必有字段 备注:无
"disfee":"-10", //类型:String 必有字段 备注:无
"dislfree":"0", //类型:String 必有字段 备注:无
"billList":"164556-164557, 164558-164559" //类型:String 必有字段 备注:无
},
- { //类型:Object 必有字段 备注:无
"groupId":"2", //类型:String 必有字段 备注:无
"ruleId":"14", //类型:String 必有字段 备注:无
"ruleName":"缴一年减一月", //类型:String 必有字段 备注:无
"houseId":"123", //类型:String 必有字段 备注:无
"acctItemTypeId":"12", //类型:String 必有字段 备注:无
"feeItemTypeId":"12", //类型:String 必有字段 备注:无
"disfee":"-12", //类型:String 必有字段 备注:无
"dislfree":"0", //类型:String 必有字段 备注:无
"billList":"164556-164557, 164558-164559" //类型:String 必有字段 备注:无
}
]
}
]
}
}
6.8: 缴费-支付确认
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/billPay/payConfirm
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实小区ID |
acctItemIds | BODY | STRING | 是 | 缴费账单ID串 |
payAmount | BODY | STRING | 是 | 缴费总金额 |
houseId | BODY | STRING | 是 | 房屋ID |
custId | BODY | STRING | 是 | 客户ID |
userId | BODY | STRING | 是 | C端用户ID |
billAmount | BODY | STRING | 否 | 账单总金额(分),部分缴费时传欠费总额 |
channelCode | BODY | STRING | 否 | 缴费渠道编码: smart-house-keeper:云邻管家; midea-club:美地荟; |
请求Body描述(非Form表单数据)
{
"houseId":"14470652",
"communityId":1003837,
"custId":"15444370",
"userId":"50",
"disAmount":"0",
"notPayLfree":"0",
"acctItemIds":"59371294-63340694", //缴费账单ID串
"billAmount":"1", //账单总金额(分),部分缴费时传欠费总额
"payAmount":"1", //缴费总金额(分)
"disRuleIdStr":"", //优惠规则ID串
"payBzCode":"APP", //从支付方式获取过来的
"payMethod":1, //从支付方式获取过来的
"payWay":"WEIXIN", //从支付方式获取过来的
"tradeType":"WFT_APP", //从支付方式获取过来的
"system":"2048" , //固定写法
"method":"payConfirmV2", //固定写法
"appId":"wx6b0f99b562a6ab38" //微信支付商户号
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {
"charSet": "UTF-8",
"mchId": "1100014",
"nouceStr": "abce4aad5640115b2e74fd8653684046",
"sign": "82b22a1c13d0979d882730258682b9bc",
"resultCode": "0",
"errorCode": "0",
"addInfo": "bill:1003837,300360626",
"transactionId": "403580139785201908144693273820",
"errorMsg": "",
"result": "",
"signType": "MD5",
"vpayId": "AOL22201908141238470897760000000",
"payInfo": "{\"sign\":\"ep+EGuoM7f8E7zSnsso9Wmwp9j1zwuOna9xeLygkSH4/mSuK+D2bA6ldQGdcSvE5ITy6iAa7E/V6PN87UAAKu1hntIEjWcOqNFEUXp8+X+3GHL/Qd5FP4KqBN2EPOvPg26TR1873uyhgiOsN/pGdYrMSnwEBjNthVNcXsNACJmcNgdjdbrrUbhEpFPYv+NS9a3i+wZEtmp/zhDPgMB2jCXjXIkWg3ruWVAoz+gY7C/hzpwf/nfGa+FRC/K3DXLm5UVA9ybnEJDpPWG/03QRfp6VHosO79Gp3fcbFkiJ7ZW3gz5g06itfws/5Xuhdhuq13yL108kkIwF8PF3L8I1+DA==\",\"timestamp\":\"1565757529\",\"noncestr\":\"0f9ff6a76a6c42069ef29e9ba2e38c8f\",\"partnerid\":\"1332712401\",\"prepayid\":\"wx14123849655879560a049c6b1719859900\",\"package\":\"Sign=WXPay\",\"appid\":\"wx6b0f99b562a6ab38\"}"
},
"message": "success"
}
6.9: 缴费-查询缴费支付结果
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/billPay/payCallBack
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
businessId | BODY | STRING | 是 | 缴费唯一单号 |
totalAmount | BODY | STRING | 是 | 缴费金额 |
payUserId | BODY | STRING | 是 | 支付用户ID |
custId | BODY | STRING | 是 | 客户ID |
communityId | BODY | STRING | 是 | 真实项目ID |
请求Body描述(非Form表单数据)
{
"businessId": "缴费唯一单号",
"totalAmount": "缴费金额",
"payMethod": "支付方式",
"paySerialId": "交易流水号",
"payDate": "支付日期,格式:yyyy-MM-dd HH:mm:ss",
"payStatus": "支付状态,只传支付成功值:POK",
"communityId": "真实项目ID",
"custId": "客户ID",
"payUserId": "支付用户ID"
}
返回信息
返回参数类型
JSON
返回结果示例
{
"code": "0",
"message": "成功",
"data": {
"batchId": "缴费记录批次ID",
"payInfo": [{
"paySerialNbr": "缴费记录ID",
"type": "缴费业务类型"
}]
}
}
6.10: 缴费-支付方式
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/billPay/payMethodList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
businessId | BODY | STRING | 是 | 缴费唯一单号 |
totalAmount | BODY | STRING | 是 | 缴费金额 |
payUserId | BODY | STRING | 是 | 支付用户ID |
custId | BODY | STRING | 是 | 客户ID |
communityId | BODY | STRING | 是 | 真实项目ID |
请求Body描述(非Form表单数据)
{"communityId":1003837}
返回信息
返回参数类型
JSON
返回结果示例
{
"code": 200,
"data": {
"payMethods": [
{
"code": "WFT_APP",
"alaisName": "WEIXIN",
"name": "微信支付",
"id": "1",
"iconUrl": "",
"forwardUrl": ""
}
],
"resultCode": "0"
},
"message": "success"
}
6.11: 预存-查询可预存账户列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/queryCustListForBalance
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实项目ID |
resInstType | BODY | STRING | 是 | 资源类型:1房屋、2车位 |
resInstId | BODY | STRING | 否 | 资源类型:1房屋、2车位 |
userResList | BODY | STRING | 是 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"userResList": [{
"resInstId": "资源ID",
"resInstType": "资源类型:1房屋、2车位"
}]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0 成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"resultList": [{
"custId": "客户ID",
"custName": "客户名称",
"custType": "客户类型",
}]
}
}
6.12: 预存-查询可预存资源列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/queryResListForBalance
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实项目ID |
resInstType | BODY | STRING | 是 | 资源类型:1房屋、2车位 |
resInstId | BODY | STRING | 否 | 资源类型:1房屋、2车位 |
userResList | BODY | STRING | 是 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"custId": "客户ID",
"userResList": [{
"resInstId": "资源ID",
"resInstType": "资源类型:1房屋、2车位"
}]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0 成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"resultList": [{
"resInstType": "资源类型:1房屋、2车位",
"resInstId": "资源ID",
"resInstName": "资源名称",
"resInstCode": "资源编码"
}]
}
}
6.13: 预存-查询预存总余额
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/queryBalanceTotal
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实项目ID |
custId | BODY | STRING | 是 | 客户ID |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"custId": "客户ID",
"balanceType": "账本类型,3现金账本、4赠送账本"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"totalBalance": "总余额",
"totalEffBalance": "总可用余额"
}
}
异常返回示例
{"code":"401","message":"签名无效"}
错误码
错误码 | 错误信息 | 描述 |
---|---|---|
401 | Invalid Signature | 签名无效 |
公共错误码 | -- | 所有API公用的错误码,请参照《 状态码定义 》 |
6.14: 预存-查询预存总余额明细
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/queryBalanceList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实项目ID |
custId | BODY | STRING | 是 | 客户ID |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"custId": "客户ID",
"balanceType": "账本类型,3现金账本、4赠送账本"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"resultList": [{
"custId": "客户ID",
"custName": "客户名称",
"balanceId": "账本ID",
"balanceType": "账本类型",
"balanceSchemeId": "预存方案ID",
"schemeName": "预存方案名称",
"feeItemTypeIds": "可抵扣费用科目ID串",
"feeItemTypeNames": "可抵扣费用科目名称",
"resInstNames": "可抵扣资源名称",
"balResList": [{
"resInstType": "资源类型",
"resInstId": "资源ID",
"resInstName": "资源名称",
"resInstCode": "资源编码"
}],
"state": "状态",
"balance": "账本余额",
"effBalance": "账本可用余额"
}]
}
}
6.15: 预存-查询预存记录
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/queryBalancePayLog
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实项目ID |
totalAmount | BODY | STRING | 是 | 缴费金额 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"custId": "客户ID",
"userId": "C端用户ID",
"payDateYear": "查询年份,格式YYYY,例如:2019",
"pageLimit": "当前页记录数",
"pageNo": "当前页数"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"paginator": {
"pageLimit": 10,
"pageNo": 1,
"totalCount": 121,
"totalPage": 13
},
"resultList": [{
"paySerialNbr": "缴费流水号",
"payAmont": "缴费金额",
"payDate": "缴费时间,格式:2016-12-03 00:00:00",
"transactionNo": "交易流水号",
"resInstName": "资源名称",
"custId": "客户ID",
"custName": "客户名称",
"balanceId": "账本ID",
"balanceType": "账本类型",
"balanceSchemeId": "预存方案ID",
"schemeName": "预存方案名称"
}]
}
}
6.16: 预存-查询预存记录详情
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/queryBalancePayLogDetail
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实项目ID |
paySerialNbr | BODY | STRING | 是 | 缴费流水号 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"paySerialNbr": "缴费流水号"
}
返回结果示例
{
"code": "返回码,0成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"resultList": [{
"paySerialNbr": "缴费流水号",
"payMethod": "支付方式编码",
"payMethodName": "支付方式名称",
"payAmont": "缴费金额",
"payDate": "缴费时间,格式:2016-12-03 00:00:00",
"transactionNo": "交易流水号",
"custId": "客户ID",
"custName": "客户名称",
"balanceId": "账本ID",
"balanceType": "账本类型",
"balanceSchemeId": "预存方案ID",
"schemeName": "预存方案名称",
"feeItemTypeIds": "可抵扣费用科目ID串",
"feeItemTypeNames": "可抵扣费用科目名称",
"resInstNames": "可抵扣资源名称",
"balResList": [{
"resInstType": "资源类型",
"resInstId": "资源ID",
"resInstName": "资源名称",
"resInstCode": "资源编码"
}]
}]
}
}
6.17: 预存-查询预存方案列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/querySchemeList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实项目ID |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0 成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"resultList": [{
"balanceSchemeId": "预存方案ID",
"schemeName": "预存方案名称",
"balanceType": "账本类型",
"feeItemTypeIds": "可抵扣费用科目ID串",
"feeItemTypeNames": "可抵扣费用科目名称",
"appCalcFlag": "APP是否预估费用,1是,0否"
}]
}
}
## 6.18: <span id="618">预存-查询预存方案预估金额</span>
### 描述
预存方案的appCalcFlag=1(表示需要预估费用)时,才调用此接口,否则不调用
### 请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/calcMonthlyFee
方法:POST
### 请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
| ----------- | ---- | ------ | ---- | ---------- |
| communityId | BODY | STRING | 是 | 真实项目ID |
| custId | BODY | STRING | 是 | 客户ID |
| resInstId | BODY | STRING | 是 | 资源ID |
| balanceSchemeId | BODY | STRING | 是 | 预存方案ID |
### 请求Body描述(非Form表单数据)
```json
{
"communityId": "真实项目ID",
"custId": "客户ID",
"custName": "客户名称",
"balResList": [{
"resInstType": "资源类型",
"resInstId": "资源ID",
"resInstName": "资源名称",
"resInstCode": "资源编码"
}],
"balanceSchemeId": "预存方案ID"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0 成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"totalFee": "计算出的每月费用金额"
}
}
6.19: 预存-创建预存支付
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/prePayConfirm
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | STRING | 是 | 真实项目ID |
totalAmount | BODY | STRING | 是 | 缴费金额 |
请求Body描述(非Form表单数据)
{
"houseId":"14470652",
"communityId":1003837,
"custId":15797170,
"userId":50,
"acctItemIds":"59371294-63340694",
"billAmount":2,
"payAmount":1,
"payBzCode":"APP",
"payMethod":1,
"payWay":"WEIXIN",
"tradeType":"WFT_APP",
"method":"payConfirmV1",
"system":"2048" ,
"appId":"wx6b0f99b562a6ab38"
}
{
"communityId": "真实项目ID",
"userId": "C端用户ID",
"custId": "客户ID",
"custName": "客户名称",
"balResList": [{
"resInstType": "资源类型",
"resInstId": "资源ID",
"resInstName": "资源名称",
"resInstCode": "资源编码"
}],
"balanceSchemeId": "预存方案ID",
"balanceSchemeName": "预存方案名称",
"payAmount": "预存金额",
"desc": "备注"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "返回码,0 成功,其他失败",
"message": "成功或失败提示信息",
"data": {
"businessId": "缴费唯一单号",
"totalAmount": "缴费金额"
}
}
620: 预存-查询预存支付结果
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/preStore/payCallBack
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
businessId | BODY | STRING | 是 | 真实项目ID |
totalAmount | BODY | STRING | 是 | 缴费金额 |
请求Body描述(非Form表单数据)
{
"businessId": "缴费唯一单号",
"totalAmount": "缴费金额",
"payMethod": "支付方式",
"paySerialId": "交易流水号",
"payDate": "支付日期,格式:yyyy-MM-dd HH:mm:ss",
"payStatus": "支付状态,只传支付成功值:POK",
"communityId": "真实项目ID",
"custId": "客户ID",
"payUserId": "支付用户ID"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "0",
"message": "成功",
"data": {
"batchId": "缴费记录批次ID",
"payInfo": [{
"paySerialNbr": "缴费记录ID",
"type": "缴费业务类型"
}]
}
}
621: 线上临停缴费
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/mid/parking/charge/nocard/online/pay
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
wxProvider | BODY | STRING | 是 | 支付场景为WXJS 时必填 |
payObjCode | BODY | STRING | 是 | 扩展字段(需记录时可填写) |
payBzCode | BODY | STRING | 是 | 支付场景: APP (原生APP)、WXJS(公众号)、QR1(被扫)、QR2(主扫) |
wxOpenid | BODY | STRING | 是 | 支付场景为WXJS 时必填 |
payWay | BODY | STRING | 是 | 必有字段 备注:支付方式:来自于支付方式中的选项alaisName |
custName | BODY | STRING | 是 | 客户名称 |
userId | BODY | STRING | 是 | C端用户ID |
payAmount | BODY | STRING | 是 | 预存金额 |
billInfo | BODY | JSONArray | 是 | 缴费信息 |
houseId | billInfo | STRING | 是 | 整型,房屋ID,没有则传-1 |
feeItemTypeId | billInfo | STRING | 是 | 整型,费用科目ID |
orderId | billInfo | STRING | 是 | 整型,外部系统订单ID(不传此值时默认与taskId一致),月卡托收时传托收任务ID |
resInstName | billInfo | STRING | 是 | 资源名称,传:车卡编码 |
fee | billInfo | STRING | 是 | 整型,本金,金额单位为分 |
otBillId | billInfo | STRING | 是 | 整型,外部系统唯一账单标识 |
initVal | billInfo | STRING | 是 | 仪表读数开始值,不存在时填-1 |
endVal | billInfo | STRING | 是 | 仪表读数结束值,不存在时填-1 |
resInstId | billInfo | STRING | 是 | 资源对象ID,传:车卡ID |
acctItemTypeId | billInfo | STRING | 是 | 整型,账目类型ID |
receivableDate | billInfo | STRING | 是 | 应收日期,没有则传空 |
paidLfree | billInfo | STRING | 是 | 整型,已缴违约金,金额单位为分 |
custId | billInfo | STRING | 是 | 整型,客户ID(customer表的cust_id) |
billStart | billInfo | STRING | 是 | 字符串,账单费用开始时间,格式:YYYYMMDDHHMMSS,例如:20160501000000 |
resInstType | billInfo | STRING | 是 | 资源对象类型,车卡传:28 |
resInstCode | billInfo | STRING | 是 | 资源编码,传:车卡编码 |
amount | billInfo | STRING | 是 | 整型,仪表用量/数量,不存在时填0 |
unitStr | billInfo | STRING | 是 | 计费单位:天,张,吨等 |
billEnd | billInfo | STRING | 是 | 字符串,账单费用结束时间,格式:YYYYMMDDHHMMSS,例如:20160531235959 |
paidFee | billInfo | STRING | 是 | 整型,已缴本金,金额单位为分 |
custName | billInfo | STRING | 是 | 客户名称 |
rateStr | billInfo | STRING | 是 | 金额单位元,单价串(阶梯定价时存在多个),多个逗号分隔,例如:1.5,2.0 |
feeItemTypeName | billInfo | STRING | 是 | 费用科目名称 |
custMainId | billInfo | STRING | 是 | 对应cust_main表的c_id,没有则传-1 |
billingCycle | billInfo | STRING | 是 | 整型,应收账期,格式:YYYYMM,例如:201605 |
lfree | billInfo | STRING | 是 | 整型,违约金(滞纳金),金额单位为分 |
payAttrCode | BODY | STRING | 是 | 扩展字段(需记录时可填写) |
payMethod | BODY | STRING | 是 | 类型:String 必有字段 备注:支付方式 |
appId | BODY | STRING | 是 | 类型:String 可有字段 备注:支付场景为APP 时必填 |
custId | BODY | STRING | 是 | 客户ID |
communityId | BODY | STRING | 是 | 虚拟项目ID |
businessType | BODY | STRING | 是 | 开通类型 10:物业缴费,10物业缴费 20商城支付 40停车卡缴费 41临停, 默认10 |
outerPayBizId | BODY | STRING | 是 | 外部订单ID |
tradeType | BODY | STRING | 是 | 类型:String 必有字段 备注:来自于支付方式中的选项code |
desc | BODY | STRING | 是 | 备注 |
请求Body描述(非Form表单数据)
{
"communityId": "1003836",
"userId": "30",
"custId": "16070534",
"custName": "小邓",
"billInfo": [
{
"otBillId": "12312321",
"houseId": "-1",
"acctItemTypeId": "3026",
"feeItemTypeId": "1350009",
"fee": "100",
"paidFee": "100",
"lfree": "0",
"paidLfree": "0",
"amount": "0",
"billingCycle": "201909",
"billStart": "20190912000000",
"billEnd": "20190912235959",
"custId": "16070534",
"rateStr": "1.5,2.0",
"orderId": "232423",
"unitStr": "时",
"initVal": "-1",
"endVal": "-1",
"feeItemTypeName": "室内停车费",
"custName": "小邓",
"custMainId": "-1",
"resInstType": "",
"resInstId": "",
"resInstCode": "",
"resInstName": "",
"receivableDate": ""
}
],
"payObjCode": "",
"payAttrCode": "",
"payAmount": "100",
"desc": "备注",
"payMethod": "1",
"outerPayBizId": "232423",
"appId": "",
"payBzCode": "APP",
"payWay": "WEIXIN",
"tradeType": "WXORI_APP",
"wxOpenid": "",
"wxProvider": "",
"businessType": "40"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "0",
"message": "成功",
"data": {
}
}
622: 线上月卡缴费
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/mid/parking/charge/card/online/pay
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
wxProvider | BODY | STRING | 是 | 支付场景为WXJS 时必填 |
payObjCode | BODY | STRING | 是 | 扩展字段(需记录时可填写) |
payBzCode | BODY | STRING | 是 | 支付场景: APP (原生APP)、WXJS(公众号)、QR1(被扫)、QR2(主扫) |
wxOpenid | BODY | STRING | 是 | 支付场景为WXJS 时必填 |
payWay | BODY | STRING | 是 | 必有字段 备注:支付方式:来自于支付方式中的选项alaisName |
custName | BODY | STRING | 是 | 客户名称 |
userId | BODY | STRING | 是 | C端用户ID |
payAmount | BODY | STRING | 是 | 预存金额 |
billInfo | BODY | JSONArray | 是 | 缴费信息 |
houseId | billInfo | STRING | 是 | 整型,房屋ID,没有则传-1 |
feeItemTypeId | billInfo | STRING | 是 | 整型,费用科目ID |
orderId | billInfo | STRING | 是 | 整型,外部系统订单ID(不传此值时默认与taskId一致),月卡托收时传托收任务ID |
resInstName | billInfo | STRING | 是 | 资源名称,传:车卡编码 |
fee | billInfo | STRING | 是 | 整型,本金,金额单位为分 |
otBillId | billInfo | STRING | 是 | 整型,外部系统唯一账单标识 |
initVal | billInfo | STRING | 是 | 仪表读数开始值,不存在时填-1 |
endVal | billInfo | STRING | 是 | 仪表读数结束值,不存在时填-1 |
resInstId | billInfo | STRING | 是 | 资源对象ID,传:车卡ID |
acctItemTypeId | billInfo | STRING | 是 | 整型,账目类型ID |
receivableDate | billInfo | STRING | 是 | 应收日期,没有则传空 |
paidLfree | billInfo | STRING | 是 | 整型,已缴违约金,金额单位为分 |
custId | billInfo | STRING | 是 | 整型,客户ID(customer表的cust_id) |
billStart | billInfo | STRING | 是 | 字符串,账单费用开始时间,格式:YYYYMMDDHHMMSS,例如:20160501000000 |
resInstType | billInfo | STRING | 是 | 资源对象类型,车卡传:28 |
resInstCode | billInfo | STRING | 是 | 资源编码,传:车卡编码 |
amount | billInfo | STRING | 是 | 整型,仪表用量/数量,不存在时填0 |
unitStr | billInfo | STRING | 是 | 计费单位:天,张,吨等 |
billEnd | billInfo | STRING | 是 | 字符串,账单费用结束时间,格式:YYYYMMDDHHMMSS,例如:20160531235959 |
paidFee | billInfo | STRING | 是 | 整型,已缴本金,金额单位为分 |
custName | billInfo | STRING | 是 | 客户名称 |
rateStr | billInfo | STRING | 是 | 金额单位元,单价串(阶梯定价时存在多个),多个逗号分隔,例如:1.5,2.0 |
feeItemTypeName | billInfo | STRING | 是 | 费用科目名称 |
custMainId | billInfo | STRING | 是 | 对应cust_main表的c_id,没有则传-1 |
billingCycle | billInfo | STRING | 是 | 整型,应收账期,格式:YYYYMM,例如:201605 |
lfree | billInfo | STRING | 是 | 整型,违约金(滞纳金),金额单位为分 |
payAttrCode | BODY | STRING | 是 | 扩展字段(需记录时可填写) |
payMethod | BODY | STRING | 是 | 类型:String 必有字段 备注:支付方式 |
appId | BODY | STRING | 是 | 类型:String 可有字段 备注:支付场景为APP 时必填 |
custId | BODY | STRING | 是 | 客户ID |
communityId | BODY | STRING | 是 | 虚拟项目ID |
businessType | BODY | STRING | 是 | 开通类型 10:物业缴费,10物业缴费 20商城支付 40停车卡缴费 41临停, 默认10 |
tradeType | BODY | STRING | 是 | 类型:String 必有字段 备注:来自于支付方式中的选项code |
outerPayBizId | BODY | STRING | 是 | 外部订单ID |
desc | BODY | STRING | 是 | 备注 |
请求Body描述(非Form表单数据)
{
"communityId": "1003836",
"userId": "30",
"custId": "16070534",
"custName": "小邓",
"billInfo": [
{
"otBillId": "12312321",
"houseId": "-1",
"acctItemTypeId": "3026",
"feeItemTypeId": "1350009",
"fee": "100",
"paidFee": "100",
"lfree": "0",
"paidLfree": "0",
"amount": "0",
"billingCycle": "201909",
"billStart": "20190912000000",
"billEnd": "20190912235959",
"custId": "16070534",
"rateStr": "1.5,2.0",
"orderId": "232423",
"unitStr": "时",
"initVal": "-1",
"endVal": "-1",
"feeItemTypeName": "室内停车费",
"custName": "小邓",
"custMainId": "-1",
"resInstType": "12",
"resInstId": "28",
"resInstCode": "12",
"resInstName": "13",
"receivableDate": ""
}
],
"payObjCode": "",
"payAttrCode": "",
"payAmount": "100",
"desc": "临停缴费|固定月租",
"payMethod": "1",
"outerPayBizId": "232423",
"appId": "",
"payBzCode": "APP",
"payWay": "WEIXIN",
"tradeType": "WXORI_APP",
"wxOpenid": "",
"wxProvider": "",
"businessType": "40"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "0",
"message": "成功",
"data": {
}
}
623: 支付方式
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/mid/parking/charge/payMethodList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
communityId | BODY | INTEGER | 是 | 真实项目ID |
businessType | BODY | INTEGER | 是 | 开通类型 10:物业缴费,10物业缴费 20商城支付 40停车卡缴费 41临停, 默认10 |
payBzCode | BODY | STRING | 是 | "支付场景: APP (原生APP)、WXJS(公众号)、QR1(被扫)、QR2(主扫)" |
请求Body描述(非Form表单数据)
{
"communityId":1003837,
"businessType":40,
"payBzCode": "APP"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {
"payMethods": [
{
"id": "1",
"name": "微信支付",
"code": "WXORI_APP",
"alaisName": "WEIXIN",
"forwardUrl": "",
"iconUrl": "/picture/2019/06/18/429/201906181649501264_325_311.png"
},
{
"id": "39",
"name": "支付宝支付",
"code": "UMSPAY_APP",
"alaisName": "ALIPAY",
"forwardUrl": "",
"iconUrl": "/picture/2019/06/18/474/201906181650348319_503_477.png"
}
],
"resultCode": "0"
},
"message": "success"
}
625: 账目类型列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/common/acctItemTypeList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {
"total": 103,
"pages": 103,
"records": [
{
"acctItemTypeCode": "PPTF",
"acctItemTypeGroup": null,
"acctItemTypeId": 1,
"organId": 1,
"acctItemTypeName": "物业管理费",
"status": 0
}
],
"pageNo": 1,
"pageSize": 1
},
"message": "success"
}
626: 费用科目组列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/common/feeGroupTypeList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
acctItemTypeId | BODY | INT | N | 账目类型ID |
请求Body描述(非Form表单数据)
{
"acctItemTypeId": 111
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {
"total": 14,
"pages": 14,
"records": [
{
"feeGroupTypeId": 1,
"updateDate": null,
"orderNo": 5,
"crtDate": "2017-11-27T03:33:39.000+0000",
"organId": 1549,
"feeGroupTypeName": "预存款",
"multiBiz": 0,
"groupCode": "1",
"status": 1
}
],
"pageNo": 1,
"pageSize": 1
},
"message": "success"
}
627: 费用科目列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/common/feeItemTypeList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
acctItemTypeId | BODY | INT | N | 账目类型ID |
feeGroupTypeId | BODY | INT | N | 费用科目组ID |
请求Body描述(非Form表单数据)
{
"acctItemTypeId": 111,
"feeGroupTypeId": 1221
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {
"total": 1,
"pages": 1,
"records": [
{
"englishName": null,
"lfeeRefType": 1,
"rateDay": 1,
"feeItemTypeId": 1350022,
"ltaxRate": 0.00,
"crtDate": "2018-05-30T09:22:01.000+0000",
"feeItemTypeCode": "H30106",
"groupId": 1330003,
"rateMonth": 1,
"lfeePrecision": 1,
"lfeeDayType": 1,
"lfeeRate": 0.0000,
"taxRate": 5.00,
"feeItemTypeName": "会议室",
"stuts": 1,
"organId": 1549,
"lfeeMode": 1,
"exemptDays": 0,
"feeItemGroupId": 1350022,
"lfeeModMethod": 3,
"groupCode": null
}
],
"pageNo": 1,
"pageSize": 10
},
"message": "success"
}
628: 服务数据列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/common/queryTotal
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
acctItemTypeId | BODY | INT | N | 账目类型ID |
feeGroupTypeId | BODY | INT | N | 费用科目组ID |
请求Body描述(非Form表单数据)
{
"familys": [
{
"familyId": 303,
"houseId": null,
"roleTag": 2,
"familyName": "云朵默认社区",
"property": "云朵默认社区",
"custId": 0,
"communityName": "云朵默认社区",
"smartHomeHouseId": -1,
"communityId": 0,
"userId": 148,
"status": "4"
},
{
"familyId": 34,
"houseId": 14495160,
"roleTag": 2,
"familyName": "美的智慧生活体验馆019栋01单元1",
"property": "9栋_01单元_101",
"custId": 16050049,
"communityName": "美的智慧生活体验馆01",
"smartHomeHouseId": null,
"communityId": 21291201,
"userId": 42,
"status": "4"
},
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": 200,
"data": {
},
"message": "success"
}
629: 获取当前时间
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/common/now/time
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
630: 查询预存余额信息列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/preStore/queryAllBalanceList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
631: 查询预存记录详细信息
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/preStore/queryBalanceUseLogById
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
632: 查询预存抵扣明细列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/preStore/queryBalanceUseLogById
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
633: 查询可开票列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/invoice/queryUnInvoicedPayLogs
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
634: 查询开票信息
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/invoice/queryInvoiceInfoBatch
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
635: 提交开票申请
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/invoice/saveAndInvoicingBatch
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
636: 查询发票记录列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/invoice/queryInvoiceLogListByApplyUser
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
637: 查询已申请发票缴费记录接口
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/invoice/queryApplyInvoicePayLogs
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
630: 查询预存余额信息列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/charge/preStore/queryAllBalanceList
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"nowTime": 1576463385458
},
"message": "success"
}
639: 发票图片转base64
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/common/pdfToBase64
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
"url":"http://www.aisinogz.com:19876/AisinoFp-test/pd?id=20200227183141497638_144000930000_10166169.pdf"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
"base64": "12312312313212"
},
"message": "success"
}
640: 发票发送邮件/span>
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:charge/invoice/sendToEmail
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
请求Body描述(非Form表单数据)
{
"invoiceId ":131231
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
nowTime | data | INT | 是 | 当前时间戳 |
返回结果示例
{
"code": 200,
"data": {
},
"message": "success"
}
错误码列表(16001-16999)
错误码 | 错误信息 | 描述 |
---|---|---|
16001 | ||
公共错误码 | -- | 所有API公用的错误码,请参照《 公共错误码 》 |