批量查询薪资项

批量查询薪资项

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/compensation/v1/items
HTTP Method	GET
接口频率限制	10 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:compensation_item:read 获取基础薪酬的薪资项信息

请求头

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

查询参数

名称	类型	必填	描述
page_size	int	是	分页大小 示例值：100 默认值：100 数据校验规则： - 取值范围：1 ～ 500
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：5234233214

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	item\[\]	薪资项信息列表
└ id	string	薪资项ID
└ name	string	薪资项名称
└ description	string	薪资项描述
└ category_id	string	薪资项分类ID，详细信息可以通过批量获取薪资项分类信息接口查询获得
└ value_type	string	薪资项数值类型 可选值有： - money: 金额 - number: 数值 - percent: 百分比
└ pay_off_frequency_type	string	发放频率 可选值有： - year: 年 - half_year: 半年 - quarterly: 季度 - bimonthly: 双月 - month: 月 - biweekly: 双周 - week: 周 - day: 日 - hour: 小时
└ decimal_places	int	小数位数
└ active_status	int	启用状态 可选值有： - 1: 启用 - 0: 禁用
└ i18n_names	i18n_content\[\]	多语言名称
└ locale	string	语言版本，例如：“zh-CN”、“en-US”
└ value	string	语言名称
└ i18n_descriptions	i18n_content\[\]	多语言描述
└ locale	string	语言版本，例如：“zh-CN”、“en-US”
└ value	string	语言名称
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "7196951947268589113",
                "name": "基本月薪",
                "description": "每月份的薪酬",
                "category_id": "7196951947268589223",
                "value_type": "money",
                "pay_off_frequency_type": "month",
                "decimal_places": 2,
                "active_status": 1,
                "i18n_names": [
                    {
                        "locale": "zh_cn",
                        "value": "中文名称"
                    }
                ],
                "i18n_descriptions": [
                    {
                        "locale": "zh_cn",
                        "value": "中文名称"
                    }
                ]
            }
        ],
        "page_token": "1234452132",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	2290001	server error	服务端异常
400	2290002	param invalid	参数异常
500	2290003	rpc fail	下游服务异常