查询发薪活动列表

根据「发薪日起止范围」、「发薪活动状态」和「分页参数」查询发薪活动列表。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/payroll/v1/payment_activitys
HTTP Method	GET
接口频率限制	5 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	payroll:payment_activity:read 获取发薪活动列表数据

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
pay_period_start_date	string	是	发薪日开始时间，格式：YYYY-MM-dd，[pay_period_start_date, pay_period_end_date] 是一个左闭右闭区间。 示例值：2024-01-01
pay_period_end_date	string	是	发薪日结束时间，格式：YYYY-MM-dd，[pay_period_start_date, pay_period_end_date] 是一个左闭右闭区间。 示例值：2024-01-31
page_size	int	是	分页大小，传值范围为 [1, 100] 示例值：10
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
statuses	int\[\]	否	发薪活动审批状态列表，其中： 1. 100 - 待确认名单 2. 150 - 待提交审批 3. 200 - 审批中 4. 300 - 审批被拒绝 5. 350 - 审批被撤回 6. 360 - 审批被撤销 7. 375 - 审批通过 8. 400 - 已封存 示例值：100 数据校验规则： - 长度范围：0 ～ 100

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ payment_activitys	payment_activity\[\]	发薪活动列表
└ activity_id	string	发薪活动唯一标识
└ activity_names	i18n_content\[\]	发薪活动名称
└ locale	string	语种
└ value	string	语种对应的值
└ pay_date	string	发薪活动发薪日期
└ total_number_of_payroll	int	发薪总笔数
└ number_of_calculation_activities	int	关联的算薪活动个数
└ calculation_activities	calculation_activity\[\]	发薪活动关联的算薪活动详情
└ calculation_activity_id	string	算薪活动唯一标识
└ calculation_activity_names	i18n_content\[\]	算薪活动名称
└ locale	string	语种
└ value	string	语种对应的值
└ activity_status	int	发薪活动审批状态，其中：100-待确认发薪名单；150-待提交审批；200-审批中；300-审批被拒绝；350-审批被撤回；360-审批被撤销；375-审批通过；400-已封存。
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "payment_activitys": [
            {
                "activity_id": "7202076988667019308",
                "activity_names": [
                    {
                        "locale": "zh_cn",
                        "value": "名称"
                    }
                ],
                "pay_date": "2020-10-31",
                "total_number_of_payroll": 100,
                "number_of_calculation_activities": 1000,
                "calculation_activities": [
                    {
                        "calculation_activity_id": "7371828319837012009",
                        "calculation_activity_names": [
                            {
                                "locale": "zh_cn",
                                "value": "名称"
                            }
                        ]
                    }
                ],
                "activity_status": 400
            }
        ],
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	2500001	unknown error	未知错误，请联系技术支持。
400	2500002	param is invalid	参数错误，请检查参数。
500	2500003	rpc fail	请求调用出错，请联系技术支持。