# 获取小程序结算收入数据

接口应在服务器端调用，详细说明参见服务端API。

# 接口说明

# 接口英文名

GetSettlement

# 功能描述

该 API 用于获取小程序结算收入数据。使用过程中如遇到问题，可在开放平台服务商专区交流专区 | 微信开放社区发帖交流。

# 注意事项

其中access_token为authorizer_access_token

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/wxa/operationams?action=agency_get_settlement&access_token=xxxxxxxxxxxxxxx

# 请求参数

属性	类型	必填	说明
page	number	是	数据返回页数
page_size	number	是	每页返回数据条数
start_date	string	是	获取数据的开始时间 yyyy-mm-dd
end_date	string	是	获取数据的结束时间 yyyy-mm-dd

# 返回参数

属性

类型

说明

ret

number

错误码

err_msg

string

返回错误信息

revenue_all

number

累计收入

penalty_all

number

扣除金额

settled_revenue_all

number

已结算金额

settlement_list

array<object>

settlement_list

属性

类型

说明

date

string

数据更新时间

zone

string

日期区间

month

string

收入月份

order

number

1 = 上半月，2 = 下半月

sett_status

number

1 = 结算中；2、3 = 已结算；4 = 付款中；5 = 已付款

settled_revenue

number

区间内结算收入

sett_no

string

结算单编号

mail_send_cnt

string

申请补发结算单次数

slot_revenue

array<object>

slot_revenue

	属性	类型	说明
	slot_id	string	产生收入的广告位
	slot_settled_revenue	number	该广告位结算金额

total_num

number

请求返回总条数

# 其他说明

1、返回settlement_list按照date降序排列，用户请以分页的形式获取。只要与获取数据的起止时间有重合，结算区间对应的数据都将返回。例如，请求2月11日至3月26日的数据，将会返回2月上半月、2月下半月、3月上半月、3月下半月四个结算区间的数据。

# 调用示例

示例说明: HTTPS请求

# 请求数据示例


{
    "page":  1,
    "page_size": 8,
    "start_date": "2020-03-01",
    "end_date": "2020-03-16"
}

# 返回数据示例


{
    "base_resp":{
        "err_msg":"ok",
        "ret":0
    },
    "body":"深圳市腾讯计算机系统有限公司",
    "penalty_all":0,
    "revenue_all":5178368698,
    "settled_revenue_all":2613696765,
    "settlement_list":[
        {
            "date":"2020-03-25",
            "zone":"2020年3月1日至15日"
            "month":"202003",
            "order":1,
            "sett_status":1,
            "settled_revenue":718926045,
            "sett_no":"XXX",
            "mail_send_cnt":"0",
            "slot_revenue":[
                {
                    "slot_id":"SLOT_ID_WEAPP_BANNER",
                    "slot_settled_revenue":34139443
                },
                {
                    "slot_id":"SLOT_ID_WEAPP_REWARD_VIDEO",
                    "slot_settled_revenue":684786602
                }
            ]
        }
    ],
    "total_num":1
}

# 错误码

错误码	错误码取值	解决方案
0	ok	ok
-202	内部错误	可在一段时间后重试
1700	参数错误	检验输入参数是否符合文档说明
1701	参数错误	检验输入参数是否符合文档说明
1735	商户未完成协议签署流程	完成签约操作
1737	操作过快	等待一分钟后重新操作
1807	无效流量主	通过开通流量主接口为该appid开通流量主
2009	无效流量主	通过开通流量主接口为该appid开通流量主
2056	服务商未在变现专区开通账户	在第三方平台页面的变现专区开通服务