文档中心 > API类目 > 社区物业API

alipay.eco.cplife.bill.batchquery (物业费账单数据批量查询)

开发者批量查询自己帮助物业上传成功的账单。

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.eco.cplife.bill.batchquery
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
community_id String 必须 32 支付宝社区小区统一编号,必须在授权物业账号名下存在。 AJ5OFJC124403
bill_status String 可选 32 查询过滤条件之一:根据账单状态查询,不传该字段则返回所有状态的账单。

状态值:
FINISH_PAYMENT - 用户完成支付和销账
UNDER_PAYMENT - 账单锁定待用户完成支付
WAIT_PAYMENT - 待缴且未过缴费截止日期
OUT_OF_DATE - 未支付且已过缴费截止日期
FINISH_PAYMENT
out_room_id String 可选 64 查询过滤条件之一:
根据物业系统端房屋编号查询
453200086
cost_type String 可选 16 查询过滤条件之一:
根据费用类型查询,只支持精确查询。
物业管理费
acct_period String 可选 16 查询过滤条件之一:
根据账期查询
2016年07月
release_day String 可选 8 查询过滤条件之一:
根据出账日期查询,格式为YYYYMMDD,只支持精确查询。
20160701
batch_id String 可选 64 查询过滤条件之一:
根据开发者上传物业费账单时需要的批次号查询指定批次下上传成功的账单。
201607192119100001
page_num Number 可选 8 分页查询的当前页码数,分页从1开始计数。
该参数不传入的时候,默认为1。
2
page_size Number 可选 8 分页查询的每页最大数据条数,取值范围1-500。
不传该参数默认为200。
300

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
current_page_num Number 必填 8 当前页码 1
total_bill_count Number 必填 8 符合条件的总结果数 123
bill_result_set CPBillResultSet [] 选填 - 若查询到符合条件的账单条目,返回结果集
  • └ bill_entry_id
  • String
  • 必填
  • 32
  • 物业费账单应收明细条目ID
  • 15000120160701
  • └ out_room_id
  • String
  • 必填
  • 64
  • 物业系统端房屋编号
  • 453200086
  • └ room_address
  • String
  • 选填
  • 64
  • 房屋门牌地址
  • 1号102室
  • └ cost_type
  • String
  • 必填
  • 32
  • 费用类型
  • 物业管理费
  • └ bill_entry_amount
  • String
  • 必填
  • 11
  • 应收金额,单位为元,精确到小数点后两位,取值范围[0.01,100000000]
  • 200.00
  • └ acct_period
  • String
  • 必填
  • 20
  • 账期
  • 2016年07月
  • └ release_day
  • String
  • 必填
  • 8
  • 出账日期
  • 20160701
  • └ deadline
  • String
  • 必填
  • 8
  • 缴费截止日期
  • 20160831
  • └ status
  • String
  • 必填
  • 32
  • 账单条目当前状态,状态值:
    FINISH_PAYMENT - 用户完成支付和销账
    UNDER_PAYMENT - 账单锁定待用户完成支付
    WAIT_PAYMENT - 待缴且未过缴费截止日期
    OUT_OF_DATE - 未支付且已过缴费截止日期
  • FINISH_PAYMENT

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayEcoCplifeBillBatchqueryRequest request = new AlipayEcoCplifeBillBatchqueryRequest();
request.setBizContent("{" +
"\"community_id\":\"AJ5OFJC124403\"," +
"\"bill_status\":\"FINISH_PAYMENT\"," +
"\"out_room_id\":\"453200086\"," +
"\"cost_type\":\"物业管理费\"," +
"\"acct_period\":\"2016年07月\"," +
"\"release_day\":\"20160701\"," +
"\"batch_id\":\"201607192119100001\"," +
"\"page_num\":2," +
"\"page_size\":300" +
"  }");
AlipayEcoCplifeBillBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_eco_cplife_bill_batchquery_response":{
		"msg":"Success",
		"total_bill_count":123,
		"code":"10000",
		"bill_result_set":[
			{
				"out_room_id":"453200086",
				"cost_type":"物业管理费",
				"bill_entry_id":"15000120160701",
				"room_address":"1号102室",
				"release_day":"20160701",
				"acct_period":"2016年07月",
				"deadline":"20160831",
				"bill_entry_amount":"200.00",
				"status":"FINISH_PAYMENT"
			}
		],
		"current_page_num":1
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

  • JSON示例
{
	"alipay_eco_cplife_bill_batchquery_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误。 检查请求参数,修改后重新发起请求。
SYSTEM_ERROR 系统繁忙 稍后重试。
COMMUNITY_NOT_EXISTING 请求的小区编号在当前物业账号名下不存在。 请通过批量查询支付宝小区编号接口确认授权物业公司账号名下是否存在该小区编号,修改并重试。
INVALID_BILL_STATUS 传入的账单状态值非法。 请参照文档,修改状态值并重试。
ROOM_NOT_EXISTING 请求的房屋在该小区下不存在。 请检查物业端房屋编号有效性,修改并重试。
INVALID_PAGE_SIZE 分页查询的每页最大记录条数非法。 请参照文档,修改后重试。
INVALID_PAGE_NUM 传入的页码非法,页码需从1开始计数。 如传入页码,需从1开始计数,请修改并重试。
INVALID_RELEASE_DAY 出账日期参数格式不合法 出账日期为YYYYMMDD格式,请修改并重试。

公共错误码

返回
顶部