# 员工消费汇总

# 1.概述

通过【员工消费汇总】接口，客户平台可以汇总查询员工消费时间段内的消费金额。

# 2.接口基本信息

名称	描述
请求方式	POST
调用地址	测试环境：https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/order/staffConsumeSummary 正式环境：https://bep-openapi.meituan.com/api/sqt/open/order/staffConsumeSummary
调用方	客户平台
响应方	美团企业版
响应超时时间	5秒
调用限频	每分钟访问不超过100次，每天累计访问不超过100000次

# 2.1.请求体

名称	类型	是否必填	示例	说明
accessKey	String	是	B3GFJIEHNEM1RLV-TK	美团企业版分配给客户的接入秘钥
content	String	是	UgxoCGPQIzoP	请求体内容，将请求参数JSON序列化后进行加密的结果值，参照：签名实例

# content加密前数据结构

名称	类型	是否必填	示例	说明
ts	Long	是	1617085650321	13位时间戳。若请求发起时间与平台接受请求时间相差大于10分钟，平台将直接拒绝本次请求
entId	Long	是	46574	企业ID
staffId	Long	是	12456	员工ID
minCreateTime	Long	否	1569859200000	最小订单创建时间，13位时间戳，需要与最大订单创建时间结合使用，可以实现下单时间的区间查询
maxCreateTime	Long	否	1569859200000	最大订单创建时间，13位时间戳，需要与最小订单创建时间结合使用，可以实现下单时间的区间查询

# 2.2.响应参数

名称	类型	是否必填	示例	说明
traceId	String	是	56a0af18ae30a168d4006c7c	日志查询ID，用于排查问题
status	Integer	是	0	接口响应编码，编码枚举值和解决方案详见第四章错误码
msg	String	否		错误描述信息
data	String	是	UgxoCGPQIzoP	响应数据，将响应参数JSON序列化后进行加密的结果值，解密秘钥使用secretKey参数

# data解密后数据结构

名称	类型	是否必填	示例	说明
entPayAmountSum	String	是	"100.00"	企业支付金额，单位元，精确到小数点后两位
staffPayAmountSum	String	是	"50.00"	员工支付金额，单位元，精确到小数点后两位
entRefundAmountSum	String	是	"50.00"	企业退款金额，单位元，精确到小数点后两位
staffRefundAmountSum	String	是	"0.00"	员工退款金额，单位元，精确到小数点后两位

# 3.示例

# 3.1.请求示例

# 3.1.1.请求示例

{
  "accessKey": "B3GFJIEHNEM1RLV-TK",
  "content": "xSXdUHGlwuV8gC60Mn4Sb7ZJfkhMI5efG5XBfjRGXI0Mncuusxd6XffiR67dJpV0vAfc8kY_AME6aVHB0eTQBJeES1OY816lO5-1aTTJivJun1z3a_2doJ7UddwbgLK3SWC2uzKCs6ukfC-AFr1_0H8WwOA71EuDvfO92u2_E8Y"
}

# 3.1.2.请求参数content解析

{
  "ts": 1705657790074,
  "entId": 100991,
  "staffId": 20432869,
  "minCreateTime": 1704038553000,
  "maxCreateTime": 1704902553000
}

# 3.2.响应示例

# 3.2.1.响应结果

{
  "traceId": "56a0af18ae30a168d4006c7c",
  "status": 0,
  "data": "PFdd-pBPLCDivzivFcLlD6yFxYi8H8diuDKMKmznW8EhFZBdgiU1nfyeX9qq5ZGEShgXWKkaSeudPrRkjqHYuizqWglhHUqyOKZywlOm3uvncl3x8CjwKZ-HV2eTYeNceb7YRQFKounYCyS3U9QUuw"
}

# 3.2.2.响应参数data解析

{
  "status": 0,
  "message": null,
  "data": {
    "entPayAmountSum": "3.00",
    "staffPayAmountSum": "0.00",
    "entRefundAmountSum": "2.00",
    "staffRefundAmountSum": "0.00"
  }
}

# 4.错误码

# 4.1.公共错误码

