飞书开放平台 Server API 文档

主题

查询经常性支付记录 ​

通过筛选条件，批量查询经常性支付记录

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/compensation/v1/recurring_payment/query
HTTP MethodPOST
接口频率限制10 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:compensation.recurring_payment:read 经常性支付记录读权限
字段权限要求> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头 ​

名称类型必填描述
Authorizationstring是tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Typestring是固定值："application/json; charset=utf-8"

查询参数 ​

名称类型必填描述
page_sizeint是示例值：10
数据校验规则：
- 取值范围：1 ～ 500
page_tokenstring否分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
user_id_typestring是用户 ID 类型
示例值：open_id
可选值有：
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ - people_corehr_id: 以people_corehr_id来识别用户
默认值：open_id
当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体 ​

名称类型必填描述
idsstring\[\]否经常性支付记录id
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
unique_idsstring\[\]否经常性支付记录 unique_id，unique_id 在创建时由上游指定
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
user_idsstring\[\]否员工id，具体类型由入参中的 user_id_type 指定
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
item_idsstring\[\]否薪酬项 id（通过【查询薪酬项】) 接口进行查询）
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
start_date_gtestring否发放开始日期大于等于
示例值："2023-04-01"
数据校验规则：
- 长度范围：0 ～ 255 字符
start_date_ltestring否发放开始日期小于等于
示例值："2023-04-01"
数据校验规则：
- 长度范围：0 ～ 255 字符
end_date_gtestring否发放结束日期大于等于
示例值："2025-04-01"
数据校验规则：
- 长度范围：0 ～ 255 字符
end_date_ltestring否发放结束日期小于等于
示例值："2025-08-01"
数据校验规则：
- 长度范围：0 ～ 255 字符
create_time_gtestring否创建时间大于等于（东八区）
示例值："2023-04-01 12:34:56"
数据校验规则：
- 长度范围：0 ～ 255 字符
create_time_ltestring否创建时间小于等于（东八区）
示例值："2023-04-01 12:34:56"
数据校验规则：
- 长度范围：0 ～ 255 字符
modify_time_gtestring否更新时间大于等于（东八区）
示例值："2023-04-01 12:34:56"
数据校验规则：
- 长度范围：0 ～ 255 字符
modify_time_ltestring否更新时间小于等于（东八区）
示例值："2023-04-01 12:34:56"
数据校验规则：
- 长度范围：0 ～ 255 字符
company_idsstring\[\]否合同主体id属于（可通过 批量查询公司 接口进行查询）
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
service_company_idsstring\[\]否任职公司 id（通过【查询任职公司】 接口进行查询）
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
department_idsstring\[\]否部门 id（通过【查询部门】接口进行查询）
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
job_family_idsstring\[\]否序列 id（通过 【查询序列】接口进行查询）
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
job_level_idsstring\[\]否职级 id（通过 【查询职级】接口进行查询）
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
work_location_idsstring\[\]否工作地点 id（通过 【查询工作地点】 接口进行查询）
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
employee_type_idsstring\[\]否员工类型 id（可通过 【查询员工类型】 接口进行查询）
示例值：["7337149697626801708"]
数据校验规则：
- 长度范围：0 ～ 500
onboard_date_gtestring否入职日期大于等于
示例值："2023-04-01"
数据校验规则：
- 长度范围：0 ～ 255 字符
onboard_date_ltestring否入职日期小于等于
示例值："2023-04-01"
数据校验规则：
- 长度范围：0 ～ 255 字符
offboard_date_gtestring否离职日期大于等于
示例值："2023-04-01"
数据校验规则：
- 长度范围：0 ～ 255 字符
offboard_date_ltestring否离职日期小于等于
示例值："2023-04-01"
数据校验规则：
- 长度范围：0 ～ 255 字符

请求体示例 ​

json
{
    "ids": [
        "7337149697626801708"
    ],
    "unique_ids": [
        "7337149697626801708"
    ],
    "user_ids": [
        "7337149697626801708"
    ],
    "item_ids": [
        "7337149697626801708"
    ],
    "start_date_gte": "2023-04-01",
    "start_date_lte": "2023-04-01",
    "end_date_gte": "2025-04-01",
    "end_date_lte": "2025-08-01",
    "create_time_gte": "2023-04-01 12:34:56",
    "create_time_lte": "2023-04-01 12:34:56",
    "modify_time_gte": "2023-04-01 12:34:56",
    "modify_time_lte": "2023-04-01 12:34:56",
    "company_ids": [
        "7337149697626801708"
    ],
    "service_company_ids": [
        "7337149697626801708"
    ],
    "department_ids": [
        "7337149697626801708"
    ],
    "job_family_ids": [
        "7337149697626801708"
    ],
    "job_level_ids": [
        "7337149697626801708"
    ],
    "work_location_ids": [
        "7337149697626801708"
    ],
    "employee_type_ids": [
        "7337149697626801708"
    ],
    "onboard_date_gte": "2023-04-01",
    "onboard_date_lte": "2023-04-01",
    "offboard_date_gte": "2023-04-01",
    "offboard_date_lte": "2023-04-01"
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ page_tokenstring分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
  └ has_moreboolean是否还有更多项
  └ recordsrecurring_payment\[\]经常性支付授予记录
    └ idstring经常性支付记录id
    └ unique_idstring外部幂等id，由上游业务决定
    └ user_idstring员工id，具体类型由入参中的 user_id_type 指定
    └ item_idstring薪酬项id
    └ issuance_typestring发放方式
可选值有：
- with_salary: 随工资发放 - with_cash: 现金发放 - with_physical_distribution: 实物发放 - with_year_end_bonus: 随年终奖发放
    └ each_amountstring单次发放金额
    └ start_datestring发放开始日期
    └ end_datestring发放结束日期
    └ issuance_periodstring发放频率
可选值有：
- year: 年 - half_year: 半年 - quarterly: 季度 - bimonthly: 双月 - month: 月 - biweekly: 双周 - week: 周 - day: 日 - hour: 小时
    └ currency_idstring币种id
    └ remarkstring备注
    └ issuance_country_region_idstring发放国家id（可通过 https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/basic_info-country_region/search进行查询）

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=",
        "has_more": true,
        "records": [
            {
                "id": "7397033607132351532",
                "unique_id": "7402510801304718380_7309316347007764012_7402523725868058156_1726070400000_10000",
                "user_id": "7337149697626801708",
                "item_id": "7411039006180312620",
                "issuance_type": "with_salary",
                "each_amount": "24.00",
                "start_date": "2024-01-10",
                "end_date": "2025-01-20",
                "issuance_period": "year",
                "currency_id": "6863329932261459464",
                "remark": "这是个备注",
                "issuance_country_region_id": "6862995745046267400"
            }
        ]
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4002290001param is invalid参数异常，请检查入参
5002290002server error服务端异常，请稍后重试

内容来源：飞书开放平台 · 自动爬取整理

本镜像仅供学习与查阅，文档版权归飞书所有