7. 计费中台API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
7.1 | 临停缴费(线下) | /mid/parking/charge/nocard/offline/pay | 1.0 |
7.2 | 月卡缴费(线下) | /mid/parking/charge/card/offline/pay | 1.0 |
7.3 | 临停缴费(线上) | /mid/parking/charge/nocard/online/pay | 1.0 |
7.4 | 月卡缴费(线上) | /mid/parking/charge/card/online/pay | 1.0 |
API调用
7.1: 临停缴费(线下)
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/mid/parking/charge/nocard/offline/pay
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
method | BODY | STRING | 是 | 方法名 传固定值:otBillSyn |
organId | BODY | INTEGER | 是 | 项目ID 虚拟项目ID |
communityId | BODY | INTEGER | 是 | 真实项目ID 真实项目ID |
taskId | BODY | INTEGER | 是 | 请求消息ID 同一请求需唯一,防止同一消息请求多次,(可用订单ID) |
taskType | BODY | STRING | 是 | 请求类型 云智易车场传固定值:300 |
sysId | BODY | STRING | 是 | 系统ID 云智易车场传固定值:4096 |
businessType | BODY | STRING | 是 | 业务大类 目前没用,传固定值:-1 |
businessId | BODY | STRING | 是 | 业务小类 目前没用,传固定值:-1 |
billInfo | BODY | ARRAY | 是 | 同步账单信息列表 一次可以批量传多条账单 |
otBillId | BODY | INTEGER | 是 | 外部账单ID 外部系统唯一账单ID |
orderId | BODY | INTEGER | 是 | 外部订单ID 外部系统订单ID,同一个订单可能产生多种费用,则订单ID相同,账单ID不同 |
custId | BODY | INTEGER | 是 | 客户ID 取值来源:客户信息基础资料(对应customer表的cust_id) |
custName | BODY | STRING | 是 | 客户名称 取值来源:客户信息基础数据 |
custMainId | BODY | INTEGER | 是 | 客户ID 取值来源:客户信息基础数据(对应cust_main表的c_id),没有则传-1 |
acctItemTypeId | BODY | INTEGER | 是 | 账目类型ID 取值来源:费用科目基础资料 |
feeItemTypeId | BODY | INTEGER | 是 | 费用科目ID 取值来源:费用科目基础资料 |
feeItemTypeName | BODY | STRING | 是 | 费用科目名称 取值来源:费用科目基础资料 |
fee | BODY | INTEGER | 是 | 本金 金额单位:分 |
paidFee | BODY | INTEGER | 是 | 已缴本金 金额单位:分 |
lfree | BODY | INTEGER | 是 | 违约金 金额单位:分 |
paidLfree | BODY | INTEGER | 是 | 已缴违约金 金额单位:分 |
amount | BODY | INTEGER | 是 | 仪表用量/数量 没有则传0 |
billingCycle | BODY | INTEGER | 是 | 应收账期 账期格式:YYYYMM,例如:201605 |
billStart | BODY | STRING | 是 | 账单费用开始时间 格式:YYYYMMDDHHMMSS,例如:20160501000000 |
billEnd | BODY | STRING | 是 | 账单费用结束时间 格式:YYYYMMDDHHMMSS,例如:20160531235959 |
rateStr | BODY | STRING | 是 | 单价 金额单位元,单价串(阶梯定价时存在多个),多个逗号分隔,例如:1.5,2.0;没有则传空STRING |
unitStr | BODY | STRING | 是 | 计费单位 如:天,张,吨等;没有则传空STRING |
initVal | BODY | INTEGER | 是 | 仪表读数开始值 没有则传-1 |
endVal | BODY | INTEGER | 是 | 仪表读数结束值 没有则传-1 |
billObjType | BODY | INTEGER | 是 | 资源类型 房屋:1 车位:2 仪表:3 车卡:28 |
resInstId | BODY | INTEGER | 是 | 资源ID 没有则传-1,例如,billObjType为28时,则传车卡ID |
resInstCode | BODY | STRING | 是 | 资源编码 没有则传空STRING,例如,billObjType为28时,则传车卡编码 |
resInstType | BODY | STRING | 是 | 资源类型 |
resInstName | BODY | STRING | 是 | 资源名称 没有则传空STRING,例如,billObjType为28时,则传车卡编码 |
receivableDate | BODY | INTEGER | 是 | 应收日期 日期格式:YYYYMMDD,如:20190808 |
houseId | BODY | INTEGER | 是 | 房屋ID 没有则传-1 |
payInfo | BODY | JSONOBJECT | 否 | 缴费信息 当同步账单列表billInfo节点中存在已缴金额时,则必传 |
payDate | BODY | STRING | 是 | 缴费时间 格式:YYYY-MM-DD HH:MM:SS,例如:2019-05-20 20:20:20 |
empleeId | BODY | INTEGER | 是 | 收款员工ID 没有则传-1 |
payMethod | BODY | STRING | 是 | 缴费方式 取值来源:支付方式编码基础资料 |
payAmount | BODY | INTEGER | 是 | 缴费金额 本次同步的所有账单billInfo节点中的paidFee+paidLfree之和,金额单位分 |
transNo | BODY | STRING | 是 | 交易流水号 没有则传空STRING |
payObjCode | BODY | STRING | 是 | 扩展字段 没有则传空STRING |
payAttrCode | BODY | STRING | 是 | 扩展字段 没有则传空STRING,例如:可传车牌号 |
desc | BODY | STRING | 是 | 备注 没有则传空STRING |
请求Body描述(非Form表单数据)
{
"method": "otBillSyn",
"organId": "67",
"taskId": "8887",
"taskType": "300",
"sysId": "4096",
"businessType": "-1",
"businessId": "-1",
"billInfo": [{
"otBillId": "234234",
"orderId": "123456",
"custId": "1",
"custName": "客户名称",
"custMainId": "1001",
"acctItemTypeId": "23",
"feeItemTypeId": "234",
"feeItemTypeName": "费用科目名称",
"fee": "234",
"paidFee": "100",
"lfree": "23",
"paidLfree": "0",
"amount": "0",
"billingCycle": "201605",
"billStart": "20160501000000",
"billEnd": "20160531235959",
"rateStr": "1.5,2.0",
"unitStr": "天",
"initVal": "-1",
"endVal": "-1",
"billObjType": "28",
"resInstId": "456464",
"resInstCode": "资源编码",
"resInstType": "1",
"resInstName": "资源名称",
"houseId": "123",
"receivableDate": "20190808"
}],
"payInfo": {
"payDate": "2019-08-08 11:22:33",
"empleeId": "1",
"payMethod": "1",
"payAmount": "200",
"transNo": "v234234",
"payObjCode": "2222",
"payAttrCode": "粤B23456",
"desc": "mock"
}
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
7.2: 月卡缴费(线下)
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/mid/parking/charge/card/offline/pay
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
method | BODY | STRING | 是 | 方法名 传固定值:otBillSyn |
organId | BODY | INTEGER | 是 | 项目ID 虚拟项目ID |
communityId | BODY | INTEGER | 是 | 真实项目ID 真实项目ID |
taskId | BODY | INTEGER | 是 | 请求消息ID 同一请求需唯一,防止同一消息请求多次,(可用订单ID) |
taskType | BODY | STRING | 是 | 请求类型 云智易车场传固定值:300 |
sysId | BODY | STRING | 是 | 系统ID 云智易车场传固定值:4096 |
businessType | BODY | STRING | 是 | 业务大类 目前没用,传固定值:-1 |
businessId | BODY | STRING | 是 | 业务小类 目前没用,传固定值:-1 |
billInfo | BODY | ARRAY | 是 | 同步账单信息列表 一次可以批量传多条账单 |
otBillId | BODY | INTEGER | 是 | 外部账单ID 外部系统唯一账单ID |
orderId | BODY | INTEGER | 是 | 外部订单ID 外部系统订单ID,同一个订单可能产生多种费用,则订单ID相同,账单ID不同 |
custId | BODY | INTEGER | 是 | 客户ID 取值来源:客户信息基础资料(对应customer表的cust_id) |
custName | BODY | STRING | 是 | 客户名称 取值来源:客户信息基础数据 |
custMainId | BODY | INTEGER | 是 | 客户ID 取值来源:客户信息基础数据(对应cust_main表的c_id),没有则传-1 |
acctItemTypeId | BODY | INTEGER | 是 | 账目类型ID 取值来源:费用科目基础资料 |
feeItemTypeId | BODY | INTEGER | 是 | 费用科目ID 取值来源:费用科目基础资料 |
feeItemTypeName | BODY | STRING | 是 | 费用科目名称 取值来源:费用科目基础资料 |
fee | BODY | INTEGER | 是 | 本金 金额单位:分 |
paidFee | BODY | INTEGER | 是 | 已缴本金 金额单位:分 |
lfree | BODY | INTEGER | 是 | 违约金 金额单位:分 |
paidLfree | BODY | INTEGER | 是 | 已缴违约金 金额单位:分 |
amount | BODY | INTEGER | 是 | 仪表用量/数量 没有则传0 |
billingCycle | BODY | INTEGER | 是 | 应收账期 账期格式:YYYYMM,例如:201605 |
billStart | BODY | STRING | 是 | 账单费用开始时间 格式:YYYYMMDDHHMMSS,例如:20160501000000 |
billEnd | BODY | STRING | 是 | 账单费用结束时间 格式:YYYYMMDDHHMMSS,例如:20160531235959 |
rateStr | BODY | STRING | 是 | 单价 金额单位元,单价串(阶梯定价时存在多个),多个逗号分隔,例如:1.5,2.0;没有则传空STRING |
unitStr | BODY | STRING | 是 | 计费单位 如:天,张,吨等;没有则传空STRING |
initVal | BODY | INTEGER | 是 | 仪表读数开始值 没有则传-1 |
endVal | BODY | INTEGER | 是 | 仪表读数结束值 没有则传-1 |
billObjType | BODY | INTEGER | 是 | 资源类型 房屋:1 车位:2 仪表:3 车卡:28 |
resInstId | BODY | INTEGER | 是 | 资源ID 没有则传-1,例如,billObjType为28时,则传车卡ID |
resInstCode | BODY | STRING | 是 | 资源编码 没有则传空STRING,例如,billObjType为28时,则传车卡编码 |
resInstName | BODY | STRING | 是 | 资源名称 没有则传空STRING,例如,billObjType为28时,则传车卡编码 |
receivableDate | BODY | INTEGER | 是 | 应收日期 日期格式:YYYYMMDD,如:20190808 |
houseId | BODY | INTEGER | 是 | 房屋ID 没有则传-1 |
payInfo | BODY | JSONOBJECT | 否 | 缴费信息 当同步账单列表billInfo节点中存在已缴金额时,则必传 |
payDate | BODY | STRING | 是 | 缴费时间 格式:YYYY-MM-DD HH:MM:SS,例如:2019-05-20 20:20:20 |
empleeId | BODY | INTEGER | 是 | 收款员工ID 没有则传-1 |
payMethod | BODY | STRING | 是 | 缴费方式 取值来源:支付方式编码基础资料 |
payAmount | BODY | INTEGER | 是 | 缴费金额 本次同步的所有账单billInfo节点中的paidFee+paidLfree之和,金额单位分 |
transNo | BODY | STRING | 是 | 交易流水号 没有则传空STRING |
payObjCode | BODY | STRING | 是 | 扩展字段 没有则传空STRING |
payAttrCode | BODY | STRING | 是 | 扩展字段 没有则传空STRING,例如:可传车牌号 |
desc | BODY | STRING | 是 | 备注 没有则传空STRING |
请求Body描述(非Form表单数据)
{
"method": "otBillSyn",
"organId": "67",
"taskId": "8887",
"taskType": "300",
"sysId": "4096",
"businessType": "-1",
"businessId": "-1",
"billInfo": [{
"otBillId": "234234",
"orderId": "123456",
"custId": "1",
"custName": "客户名称",
"custMainId": "1001",
"acctItemTypeId": "23",
"feeItemTypeId": "234",
"feeItemTypeName": "费用科目名称",
"fee": "234",
"paidFee": "100",
"lfree": "23",
"paidLfree": "0",
"amount": "0",
"billingCycle": "201605",
"billStart": "20160501000000",
"billEnd": "20160531235959",
"rateStr": "1.5,2.0",
"unitStr": "天",
"initVal": "-1",
"endVal": "-1",
"billObjType": "28",
"resInstId": "456464",
"resInstCode": "资源编码",
"resInstName": "资源名称",
"houseId": "123",
"receivableDate": "20190808"
}],
"payInfo": {
"payDate": "2019-08-08 11:22:33",
"empleeId": "1",
"payMethod": "1",
"payAmount": "200",
"transNo": "v234234",
"payObjCode": "2222",
"payAttrCode": "粤B23456",
"desc": "mock"
}
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
7.3: 临停缴费(线上)
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/mid/parking/charge/nocard/online/pay
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
wxProvider | BODY | STRING | 是 | String可有字段备注:支付场景为WXJS时必填 |
payObjCode | BODY | STRING | 是 | 扩展字段(需记录时可填写) |
payBzCode | BODY | STRING | 是 | String必有字段备注:支付场景: APP(原生APP)、WXJS(公众号)、QR1(被扫)、QR2(主扫) |
wxOpenid | BODY | STRING | 是 | String可有字段备注:支付场景为WXJS时必填 |
payWay | BODY | STRING | 是 | 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 |
tradeType | BODY | STRING | 是 | String必有字段备注:来自于支付方式中的选项code |
desc | BODY | STRING | 是 | 备注 |
outerPayBizId | BODY | STRING | 是 | 外部支付业务ID,代表一笔支付业务 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"userId": "C端用户ID",
"custId": "客户ID",
"custName": "客户名称",
"billInfo": [
{
"otBillId": "整型,外部系统唯一账单标识",
"houseId": "整型,房屋ID,没有则传-1",
"acctItemTypeId": "整型,账目类型ID",
"feeItemTypeId": "整型,费用科目ID",
"fee": "整型,本金,金额单位为分",
"paidFee": "整型,已缴本金,金额单位为分",
"lfree": "整型,违约金(滞纳金),金额单位为分",
"paidLfree": "整型,已缴违约金,金额单位为分",
"amount": "整型,仪表用量/数量,不存在时填0",
"billingCycle": "整型,应收账期,格式:YYYYMM,例如:201605",
"billStart": "字符串,账单费用开始时间,格式:YYYYMMDDHHMMSS,例如:20160501000000",
"billEnd": "字符串,账单费用结束时间,格式:YYYYMMDDHHMMSS,例如:20160531235959",
"custId": "整型,客户ID(customer表的cust_id)",
"rateStr": "字符串,金额单位元,单价串(阶梯定价时存在多个),多个逗号分隔,例如:1.5,2.0",
"orderId": "整型,外部系统订单ID(不传此值时默认与taskId一致),月卡托收时传托收任务ID",
"unitStr": "计费单位:天,张,吨等",
"initVal": "仪表读数开始值,不存在时填-1",
"endVal": "仪表读数结束值,不存在时填-1",
"feeItemTypeName": "费用科目名称",
"custName": "客户名称",
"custMainId": "对应cust_main表的c_id,没有则传-1",
"resInstType": "资源对象类型,车卡传:28",
"resInstId": "资源对象ID,传:车卡ID",
"resInstCode": "资源编码,传:车卡编码",
"resInstName": "资源名称,传:车卡编码",
"receivableDate": "应收日期,没有则传空"
}
],
"payObjCode": "扩展字段(需记录时可填写)",
"payAttrCode": "扩展字段(需记录时可填写)",
"payAmount": "预存金额",
"desc": "备注",
"payMethod": "String必有字段备注:支付方式",
"appId": "String可有字段备注:支付场景为APP时必填",
"payBzCode": "String必有字段备注:支付场景: APP(原生APP)、WXJS(公众号)、QR1(被扫)、QR2(主扫)",
"payWay": "String必有字段备注:支付方式:来自于支付方式中的选项alaisName",
"tradeType": "String必有字段备注:来自于支付方式中的选项code",
"wxOpenid": "String可有字段备注:支付场景为WXJS时必填",
"wxProvider": "String可有字段备注:支付场景为WXJS时必填",
"outerPayBizId": "外部支付业务ID,代表一笔支付业务"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
billId | data | STRING | 是 | 预付单ID |
custId | data | STRING | 是 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
7.4: 月卡缴费(线上)
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/mid/parking/charge/nocard/online/pay
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
wxProvider | BODY | STRING | 是 | String可有字段备注:支付场景为WXJS时必填 |
payObjCode | BODY | STRING | 是 | 扩展字段(需记录时可填写) |
payBzCode | BODY | STRING | 是 | String必有字段备注:支付场景: APP(原生APP)、WXJS(公众号)、QR1(被扫)、QR2(主扫) |
wxOpenid | BODY | STRING | 是 | String可有字段备注:支付场景为WXJS时必填 |
payWay | BODY | STRING | 是 | 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 |
tradeType | BODY | STRING | 是 | String必有字段备注:来自于支付方式中的选项code |
desc | BODY | STRING | 是 | 备注 |
outerPayBizId | BODY | STRING | 是 | 外部支付业务ID,代表一笔支付业务 |
请求Body描述(非Form表单数据)
{
"communityId": "真实项目ID",
"userId": "C端用户ID",
"custId": "客户ID",
"custName": "客户名称",
"billInfo": [
{
"otBillId": "整型,外部系统唯一账单标识",
"houseId": "整型,房屋ID,没有则传-1",
"acctItemTypeId": "整型,账目类型ID",
"feeItemTypeId": "整型,费用科目ID",
"fee": "整型,本金,金额单位为分",
"paidFee": "整型,已缴本金,金额单位为分",
"lfree": "整型,违约金(滞纳金),金额单位为分",
"paidLfree": "整型,已缴违约金,金额单位为分",
"amount": "整型,仪表用量/数量,不存在时填0",
"billingCycle": "整型,应收账期,格式:YYYYMM,例如:201605",
"billStart": "字符串,账单费用开始时间,格式:YYYYMMDDHHMMSS,例如:20160501000000",
"billEnd": "字符串,账单费用结束时间,格式:YYYYMMDDHHMMSS,例如:20160531235959",
"custId": "整型,客户ID(customer表的cust_id)",
"rateStr": "字符串,金额单位元,单价串(阶梯定价时存在多个),多个逗号分隔,例如:1.5,2.0",
"orderId": "整型,外部系统订单ID(不传此值时默认与taskId一致),月卡托收时传托收任务ID",
"unitStr": "计费单位:天,张,吨等",
"initVal": "仪表读数开始值,不存在时填-1",
"endVal": "仪表读数结束值,不存在时填-1",
"feeItemTypeName": "费用科目名称",
"custName": "客户名称",
"custMainId": "对应cust_main表的c_id,没有则传-1",
"resInstType": "资源对象类型,车卡传:28",
"resInstId": "资源对象ID,传:车卡ID",
"resInstCode": "资源编码,传:车卡编码",
"resInstName": "资源名称,传:车卡编码",
"receivableDate": "应收日期,没有则传空"
}
],
"payObjCode": "扩展字段(需记录时可填写)",
"payAttrCode": "扩展字段(需记录时可填写)",
"payAmount": "预存金额",
"desc": "备注",
"payMethod": "String必有字段备注:支付方式",
"appId": "String可有字段备注:支付场景为APP时必填",
"payBzCode": "String必有字段备注:支付场景: APP(原生APP)、WXJS(公众号)、QR1(被扫)、QR2(主扫)",
"payWay": "String必有字段备注:支付方式:来自于支付方式中的选项alaisName",
"tradeType": "String必有字段备注:来自于支付方式中的选项code",
"wxOpenid": "String可有字段备注:支付场景为WXJS时必填",
"wxProvider": "String可有字段备注:支付场景为WXJS时必填",
"outerPayBizId": "外部支付业务ID,代表一笔支付业务"
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
billId | data | STRING | 是 | 预付单ID |
custId | data | STRING | 是 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
异常返回示例
{"code":"1701","message":""}
错误码列表(1701-1799)
错误码 | 错误信息 | 描述 |
---|---|---|
1701 | the charge not exists | 费用不存在 |
公共错误码 | -- | 所有API公用的错误码,请参照《 公共错误码 》 |