当前位置: API文档
fa_api_account_detail_query.php(查询平台账单)
1.接口说明
1.1 接口描述:获取旺店通ERP的平台账单信息 |
1.2 适用版本:客户端 V2.5.0.3及以上版本 |
1.3 增量获取:按照下载时间增量获取数据,请求时输入start_time和end_time作为时间跨度的筛选条件。 |
1.4 时间跨度:start_time和end_time最大跨度为24小时,开始时间和结束时间取值范围为闭区间取值,例如2018-11-01 00:00:00至2018-11-01 23:59:59,建议根据获取数据量的多少适当减小时间跨度。 |
1.5注意事项:本接口不返回淘系及系统供销平台订单数据,相关平台规则单击这里。淘系订单数据获取办法单击这里。其他平台的敏感信息会根据平台规则同步调整。 |
2.调用场景
2.1 举例说明: |
3.请求参数说明
3.1 请求地址
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/fa_api_account_detail_query.php |
正式环境 | https://api.wangdian.cn/openapi2/fa_api_account_detail_query.php |
3.2 公共请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
接口账号 | appkey | String | 是 | 本开放平台“自助对接”功能模块内自助申请,获取方式点击这里 | |
时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
签名 | sign | String | 是 | API输入参数签名结果,签名算法介绍单击这里 |
3.3 业务请求参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
开始时间 | start_time | datetime | 是 | 按下载时间增量获取数据,start_time作为开始时间,格式: YYYY-MM-DD HH:MM:SS | |
结束时间 | end_time | datetime | 是 | 按下载时间增量获取数据,end_time作为结束时间,格式: YYYY-MM-DD HH:MM:SS | |
分页大小 | page_size | int | 否 | 每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40使用举例单击这里 | |
页号 | page_no | int | 否 | 不传值默认从0页开始 | |
店铺编号 | shop_no | varchar | 40 | 否 | 代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),可通过shop.php获取 |
4.响应参数
4.1 公共响应参数
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 11 | 是 | 状态码:0表示成功,其他表示失败 |
错误描述 | message | varchar | 255 | 是 | 错误描述 |
数据条数 | total_count | int | 11 | 否 | 只有page_no = 0 时才返回的符合条件的数据总条数,用来分页 |
单据详情 | account_list | data[] | 是 | 响应参数的1级数据节点 |
4.2 业务响应参数
account_list[]
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
店铺名称 | shop_name | varchar | 255 | 是 | 店铺名称信息 |
店铺编号 | shop_no | varchar | 40 | 是 | 代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),可通过shop.php获取 |
主键 | rec_id | int | 11 | 是 | 主键 |
平台ID | platform_id | smallint | 6 | 是 | 响应值为代表平台的iD数值,数值对应的平台名称点击这里 |
店铺id | shop_id | smallint | 6 | 是 | 店铺id |
店铺编号 | shop_no | varchar | 20 | 是 | 代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义 |
店铺名称 | shop_name | varchar | 128 | 是 | ERP内支持自定义的店铺名称 |
平台支付单号 | pay_order_no | varchar | 40 | 是 | 平台支付单号 |
关联订单号 | raw_order_no | varchar | 64 | 是 | 关联订单号 |
关联原始单号 | order_no | varchar | 64 | 是 | 关联原始单号 |
账务类型 | item_id | smallint | 6 | 是 | 账务类型详情点击这里,如需判断财务类型,建议使用item_id和sub_item_id两个字段进行判断 |
子业务类型 | sub_item_id | smallint | 6 | 是 | 子业务类型详情点击这里,如需判断财务类型,建议使用item_id和sub_item_id两个字段进行判断 |
账务类型名称 | item_name | varchar | 128 | 是 | 账务类型名称详情点击这里 |
收入金额 | in_amount | decimal | (19,4) | 是 | 收入金额 |
支出金额 | out_amount | decimal | (19,4) | 是 | 支出金额 |
账户余额 | balance | decimal | (19,4) | 是 | 账户余额 |
记账时间 | create_time | datetime | 是 | 记账时间,时间格式:yyyy-MM-dd HH:mm:ss | |
下载时间 | created | datetime | 是 | 下载时间,时间格式:yyyy-MM-dd HH:mm:ss | |
备注 | remark | varchar | 128 | 是 | 备注 |
收款单主键id | voucher_id | int | 11 | 是 | 收款单主键id |
状态 | post_status | tinyint | 4 | 是 | 状态:2 计入fa_api_account 4 已参与对账 8 完成对账 |
6.响应示例
6.1 正常响应示例
6.2 异常响应示例
JSON | { "code": 2, "message": "结束时间 end_time 为空" } |