错误码	错误描述	解决方案
10010002	企业已停止合作，请联系客户经理进行确认	将接口调用的entId参数给到客户经理，由客户经理确认企业状态是否在合作中
10010003	content不合法	详细阅读content参数加密说明（签名实例），确认content加密方式和content解密前传参是否正确
10010004	ts缺失或ts时间已过期	确认ts是否传值并为13位时间戳，如果正确传值，则确认请求发起时间与美团企业版接受请求的时间差是否超过10分钟
10010005	entId不能为空	entId参数不可为空，如果未拿到entId参数，可以咨询客户经理获取
20010001	accessKey不合法	检查accessKey是否为客户经理给到的值，如果accessKey值正确，确认调用环境是否和accessKey一致，如使用测试环境的accessKey调用线上的接口
20010002	请求path不合法	检查接口调用地址是否正确，如是否有非法字符
20010003	鉴权失败，无接口访问权限	将接口调用地址给到客户经理，由客户经理检查接口权限是否开通并保存成功
20010004	越权访问，无法访问该企业数据，请检查entId的正确性	检查accessKey和entId两个参数的对应关系是否正确
30010001	访问频率过高	请确认接口访问频率，每个接口默认调用限频为每分钟不超过100次，超出调用频率会调用此错误
30010002	访问次数超过配额	请确认接口的累计访问次数，每个接口的默认累计调用量为10w次，超出限额则会报错

# 4.2.业务错误码

错误码	错误描述	解决方案
10210000	参数异常	请根据msg中内容排查传值情况，确认必填字段是否传值，如entId、staffId是否传值
10210002	参数组合不匹配	请根据msg中内容排查传值情况，确认组合字段是否全部传值，如minCreateTime和maxCreateTime需要同时传值才生效

# 5.代码实例

依赖SDK包地址：SDK下载地址

package com.meituan.sqt.demo.in.order;

import com.meituan.sqt.client.SqtClient;
import com.meituan.sqt.constant.CommonConstants;
import com.meituan.sqt.enums.ResponseStatusEnum;
import com.meituan.sqt.exception.MtSqtException;
import com.meituan.sqt.request.in.order.StaffConsumeSummaryRequest;
import com.meituan.sqt.response.in.BaseApiResponse;
import com.meituan.sqt.response.in.order.StaffConsumeSummaryResult;

import java.util.Objects;

public class StaffConsumeSummaryDemo {

    private static final String invokeUrl = "https://waimai-openapi.apigw.test.meituan.com/api/sqt/open/order/staffConsumeSummary";

    private static SqtClient sqtClient = null;

    static {
        // 初始化SqtClient，只需要初始化一次即可
        // entId，accessKey，secretKey需要根据不同环境动态的设置获取
        sqtClient = new SqtClient.Builder()
                .setEntId(CommonConstants.entId)
                .setAccessKey(CommonConstants.accessKey)
                .setSecretKey(CommonConstants.secretKey)
                .build();
    }

    public static void main(String[] args) throws MtSqtException {
        // 1. 构建请求对象
        StaffConsumeSummaryRequest queryRequest = new StaffConsumeSummaryRequest();
        queryRequest.setTs(System.currentTimeMillis());
        queryRequest.setEntId(sqtClient.getEntId());
        queryRequest.setStaffId(20432869L);
        queryRequest.setMinCreateTime(1704038553000L);
        queryRequest.setMaxCreateTime(1704902553000L);

        // 2. API调用
        // 注意：超时时间默认以请求对象中注解ApiMeta上设置的为准，也可以自定义传递对应的超时时间
        BaseApiResponse<StaffConsumeSummaryResult> response = sqtClient.invokeApi(invokeUrl, queryRequest, null, null);

        // 3. 响应结果为空处理
        if (response == null) {
            // 处理响应结果为空情况
            // ...

        }

        // 4. 获取结果
        if(Objects.equals(ResponseStatusEnum.SUCCESS.getCode(), response.getStatus())) {
            // 4.1 请求成功，获取订单详情查询结果
            StaffConsumeSummaryResult realData = response.getRealData();
            // 4.2 处理查询成功后的业务逻辑


        } else {
            // 处理请求失败场景
            handleRespFailResult(response);
        }
    }

    private static void handleRespFailResult(BaseApiResponse<StaffConsumeSummaryResult> response) {
        // 访问频率过高
        if (ResponseStatusEnum.HIGH_FREQUENCY_ACCESS.getCode().intValue() == response.getStatus()) {
            // 解决方案参照：https://h5.dianping.com/app/bep-docs/open-platform-doc/guide/rate_limiting.html
        }
        // 访问次数超过配额
        if (ResponseStatusEnum.EXCEED_ACCESS_NUMBER.getCode().intValue() == response.getStatus()) {
            // 解决方案参照：https://h5.dianping.com/app/bep-docs/open-platform-doc/guide/rate_limiting.html
        }
        // 其它失败场景

    }

}

# 6.版本记录

版本号	版本日期	更新内容
v1.0	2023-01-19	新增员工消费汇总查询接口

← 订单详情业务字段说明订单扩展信息查询 →