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

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：GetSettlement

该 API 用于获取小程序结算收入数据。使用过程中如遇到问题，可在[开放平台服务商专区交流专区 | 微信开放社区](https://developers.weixin.qq.com/community/minihome/mixflow/1355698687267438595)发帖交流。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/operationams?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台调用。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "page",
    "类型": "number",
    "必填": "是",
    "说明": "数据返回页数"
  },
  {
    "参数名": "page_size",
    "类型": "number",
    "必填": "是",
    "说明": "每页返回数据条数"
  },
  {
    "参数名": "start_date",
    "类型": "string",
    "必填": "是",
    "说明": "获取数据的开始时间 yyyy-mm-dd"
  },
  {
    "参数名": "end_date",
    "类型": "string",
    "必填": "是",
    "说明": "获取数据的结束时间 yyyy-mm-dd"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "ret",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "err_msg",
    "类型": "string",
    "说明": "返回错误信息"
  },
  {
    "参数名": "revenue_all",
    "类型": "number",
    "说明": "累计收入"
  },
  {
    "参数名": "penalty_all",
    "类型": "number",
    "说明": "扣除金额"
  },
  {
    "参数名": "settled_revenue_all",
    "类型": "number",
    "说明": "已结算金额"
  },
  {
    "参数名": "settlement_list",
    "类型": "objarray",
    "说明": "settlement_list"
  },
  {
    "参数名": "total_num",
    "类型": "number",
    "说明": "请求返回总条数"
  }
]
```

">

### Res.settlement_list(Array) `Object Payload`

settlement_list

```json
[
  {
    "参数名": "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",
    "类型": "objarray",
    "说明": "slot_revenue"
  }
]
```

__slot_revenue">

### Res.settlement_list(Array).slot_revenue `Object Payload`

slot_revenue

```json
[
  {
    "参数名": "slot_id",
    "类型": "string",
    "说明": "产生收入的广告位"
  },
  {
    "参数名": "slot_settled_revenue",
    "类型": "number",
    "说明": "该广告位结算金额"
  }
]
```

## 4. 注意事项

其中access_token为[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken)

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

## 5. 代码示例

请求示例

```
POST https://api.weixin.qq.com/wxa/operationams?action=agency_get_settlement&access_token=xxxxxxxxxxxxxxx
```
```json
{
  "page": 1,
  "page_size": 8,
  "start_date": "2020-03-01",
  "end_date": "2020-03-16"
}
```

返回示例

```json
{
    "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
}
```

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

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

## 7. 适用范围

本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。