新建合同
通过本接口可以为员工创建一份新合同
Tip: 延迟说明:搜索同步延迟 10s 以内,即:直接创建对象后10s内调用此接口可能查询不到数据。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/contracts |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | corehr:corehr 更新核心人事信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
client_token | string | 否 | 自定义值,根据client_token是否一致来判断是否为同一请求 示例值:22ff85f7-5938-4579-9b57-d52cfeb05d52 |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
effective_time | string | 是 | 合同开始日期,格式:"YYYY-MM-DD HH-mm-ss" 示例值:"2050-01-01 00:00:00" |
expiration_time | string | 否 | 实际结束日期,格式:"YYYY-MM-DD HH-mm-ss" 示例值:"9999-12-31 23:59:59" |
employment_id | string | 是 | 雇佣 ID,详细信息可通过【搜索员工信息】接口查询获得 示例值:"6893013238632416776" |
contract_type | enum | 是 | 合同类型,枚举值可查询获取字段详情接口获取,按如下参数查询即可: - object_api_name:contract - custom_api_name:contract_type |
└ enum_name | string | 是 | 枚举值 示例值:"labor_contract" |
first_party_company_id | string | 是 | 合同签约公司, 引用的公司ID,详细信息可通过【查询单个公司】接口查询获得 示例值:"6892686614112241165" |
person_id | string | 否 | 合同签约人ID,详细信息可通过【查询单个个人信息】接口查询获得 示例值:"151515151" |
custom_fields | object_field_data\[\] | 否 | 自定义字段,预留字段,暂时不支持 |
└ field_name | string | 是 | 字段名 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") 示例值:"Sandy" |
duration_type | enum | 否 | 期限类型,枚举值可通过文档【飞书人事枚举常量】合同期限类型(duration_type)枚举定义部分获得 示例值:fixed_term |
└ enum_name | string | 是 | 枚举值 示例值:"fixed_term" |
contract_end_date | string | 否 | 合同结束日期,格式:"YYYY-MM-DD" 示例值:"2006-01-02" |
contract_number | string | 否 | 合同编号 示例值:"6919737965274990093" |
signing_type | enum | 否 | 签订类型,枚举值可通过文档【飞书人事枚举常量】签订类型(signing_type)枚举定义部分获得 |
└ enum_name | string | 是 | 枚举值 示例值:"renewed" |
请求体示例
json
{
"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"
},
"first_party_company_id": "6892686614112241165",
"person_id": "151515151",
"custom_fields": [
{
"field_name": "name",
"value": "Sandy"
}
],
"duration_type": {
"enum_name": "fixed_term"
},
"contract_end_date": "2006-01-02",
"contract_number": "6919737965274990093",
"signing_type": {
"enum_name": "renewed"
}
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ contract | contract | 创建成功的合同信息 |
└ id | string | 合同ID |
└ effective_time | string | 合同开始日期 |
└ expiration_time | string | 实际结束日期 |
└ employment_id | string | 雇佣 ID,详细信息可通过【搜索员工信息】接口查询获得 |
└ contract_type | enum | 合同类型,枚举值可通过文档【飞书人事枚举常量】合同类型(contract_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ first_party_company_id | string | 合同签订的公司主体, 引用Company的ID,详细信息可通过【查询单个公司】接口查询获得 |
└ person_id | string | Person ID,详细信息可通过【查询单个个人信息】接口查询获得 |
└ custom_fields | object_field_data\[\] | 自定义字段 |
└ field_name | string | 字段名 |
└ value | string | 字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") |
└ duration_type | enum | 期限类型,枚举值可通过文档【飞书人事枚举常量】合同期限类型(duration_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ contract_end_date | string | 合同结束日期 |
└ contract_number | string | 合同编号 |
└ signing_type | enum | 签订类型,枚举值可通过文档【飞书人事枚举常量】签订类型(signing_type)枚举定义部分获得 |
└ enum_name | string | 枚举值 |
└ display | i18n\[\] | 枚举多语展示 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
响应体示例
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": "变更"
}
]
}
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1160545 | effective time has been occupied | 该生效时间内已经存在一份合同,请确认合同生效时间段 |
| 400 | 1160546 | Conflicting contracts existed | 该合同已存在,请勿重复创建 |
