批量查询薪资方案

• 此接口将返回全部薪资方案信息，包括薪资方案 ID、生效日期、薪资项/薪资统计指标等

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/compensation/v1/plans
HTTP Method	GET
接口频率限制	10 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:compensation_plan:read 获取基础薪酬的薪资方案信息
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 corehr:compensation_plan_detail.indicators:read 获取薪资方案的关联薪资指标 corehr:compensation_plan_detail.items: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 获取查询结果 示例值：213432123

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	plan_detail\[\]	薪资方案信息列表
└ id	string	薪资方案ID
└ tid	string	薪资方案版本ID
└ name	string	薪资方案名称
└ description	string	薪资方案描述
└ effective_date	string	薪资方案生效时间
└ plan_scope	plan_scope	薪资方案适用范围
└ is_all	boolean	是否全部范围
└ plan_conditions	plan_condition\[\]	方案适用范围条件组
└ left_type	int	适用范围左值 可选值有： - 1: 部门 - 2: 部门（包含下级部门） - 3: 工作地点 - 4: 工作地点（包含下级地点） - 5: 公司 - 6: 公司（包含下级公司） - 7: 序列 - 8: 序列（包含子序列） - 9: 职务 - 10: 职级 - 11: 人员类型 - 12: 招聘类型 - 13: 国家/地区 - 14: 职等
└ operator	int	适用范围操作 可选值有： - 1: 包含 - 2: 不包含
└ right_value	string\[\]	- 适用范围左值为：部门、部门（包含下级部门），返回：部门ID，详细信息可以通过批量查询部门接口查询获得 - 适用范围左值为：工作地点、工作地点（包含下级工作地点），返回：工作地点ID，详细信息可以通过批量查询地点接口查询获得 - 适用范围左值为：公司、公司（包含下级公司），返回：公司ID，详细信息可以通过通过公司 ID 批量获取公司信息接口查询获得 - 适用范围左值为：序列、序列（包含子序列），返回：序列ID，详细信息可以通过通过序列 ID 批量获取序列信息接口查询获得 - 适用范围左值为：职务，返回：职务ID，详细信息可以通过批量查询职务接口查询获得 - 适用范围左值为：职级，返回：职级ID，详细信息可以通过通过职级 ID 批量获取职级信息接口查询获得 - 适用范围左值为：人员类型，返回：人员类型ID，详细信息可以通过批量查询人员类型接口查询获得 - 适用范围左值为：招聘类型，返回：招聘类型 - 适用范围左值为：国家/地区，返回：国家/地区 - 适用范围左值为：职等，返回：职等ID，详细信息可以通过查询职等接口查询获得
└ currency_id	string	币种ID，可通过接口【查询货币信息】获取
└ probation_salary_status	boolean	开启试用期薪酬状态
└ plan_items	plan_item\[\]	方案关联的薪资项 字段权限要求： corehr:compensation_plan_detail.items:read 获取薪资方案的关联薪资项
└ adjustment_type	string	定薪方式 可选值有： - manual: 手动输入 - formula: 公式计算 - fixed: 固定值
└ item_id	string	薪资项ID，详细信息可以通过批量查询薪资项接口查询获得
└ plan_item_logic	adjustment_logic	方案关联薪资项逻辑配置
└ fixed	string	固定值
└ formula	formula	公式配置
└ expr	string	公式表达式
└ formula_params	formula_param\[\]	公式参数列表
└ ref_type	int	引用类型 可选值有： - 1: 引用薪资项 - 2: 引用薪资指标
└ id	string	引用类型ID
└ probation_discount_type	string	试用期薪酬类型 可选值有： - percentum: 百分比 - manual_input: 手动输入 - none: 不区分试用期和转正薪酬 - fixed: 固定值 - formula: 公式计算 - not_set: 未设置试用期
└ probation_discount_percentum	string	试用期薪酬百分比
└ plan_indicators	plan_indicator\[\]	方案关联的薪资统计指标 字段权限要求： corehr:compensation_plan_detail.indicators:read 获取薪资方案的关联薪资指标
└ indicator_id	string	薪资统计指标ID，详细信息可以通过批量查询薪资统计指标接口查询获得
└ plan_indicator_logic	adjustment_logic	方案关联薪资统计指标逻辑配置
└ fixed	string	固定值
└ formula	formula	公式配置
└ expr	string	公式表达式
└ formula_params	formula_param\[\]	公式参数列表
└ ref_type	int	引用类型 可选值有： - 1: 引用薪资项 - 2: 引用薪资指标
└ id	string	引用类型ID
└ 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": "2134193289",
                "tid": "129738122",
                "name": "基本月薪方案",
                "description": "基本月薪方案描述",
                "effective_date": "2022-10-20",
                "plan_scope": {
                    "is_all": false,
                    "plan_conditions": [
                        {
                            "left_type": 7,
                            "operator": 1,
                            "right_value": [
                                "413431223"
                            ]
                        }
                    ]
                },
                "currency_id": "341324121",
                "probation_salary_status": true,
                "plan_items": [
                    {
                        "adjustment_type": "manual",
                        "item_id": "21341234",
                        "plan_item_logic": {
                            "fixed": "60",
                            "formula": {
                                "expr": "${0} +${1}",
                                "formula_params": [
                                    {
                                        "ref_type": 1,
                                        "id": "23143242"
                                    }
                                ]
                            }
                        },
                        "probation_discount_type": "percentum",
                        "probation_discount_percentum": "80.00"
                    }
                ],
                "plan_indicators": [
                    {
                        "indicator_id": "13243432",
                        "plan_indicator_logic": {
                            "fixed": "60",
                            "formula": {
                                "expr": "${0} +${1}",
                                "formula_params": [
                                    {
                                        "ref_type": 1,
                                        "id": "23143242"
                                    }
                                ]
                            }
                        }
                    }
                ],
                "i18n_names": [
                    {
                        "locale": "zh_cn",
                        "value": "中文名称"
                    }
                ],
                "i18n_descriptions": [
                    {
                        "locale": "zh_cn",
                        "value": "中文名称"
                    }
                ]
            }
        ],
        "page_token": "123412344",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	2290001	server error	服务端异常，请咨询技术支持
400	2290002	param invalid	参数异常，请检查参数
500	2290003	rpc fail	下游服务调用异常，请重试，如重试后仍失败，请咨询技术支持