当前位置: 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 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString
本开放平台“自助对接”功能模块内自助申请,获取方式点击这里
时间戳timestampint
北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
API输入参数签名结果,签名算法介绍单击这里

   3.3 业务请求参数

名称字段类型长度
必须描述
开始时间start_timedatetime

按下载时间增量获取数据,start_time作为开始时间,格式: YYYY-MM-DD HH:MM:SS
结束时间end_timedatetime

按下载时间增量获取数据,end_time作为结束时间,格式: YYYY-MM-DD HH:MM:SS
分页大小page_sizeint

每页返回的数据条数,输入值范围1~100,不传本参数,输入值默认为40使用举例单击这里
页号page_noint


不传值默认从0页开始
店铺编号
shop_no
varchar
40

代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),可通过shop.php获取

4.响应参数

   4.1 公共响应参数

名称字段类型长度
必须描述
错误码codeint11状态码:0表示成功,其他表示失败
错误描述messagevarchar255错误描述
数据条数total_countint11只有page_no = 0 时才返回的符合条件的数据总条数,用来分页
单据详情
account_list
data[]

响应参数的1级数据节点

   4.2 业务响应参数

       account_list[]

名称字段类型长度
必须描述
店铺名称shop_name
varchar
255
店铺名称信息
店铺编号shop_no
varchar40

代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义(ERP店铺界面设置),可通过shop.php获取
主键
rec_id
int11

主键
平台ID
platform_id
smallint6

响应值为代表平台的iD数值,数值对应的平台名称点击这里
店铺id
shop_id
smallint6

店铺id
店铺编号
shop_no
varchar20

代表店铺所有属性的唯一编码,用于店铺区分,ERP内支持自定义
店铺名称
shop_namevarchar128

ERP内支持自定义的店铺名称
平台支付单号
pay_order_novarchar40

平台支付单号
关联订单号
row_order_novarchar64

关联订单号
关联原始单号
order_novarchar64

关联原始单号
账务类型
item_idsmallint6

账务类型详情点击这里,如需判断财务类型,建议使用item_id和sub_item_id两个字段进行判断
子业务类型
sub_item_idsmallint6

子业务类型详情点击这里,如需判断财务类型,建议使用item_id和sub_item_id两个字段进行判断
账务类型名称
item_namevarchar128

账务类型名称详情点击这里
收入金额
in_amountdecimal(19,4)
收入金额
支出金额
out_amountdecimal(19,4)
支出金额
账户余额
balancedecimal(19,4)
账户余额
记账时间create_timedatetime

记账时间,时间格式:yyyy-MM-dd HH:mm:ss
下载时间
createddatetime

下载时间,时间格式:yyyy-MM-dd HH:mm:ss
备注
remarkvarchar128

备注
收款单主键id
voucher_idint11

收款单主键id
状态
post_statustinyint4

状态:2 计入fa_api_account  4 已参与对账  8 完成对账

5.请求示例

PHP
<?php
    require_once("../WdtClient.php");
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/fa_api_account_detail_query.php';
    
    $c->putApiParam('start_time', '2018-12-23 06:02:02');
    $c->putApiParam('end_time', '2018-12-23 06:05:02');
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
           
JAVA
package com.wangdian.api.trade;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import com.wangdian.api.WdtClient;

    public class FaApiAccountDetailQuery {

        public static void main(String[] args) {
            // TODO Auto-generated method stub
            WdtClient client = new WdtClient("传入sid", "传入appkey", "传入appsecret", "传入url");
        //测试环境sid、appkey、密钥请到旺店通开放平台-自助对接-申请测试环境内查看,测试环境url=https://sandbox.wangdian.cn/openapi2/
        //调用正式环境时请将sid、appkey、appsecret切换为实际参数,参数在旺店通开放平台-自助对接-应用管理内应用状态为已上线的应用中查看,调用正式环境注意切换正式环境url=https://api.wangdian.cn/openapi2/
        
            Map<String, String> params = new HashMap<String, String>();
            params.put("start_time", "2020-12-11 12:00:00");
            params.put("end_time", "2020-12-11 13:00:00");
            params.put("page_size", "30");
            params.put("page_no", "0");

            try {
                String response = client.execute("fa_api_account_detail_query.php", params);
                System.out.println(response);
            } catch (IOException e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
        }

    }
           
C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WdtSdk;

namespace FaApiAccountDetailQuery
{
    class FaApiAccountDetailQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/fa_api_account_detail_query.php";

            client.putParams("start_time", "2018-12-23 06:02:02");
            client.putParams("end_time", "2018-12-23 06:05:02");
            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}
           
python
import WdtClient

t = WdtClient.WdtClient('appkey', 'appsecret', 'sid', 'http://sandbox.wangdian.cn/openapi2/')
params = {}
params.update({"start_time": '2021-01-01 00:00:00'})
params.update({"end_time": '2021-01-01 00:59:59'})
params.update({"page_no": '0'})
params.update({"page_size": '100'})

response = t.execute("fa_api_account_detail_query.php", params)
print(response)
           

6.响应示例

   6.1 正常响应示例 

JSON
           
{
	"code": 0,
	"total_count": "1",
	"account_list": [{
		"order_no": "order_no",
		"pay_order_no": "123eee",
		"create_time": "2020-08-20 15:51:47",
		"item_id": "3",
		"created": "2020-08-20 15:51:47",
		"item_name": "分润转账",
		"remark": "3434",
		"rec_id": "1",
		"shop_name": "zsy的小店",
		"in_amount": "5.0000",
		"shop_id": "1",
		"balance": "6.0000",
		"raw_order_no": "trade_order_no",
		"platform_id": "1",
		"out_amount": "5.0000",
		"sub_item_id": "4",
		"voucher_id": "0",
		"post_status": "0",
		"shop_no": "zsy001"
	}],
	"message": "OK"
}
           

   6.2 异常响应示例

JSON
           
{
	"code": 2,
	"message": "结束时间 end_time 为空"
}
           







常用工具