飞书开放平台 Server API 文档

主题

更新合同 ​

通过该接口可以更新员工合同相关信息，没有修改的参数会保留原值

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v1/contracts/:contract_id
HTTP MethodPATCH
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:corehr 更新核心人事信息

请求头 ​

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

路径参数 ​

名称类型描述
contract_idstring合同ID，该ID可以通过【批量查询合同】接口获取
示例值："7091849027838838316"

查询参数 ​

名称类型必填描述
client_tokenstring否自定义值，根据client_token是否一致来判断是否为同一请求
示例值：227988d7-66da-4afb-9943-32e73d5cda8b

请求体 ​

名称类型必填描述
effective_timestring否合同开始日期
示例值："2050-01-01 00:00:00"
expiration_timestring否合同实际结束日期，合同实际结束日期小于等于合同结束日期
示例值："9999-12-31 23:59:59"
employment_idstring否该接口不能传递该参数，否则会更新失败。
示例值："空"
contract_typeenum否合同类型，枚举值可通过文档【飞书人事枚举常量】合同类型（contract_type）枚举定义部分获得
  └ enum_namestring是枚举值
示例值："labor_contract"
first_party_company_idstring否甲方, 引用Company的ID，详细信息可通过【查询单个公司】 接口查询获得
示例值："6892686614112241165"
person_idstring否该接口不能传递该参数，否则会更新失败。
示例值："空"
custom_fieldsobject_field_data\[\]否自定义字段，预留，暂时不支持
  └ field_namestring是字段名
示例值："name"
  └ valuestring是字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")
示例值："Sandy"
duration_typeenum否期限类型，枚举值可通过文档【飞书人事枚举常量】合同期限类型（duration_type）枚举定义部分获得
示例值：fixed_term
  └ enum_namestring是枚举值
示例值："open_ended"
contract_end_datestring否合同预计的结束日期
示例值："2006-01-02"
contract_numberstring否合同编号
示例值："6919737965274990093"
signing_typeenum否签订类型，枚举值可通过文档【飞书人事枚举常量】签订类型（signing_type）枚举定义部分获得
  └ enum_namestring是枚举值
示例值："new"

请求体示例 ​

json
{
    "effective_time": "2050-01-01 00:00:00",
    "expiration_time": "9999-12-31 23:59:59",
    "employment_id": "空",
    "contract_type": {
        "enum_name": "labor_contract"
    },
    "first_party_company_id": "6892686614112241165",
    "person_id": "空",
    "custom_fields": [
        {
            "field_name": "name",
            "value": "Sandy"
        }
    ],
    "duration_type": {
        "enum_name": "open_ended"
    },
    "contract_end_date": "2006-01-02",
    "contract_number": "6919737965274990093",
    "signing_type": {
        "enum_name": "new"
    }
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ contractcontract合同
    └ idstring合同ID
    └ effective_timestring合同开始日期
    └ expiration_timestring实际结束日期
    └ employment_idstring雇员 ID，详细信息可通过【批量查询员工信息】 接口查询获得
    └ contract_typeenum合同类型，枚举值可通过文档【飞书人事枚举常量】合同类型（contract_type）枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring名称信息的语言
        └ valuestring名称信息的内容
    └ first_party_company_idstring合同主体, 详细信息可通过【查询公司详情接口】接口查询获得
    └ person_idstringPerson ID，详细信息可通过接口文档【查询个人信息接口】接口查询获得
    └ custom_fieldsobject_field_data\[\]自定义字段
      └ field_namestring字段名
      └ valuestring字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")
    └ duration_typeenum期限类型，枚举值可通过文档【飞书人事枚举常量】合同期限类型（duration_type）枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring名称信息的语言
        └ valuestring名称信息的内容
    └ contract_end_datestring合同结束日期
    └ contract_numberstring合同编号
    └ signing_typeenum签订类型，枚举值可通过文档【飞书人事枚举常量】签订类型（signing_type）枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring名称信息的语言
        └ valuestring名称信息的内容
    └ contract_statusenum合同协议状态，枚举值可通过文档【飞书人事枚举常量】合同协议状态（contract_status）枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言
        └ valuestring内容
    └ renewal_statusenum续签状态，枚举值可通过文档【飞书人事枚举常量】续签状态（renewal_status）枚举定义部分获得
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言
        └ valuestring内容
    └ signing_timesint第几次签署

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "contract": {
            "id": "6919737965274990093",
            "effective_time": "2050-01-01 00:00:00",
            "expiration_time": "9999-12-31 23:59:59",
            "employment_id": "6893013238632416776",
            "contract_type": {
                "enum_name": "labor_contract",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "劳动合同"
                    }
                ]
            },
            "first_party_company_id": "6892686614112241165",
            "person_id": "151515151",
            "custom_fields": [
                {
                    "field_name": "name",
                    "value": "Sandy"
                }
            ],
            "duration_type": {
                "enum_name": "fixed_term",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "固定期限类型合同"
                    }
                ]
            },
            "contract_end_date": "2006-01-02",
            "contract_number": "6919737965274990093",
            "signing_type": {
                "enum_name": "changed",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "变更"
                    }
                ]
            },
            "contract_status": {
                "enum_name": "phone_type",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "刘梓新"
                    }
                ]
            },
            "renewal_status": {
                "enum_name": "phone_type",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "刘梓新"
                    }
                ]
            },
            "signing_times": 1
        }
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4001160545effective time has been occupied该时间段已存在合同，请修改合同生效时间段
4001160546Conflicting contracts existed该合同已经存在

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

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