schm-hr-eapi

schm-hr-eapi

应用描述: HR（薪资，考勤，员工信息）
测试环境地址: https://schm-api-test.shiseido.cn/schm-hr-eapi
生产环境地址: https://schm-api.shiseido.cn/schm-hr-eapi

该应用程序具有以下功能：

1. 开放接口接收Gaiaworks推送的考勤数据。
2. 提供接口用以来获取工资单数据。
3. 定期向FSG推送考勤数据。
4. 从FSG接口中提取薪资数据。
5. 代理SuccessFactors的数据，开放接口提供人员及组织机构信息的查询。
6. 查询onboarding员工数据。

目录

• 1 权限认证
• 2 接口列表
• 3 接口描述
  • 3.1 查询薪资数据
  • 3.2 推送考勤数据
  • 3.3 查询考勤数据
  • 3.4 手动同步数据
  • 3.5 获取员工信息
  • 3.6 地区信息查询
  • 3.7 部门信息查询
  • 3.8 公司信息查询
  • 3.9 Onboarding数据查询

薪资数据来自Fsg，考勤数据来自Gaia，人员及组织数据来自SuccessFactors。

1.权限认证

所有请求标头都必须包含以下键值参数作为身份验证信息。您需要向管理员申请此信息。

client_id: fa98****3452
client_secret: 108b****41f2

2.接口列表:

3.接口描述

3.1 查询薪资数据

接口请求地址: /api/v1/salary
接口描述: 通过接口查询薪资数据。
接口调用方式: Http GET

接口调用参数说明:

请求参数示例

https://schm-api-test.shiseido.cn/schm-hr-eapi/api/v1/salary?salary_month=202309&pageSize=100&pageNo=0

返回结构示例

[
    {
        "SFcode": "100003",
        "name": "chuan c lin",
        "company": "SCH",
        "deptment": "ShouFaShi",
        "salary_month": "202309",
        "item": [
            {
                "code": "A101",
                "name_cn": "基本薪资",
                "name_en": "Base pay",
                "amount": 2000
            },
            {
                "code": "A103",
                "name_cn": "车贴标准",
                "name_en": "Car sticker standard",
                "amount": 500.22
            },
            {
                "code": "A102",
                "name_cn": "基本薪资调整",
                "name_en": "Base pay adjustment",
                "amount": 2000
            }
        ]
    }
]

3.2 推送考勤数据

接口请求地址: /api/v1/attendance
接口描述: 向Mulesoft推送考勤数据。
接口调用方式: Http POST

接口调用参数说明:

请求体结构示例

[
    {
        "end_date": "2023-11-30",
        "apply_unit": "小时",
        "category_name": "休假",
        "create_time": "2023-12-22 18:15:58.000",
        "category_code": "LV",
        "begin_date": "2023-11-01",
        "SFcode": "100300000",
        "pay_month": "202312",
        "attendance_name": "病假(SCH)",
        "attendance_nums": 176.0,
        "name": "马化腾",
        "company": "SCH",
        "deptment": "DPTtx001",
        "attendance_type": "B01"
    },
    {
        "end_date": "2023-11-30",
        "apply_unit": "小时",
        "category_name": "工时",
        "create_time": "2023-12-22 18:15:58.000",
        "category_code": "WH",
        "begin_date": "2023-11-01",
        "SFcode": "30000008",
        "pay_month": "202312",
        "attendance_name": "排班工时",
        "attendance_nums": 176.0,
        "name": "余承东",
        "company": "SCH",
        "deptment": "DPTWH001",
        "attendance_type": "I02"
    }
]

返回结构示例

成功返回:

{
    "success": true,
    "message": "reveived 131 data."
}

失败返回:

{
    "success": false,
    "error": "error message"
}

3.3 查询考勤数据

接口请求地址: /api/v1/attendance
接口描述: 通过接口查询考勤数据。
接口调用方式: GET

请求参数说明:

请求参数示例

https://schm-api-dev.shiseido.cn/schm-hr-eapi/api/v1/attendance?pay_month=202309

返回结构示例

[
    {
        "SFcode": "100001",
        "name": "chuan c lin",
        "company": "SCH",
        "deptment": "ShouFaShi",
        "pay_month": "202309",
        "begin_date": "2023-08-01T00:00:00",
        "end_date": "2023-08-31T00:00:00",
        "category_code": "WH",
        "category_name": "工时",
        "attendance_type": "x1",
        "attendance_name": "当月工作天数",
        "attendance_nums": 23,
        "apply_unit": "d"
    },
    {
        "SFcode": "100001",
        "name": "chuan c lin",
        "company": "SCH",
        "deptment": "ShouFaShi",
        "pay_month": "202309",
        "begin_date": "2023-08-01T00:00:00",
        "end_date": "2023-08-31T00:00:00",
        "category_code": "WH",
        "category_name": "工时",
        "attendance_type": "x2",
        "attendance_name": "加班天数",
        "attendance_nums": 23,
        "apply_unit": "d"
    }
]

3.4 手动同步数据

接口请求地址: /api/v1/salary/sync
接口描述: 手动同步数据。该接口暂时只能由管理员进行数据校正。
接口调用方式: Http POST

请求参数说明:

请求体结构示例

{
    "startTime": "2024-02-01",
    "endTime": "2024-03-01"
}

返回结构示例

成功返回:

{
    "success": true,
    "message": "reveived 131 data."
}

失败返回:

{
    "success": false,
    "error": "error message"
}

3.5 获取员工信息

接口请求地址: /api/v1/sf/employee
接口描述: 查询由SuccessFactors获取的员工数据。
接口调用方式: GET

请求参数说明:

请求体结构示例

https://schm-api.shiseido.cn/schm-hr-eapi/api/v1/sf/employee?pageSize=10&pageNo=0

返回结构说明

返回结构示例

[
  {
    "person_id": "02000997",
    "last_modified_date_time": "2024-03-15T03:27:03",
    "perperson_last_modified_date_time": "2021-05-04T16:15:26",
    "date_of_birth": "1981-12-06T00:00:00",
    "preferred_last_name": "Ng",
    "formal_full_name": "Wing Sze Ng",
    "first_name": "Wing Sze",
    "gender": "F",
    "gender_value": "女",
    "last_name": "Ng",
    "marital_status_id": "1892",
    "marital_status": "M",
    "marital_status_value": "已婚",
    "nationality": "CHN",
    "preferred_first_name": "Sharon",
    "last_name_alt1": "吳",
    "first_name_alt1": "穎詩",
    "last_name_alt2": "Wu",
    "first_name_alt2": "Yingshi",
    "last_name_cn": "吳",
    "first_name_cn": "穎詩",
    "formalName": "Sharon Ng",
    "perpersonal_last_modified_date_time": "2021-05-21T04:16:16",
    "national_id": "Z3206166",
    "national_id_card_type": "HKID",
    "national_id_region": "HKG",
    "national_id_is_primary": 1,
    "national_id_expiration_date": null,
    "national_id_issue_date": null,
    "national_id_issuing_authority": null,
    "Effective_start_date": null,
    "account_number": "xxxxxx",
    "account_owner": "Ng Wing Sze",
    "bank": "HK_004",
    "province_of_hukou_id": null,
    "province_of_hukou": null,
    "province_of_hukou_value": null,
    "city_of_hukou_id": null,
    "city_of_hukou": null,
    "city_of_hukou_value": null,
    "place_of_hukou": null,
    "level_of_challenge": null,
    "hukou_type_id": null,
    "hukou_type": null,
    "hukou_type_value": null,
    "type_of_challenge_id": null,
    "type_of_challenge": null,
    "type_of_challenge_value": null,
    "reference_number": null,
    "ethnic_group": null,
    "number_of_children": null,
    "political_status": null,
    "date_of_marriage": null,
    "userId": "02000997",
    "probation_period_end_date": "2005-09-12T00:00:00",
    "social_insurance_payment_date": null,
    "original_start_date": "2005-06-13T00:00:00",
    "service_date": "2005-06-13T00:00:00",
    "seniority_start_date": "2005-06-13T00:00:00",
    "probation_start_date": "2005-06-13T00:00:00",
    "legacy_hris_id": "997",
    "probation_period_number": 3.0,
    "probation_period_frequency": "6016",
    "probation_status": null,
    "entry_into_group": null,
    "job_level_id": "290242",
    "job_level": "JS",
    "job_level_value": "初级专员",
    "startdate": "2024-02-05T00:00:00",
    "company": "C0300",
    "division": "60020301",
    "department": "60021363",
    "contract_start_date": null,
    "contract_end_date": null,
    "contract_type_id": "290236",
    "contract_type": "HKG-Z1",
    "contract_type_value": "Permanent",
    "cost_center": "DH1AFZZZZZ",
    "health_certificate_effective_date": null,
    "health_certificate_expiration_Date": null,
    "health_certificate": null,
    "attendance_type_id": null,
    "attendance_type": null,
    "attendance_type_value": null,
    "job_family_id": null,
    "job_family": "60000008",
    "job_family_value": null,
    "brand": null,
    "employee_class_id": "1256",
    "employee_class": "P",
    "employee_class_value": "正式员工(无固定期限)",
    "event_reason": "DATASUPRV",
    "job_classification": "NONE",
    "location": null,
    "subsidy_criteria_id": null,
    "subsidy_criteria": null,
    "subsidy_criteria_value": null,
    "position": "60024101",
    "position_entry_date": null,
    "manager": "30020386",
    "event": "1933",
    "job_function": "60000057",
    "grade_shk": "HKG_SHK_S2",
    "employee_type": "7749",
    "local_job_title": "Assistant Accounting Officer, Finance",
    "public_job_title_eng": "Assistant Accounting Officer, Finance",
    "mode_of_employment_id": null,
    "mode_of_employment": null,
    "mode_of_employment_value": null,
    "branch_office": null,
    "positionNav_externalName_defaultValue": null,
    "employment_status_id": "1910",
    "employment_status_code": "A",
    "employment_status_value": "在职",
    "empjob_last_modified_date_time": "2024-03-06T03:14:42",
    "compensation_startDate": "2024-01-01T00:00:00",
    "pay_group": "HKG_SHK_H2",
    "pay_component": "60000114",
    "currency": "HKD",
    "frequency": "60000010",
    "amount": xxxxx,
    "recurring_startDate": "2024-01-01T00:00:00",
    "termination_Date": null,
    "last_date_worked": null,
    "termination_sub_reason": null,
    "empemploymenttermination_last_modified_date_time": null,
    "email": [
      {
        "email_type": "B",
        "email_type_value": "公司",
        "email_address": "xxxxx",
        "personIdExternal": "02000997",
        "is_primary": 1,
        "last_modified_date_time": "2021-05-04T19:23:16"
      }
    ],
    "phone": [
      {
        "phone_type": "H",
        "phone_type_value": "家庭",
        "extension": null,
        "phone_number": "xxxxx",
        "country_code": "5290",
        "region_code": "97",
        "personIdExternal": "02000997",
        "last_modified_date_time": "2021-05-04T19:23:01"
      },
      {
        "phone_type": "P",
        "phone_type_value": "个人手机",
        "extension": null,
        "phone_number": "xxxxxxx",
        "country_code": "5290",
        "region_code": "97",
        "personIdExternal": "02000997",
        "last_modified_date_time": "2021-05-04T19:23:01"
      }
    ],
    "address": [
      {
        "address_type": null,
        "address_type_value": null,
        "detailed": "xxxxx",
        "street": "xxxxx",
        "district": null,
        "country": "HKG",
        "province": "xxxx",
        "city": "290173",
        "personIdExternal": "02000997",
        "last_modified_date_time": "2021-05-04T19:23:26"
      }
    ],
    "contacts": []
  }
]

所有以 _value 结尾的字段都是与PickListValueV2字典匹配出的值，默认取label_zh_CN，如果为空的话取label_defaultValue。

以下是员工在职状态字典对应关系

3.6 地区信息查询

接口请求地址: /api/v1/sf/division
接口描述: Querying area information.
接口调用方式: GET

请求参数说明:

请求体结构示例

https://schm-api-test.shiseido.cn/schm-hr-eapi/api/v1/sf/division?pageSize=10&pageNo=0

cust_LegalEntity 字段返回其上级公司，如果有多个，那么会以逗号（,）分割开。

返回结构示例

[
    {
        "headOfUnit": null,
        "name_en_US": "General Manager",
        "lastModifiedDateTime": "2021-05-04T08:03:47Z",
        "externalCode": "60020501",
        "cust_ParentDivision": null,
        "name": "General Manager",
        "createdDateTime": "2021-05-04T08:03:47Z",
        "startDate": "1998-02-11T00:00:00Z",
        "name_zh_CN": "总经理",
        "status": "A",
        "cust_LegalEntity": "C0101"
    },
    {
        "headOfUnit": null,
        "name_en_US": "Administration Division",
        "lastModifiedDateTime": "2021-05-04T08:03:47Z",
        "externalCode": "60020502",
        "cust_ParentDivision": null,
        "name": "Administration Division",
        "createdDateTime": "2021-05-04T08:03:47Z",
        "startDate": "1998-02-11T00:00:00Z",
        "name_zh_CN": "管理本部",
        "status": "A",
        "cust_LegalEntity": "C0101"
    },
    {
        "headOfUnit": null,
        "name_en_US": "Production Division",
        "lastModifiedDateTime": "2021-05-04T08:03:47Z",
        "externalCode": "60020503",
        "cust_ParentDivision": null,
        "name": "Production Division",
        "createdDateTime": "2021-05-04T08:03:47Z",
        "startDate": "1998-02-11T00:00:00Z",
        "name_zh_CN": "生产本部",
        "status": "A",
        "cust_LegalEntity": "C0101"
    },
    {
        "headOfUnit": null,
        "name_en_US": "Factory Managing Director",
        "lastModifiedDateTime": "2021-05-04T08:03:47Z",
        "externalCode": "60020504",
        "cust_ParentDivision": null,
        "name": "Factory Managing Director",
        "createdDateTime": "2021-05-04T08:03:47Z",
        "startDate": "1998-02-11T00:00:00Z",
        "name_zh_CN": "工场长",
        "status": "A",
        "cust_LegalEntity": "C0101"
    },
    {
        "headOfUnit": null,
        "name_en_US": "Shiseido China Innovation Center",
        "lastModifiedDateTime": "2021-05-04T02:44:41Z",
        "externalCode": "60020001",
        "cust_ParentDivision": null,
        "name": "Shiseido China Innovation Center",
        "createdDateTime": "2021-05-04T02:44:41Z",
        "startDate": "2001-12-18T00:00:00Z",
        "name_zh_CN": "资生堂中国研发中心",
        "status": "A",
        "cust_LegalEntity": "C0101"
    },
    {
        "headOfUnit": null,
        "name_en_US": "Digital Transformation Office",
        "lastModifiedDateTime": "2021-05-05T10:26:46Z",
        "externalCode": "60020117",
        "cust_ParentDivision": null,
        "name": "Digital Transformation Office",
        "createdDateTime": "2021-05-05T10:26:46Z",
        "startDate": "2003-12-24T00:00:00Z",
        "name_zh_CN": "Digital Transformation Office",
        "status": "A",
        "cust_LegalEntity": "C0101"
    },
    {
        "headOfUnit": null,
        "name_en_US": "Beauty Device Department",
        "lastModifiedDateTime": "2021-05-05T10:26:46Z",
        "externalCode": "60020121",
        "cust_ParentDivision": null,
        "name": "Beauty Device Department",
        "createdDateTime": "2021-05-05T10:26:46Z",
        "startDate": "2003-12-24T00:00:00Z",
        "name_zh_CN": "Beauty Device Department",
        "status": "A",
        "cust_LegalEntity": "C0101"
    },
    {
        "headOfUnit": null,
        "name_en_US": "Brand Shiseido Department",
        "lastModifiedDateTime": "2021-05-05T10:26:46Z",
        "externalCode": "60020122",
        "cust_ParentDivision": null,
        "name": "Brand Shiseido Department",
        "createdDateTime": "2021-05-05T10:26:46Z",
        "startDate": "2003-12-24T00:00:00Z",
        "name_zh_CN": "Brand Shiseido Department",
        "status": "A",
        "cust_LegalEntity": "C0101"
    },
    {
        "headOfUnit": null,
        "name_en_US": "Emerging Brands Department",
        "lastModifiedDateTime": "2021-05-05T10:26:46Z",
        "externalCode": "60020123",
        "cust_ParentDivision": null,
        "name": "Emerging Brands Department",
        "createdDateTime": "2021-05-05T10:26:46Z",
        "startDate": "2003-12-24T00:00:00Z",
        "name_zh_CN": "Emerging Brands Department",
        "status": "A",
        "cust_LegalEntity": "C0101"
    },
    {
        "headOfUnit": null,
        "name_en_US": "Business Development Department",
        "lastModifiedDateTime": "2021-05-05T10:26:46Z",
        "externalCode": "60020128",
        "cust_ParentDivision": null,
        "name": "Business Development Department",
        "createdDateTime": "2021-05-05T10:26:46Z",
        "startDate": "2003-12-24T00:00:00Z",
        "name_zh_CN": "Business Development Department",
        "status": "A",
        "cust_LegalEntity": "C0101"
    }
]

3.7 部门信息查询

接口请求地址: /api/v1/sf/department
接口描述: Query departmental information from successfactors.
接口调用方式: GET

请求参数说明:

请求体结构示例

https://schm-api-test.shiseido.cn/schm-hr-eapi/api/v1/sf/department?pageSize=10&pageNo=0

cust_LegalEntity 字段返回其上级公司，如果有多个，那么会以逗号（,）分割开。
cust_Division 字段返回其上级部门，如果有多个，那么会以逗号（,）分割开。

返回结构示例

[
    {
        "cust_orgOfficialNameEN": null,
        "parent": "60020001",
        "description_ko_KR": null,
        "lastModifiedDateTime": "2021-10-21T06:53:16",
        "name_localized": "President & C.O.O.",
        "externalCode": "60020001",
        "description_th_TH": null,
        "endDate": "9999-12-31T00:00:00",
        "entityUUID": "2EEF463BA5F64B84A31DFDF25CF7BDEB",
        "name_ko_KR": null,
        "createdDateTime": "2021-05-04T03:14:59",
        "name_th_TH": null,
        "description_pt_BR": null,
        "cust_orgIdForInterface": null,
        "description_es_ES": null,
        "name_pt_BR": null,
        "description_nl_NL": null,
        "cust_deptLevel": null,
        "name_nl_NL": null,
        "costCenter": "NONE",
        "description_defaultValue": "301",
        "cust_orgOfficialNameJA": null,
        "cust_orgNameForInterfaceEN2": null,
        "name_de_DE": null,
        "cust_orgNameForInterfaceEN3": null,
        "name_zh_TW": null,
        "cust_orgNameForInterfaceEN1": null,
        "name": "President & C.O.O.",
        "name_es_ES": null,
        "description_en_US": "301",
        "cust_orgNameForInterfaceEN4": null,
        "cust_orgNameForInterfaceEN5": null,
        "description_en_DEBUG": null,
        "startDate": "2001-12-18T00:00:00",
        "description_it_IT": null,
        "description_ru_RU": null,
        "status": "A",
        "name_ru_RU": null,
        "description_ja_JP": null,
        "description_fr_FR": null,
        "name_it_IT": null,
        "description": "301",
        "description_de_DE": null,
        "name_fr_FR": null,
        "name_en_DEBUG": null,
        "name_ja_JP": null,
        "createdOn": "2021-05-04T05:14:59",
        "cust_organizationalRegion": null,
        "headOfUnit": null,
        "name_en_US": "President & C.O.O.",
        "description_zh_TW": null,
        "name_zh_CN": "总经理",
        "name_defaultValue": "President & C.O.O.",
        "cust_orgNameForInterfaceJA1": null,
        "description_bs_ID": null,
        "description_en_GB": null,
        "lastModifiedBy": "10032859",
        "cust_orgNameForInterfaceJA4": null,
        "cust_orgNameForInterfaceJA5": null,
        "cust_orgNameForInterfaceJA2": null,
        "cust_orgNameForInterfaceJA3": null,
        "name_en_GB": null,
        "name_vi_VN": null,
        "lastModifiedOn": "2021-10-21T08:53:16",
        "description_vi_VN": null,
        "description_zh_CN": null,
        "createdBy": "CN_DM_USER",
        "mdfSystemRecordId": "32E7EBCA47314794ABF48A9CC396563E",
        "description_localized": "301",
        "name_bs_ID": null,
        "cust_DivisionProp": "60020001",
        "cust_LegalEntityProp": "H0700"
    },
    {
        "cust_orgOfficialNameEN": null,
        "parent": "60020001",
        "description_ko_KR": null,
        "lastModifiedDateTime": "2021-10-21T06:53:33",
        "name_localized": "Vice President",
        "externalCode": "60020002",
        "description_th_TH": null,
        "endDate": "9999-12-31T00:00:00",
        "entityUUID": "08C8EF889A924C9F9B549B095835203C",
        "name_ko_KR": null,
        "createdDateTime": "2021-05-04T03:14:59",
        "name_th_TH": null,
        "description_pt_BR": null,
        "cust_orgIdForInterface": null,
        "description_es_ES": null,
        "name_pt_BR": null,
        "description_nl_NL": null,
        "cust_deptLevel": null,
        "name_nl_NL": null,
        "costCenter": "NONE",
        "description_defaultValue": "302",
        "cust_orgOfficialNameJA": null,
        "cust_orgNameForInterfaceEN2": null,
        "name_de_DE": null,
        "cust_orgNameForInterfaceEN3": null,
        "name_zh_TW": null,
        "cust_orgNameForInterfaceEN1": null,
        "name": "Vice President",
        "name_es_ES": null,
        "description_en_US": "302",
        "cust_orgNameForInterfaceEN4": null,
        "cust_orgNameForInterfaceEN5": null,
        "description_en_DEBUG": null,
        "startDate": "2001-12-18T00:00:00",
        "description_it_IT": null,
        "description_ru_RU": null,
        "status": "A",
        "name_ru_RU": null,
        "description_ja_JP": null,
        "description_fr_FR": null,
        "name_it_IT": null,
        "description": "302",
        "description_de_DE": null,
        "name_fr_FR": null,
        "name_en_DEBUG": null,
        "name_ja_JP": null,
        "createdOn": "2021-05-04T05:14:59",
        "cust_organizationalRegion": null,
        "headOfUnit": null,
        "name_en_US": "Vice President",
        "description_zh_TW": null,
        "name_zh_CN": "副总经理(北京)",
        "name_defaultValue": "Vice President",
        "cust_orgNameForInterfaceJA1": null,
        "description_bs_ID": null,
        "description_en_GB": null,
        "lastModifiedBy": "10032859",
        "cust_orgNameForInterfaceJA4": null,
        "cust_orgNameForInterfaceJA5": null,
        "cust_orgNameForInterfaceJA2": null,
        "cust_orgNameForInterfaceJA3": null,
        "name_en_GB": null,
        "name_vi_VN": null,
        "lastModifiedOn": "2021-10-21T08:53:33",
        "description_vi_VN": null,
        "description_zh_CN": null,
        "createdBy": "CN_DM_USER",
        "mdfSystemRecordId": "EE204D1BE90F4CAABFF28C6F4C4FA398",
        "description_localized": "302",
        "name_bs_ID": null,
        "cust_DivisionProp": "60020001",
        "cust_LegalEntityProp": "H0700"
    },
    {
        "cust_orgOfficialNameEN": null,
        "parent": "60020001",
        "description_ko_KR": null,
        "lastModifiedDateTime": "2021-10-21T06:53:49",
        "name_localized": "Administration Department",
        "externalCode": "60020003",
        "description_th_TH": null,
        "endDate": "9999-12-31T00:00:00",
        "entityUUID": "A90A18EEC0C3407FA16331537557457F",
        "name_ko_KR": null,
        "createdDateTime": "2021-05-04T03:14:59",
        "name_th_TH": null,
        "description_pt_BR": null,
        "cust_orgIdForInterface": null,
        "description_es_ES": null,
        "name_pt_BR": null,
        "description_nl_NL": null,
        "cust_deptLevel": null,
        "name_nl_NL": null,
        "costCenter": "NONE",
        "description_defaultValue": "304",
        "cust_orgOfficialNameJA": null,
        "cust_orgNameForInterfaceEN2": null,
        "name_de_DE": null,
        "cust_orgNameForInterfaceEN3": null,
        "name_zh_TW": null,
        "cust_orgNameForInterfaceEN1": null,
        "name": "Administration Department",
        "name_es_ES": null,
        "description_en_US": "304",
        "cust_orgNameForInterfaceEN4": null,
        "cust_orgNameForInterfaceEN5": null,
        "description_en_DEBUG": null,
        "startDate": "2001-12-18T00:00:00",
        "description_it_IT": null,
        "description_ru_RU": null,
        "status": "A",
        "name_ru_RU": null,
        "description_ja_JP": null,
        "description_fr_FR": null,
        "name_it_IT": null,
        "description": "304",
        "description_de_DE": null,
        "name_fr_FR": null,
        "name_en_DEBUG": null,
        "name_ja_JP": null,
        "createdOn": "2021-05-04T05:14:59",
        "cust_organizationalRegion": null,
        "headOfUnit": null,
        "name_en_US": "Administration Department",
        "description_zh_TW": null,
        "name_zh_CN": "经营管理部",
        "name_defaultValue": "Administration Department",
        "cust_orgNameForInterfaceJA1": null,
        "description_bs_ID": null,
        "description_en_GB": null,
        "lastModifiedBy": "10032859",
        "cust_orgNameForInterfaceJA4": null,
        "cust_orgNameForInterfaceJA5": null,
        "cust_orgNameForInterfaceJA2": null,
        "cust_orgNameForInterfaceJA3": null,
        "name_en_GB": null,
        "name_vi_VN": null,
        "lastModifiedOn": "2021-10-21T08:53:49",
        "description_vi_VN": null,
        "description_zh_CN": null,
        "createdBy": "CN_DM_USER",
        "mdfSystemRecordId": "07B1FC06D59D4C81BBD130C3190027EB",
        "description_localized": "304",
        "name_bs_ID": null,
        "cust_DivisionProp": "60020001",
        "cust_LegalEntityProp": "H0700"
    },
    {
        "cust_orgOfficialNameEN": null,
        "parent": "60020001",
        "description_ko_KR": null,
        "lastModifiedDateTime": "2021-10-21T06:54:03",
        "name_localized": "Product Development Department(Beijing)",
        "externalCode": "60020004",
        "description_th_TH": null,
        "endDate": "9999-12-31T00:00:00",
        "entityUUID": "008B26EBC56A4E279FC9D0E5E47A3980",
        "name_ko_KR": null,
        "createdDateTime": "2021-05-04T03:14:59",
        "name_th_TH": null,
        "description_pt_BR": null,
        "cust_orgIdForInterface": null,
        "description_es_ES": null,
        "name_pt_BR": null,
        "description_nl_NL": null,
        "cust_deptLevel": null,
        "name_nl_NL": null,
        "costCenter": "NONE",
        "description_defaultValue": "305",
        "cust_orgOfficialNameJA": null,
        "cust_orgNameForInterfaceEN2": null,
        "name_de_DE": null,
        "cust_orgNameForInterfaceEN3": null,
        "name_zh_TW": null,
        "cust_orgNameForInterfaceEN1": null,
        "name": "Product Development Department(Beijing)",
        "name_es_ES": null,
        "description_en_US": "305",
        "cust_orgNameForInterfaceEN4": null,
        "cust_orgNameForInterfaceEN5": null,
        "description_en_DEBUG": null,
        "startDate": "2001-12-18T00:00:00",
        "description_it_IT": null,
        "description_ru_RU": null,
        "status": "A",
        "name_ru_RU": null,
        "description_ja_JP": null,
        "description_fr_FR": null,
        "name_it_IT": null,
        "description": "305",
        "description_de_DE": null,
        "name_fr_FR": null,
        "name_en_DEBUG": null,
        "name_ja_JP": null,
        "createdOn": "2021-05-04T05:14:59",
        "cust_organizationalRegion": null,
        "headOfUnit": null,
        "name_en_US": "Product Development Department(Beijing)",
        "description_zh_TW": null,
        "name_zh_CN": "制品开发部(北京)",
        "name_defaultValue": "Product Development Department(Beijing)",
        "cust_orgNameForInterfaceJA1": null,
        "description_bs_ID": null,
        "description_en_GB": null,
        "lastModifiedBy": "10032859",
        "cust_orgNameForInterfaceJA4": null,
        "cust_orgNameForInterfaceJA5": null,
        "cust_orgNameForInterfaceJA2": null,
        "cust_orgNameForInterfaceJA3": null,
        "name_en_GB": null,
        "name_vi_VN": null,
        "lastModifiedOn": "2021-10-21T08:54:03",
        "description_vi_VN": null,
        "description_zh_CN": null,
        "createdBy": "CN_DM_USER",
        "mdfSystemRecordId": "7F1789A90556436EA077E915400AD0EC",
        "description_localized": "305",
        "name_bs_ID": null,
        "cust_DivisionProp": "60020001",
        "cust_LegalEntityProp": "H0700"
    },
    {
        "cust_orgOfficialNameEN": null,
        "parent": "60020001",
        "description_ko_KR": null,
        "lastModifiedDateTime": "2021-12-24T06:10:53",
        "name_localized": "Quality Assessment Department",
        "externalCode": "60020005",
        "description_th_TH": null,
        "endDate": "9999-12-31T00:00:00",
        "entityUUID": "124DAF15B17A42D3B9345CBD8F4E7CCB",
        "name_ko_KR": null,
        "createdDateTime": "2021-12-24T06:10:53",
        "name_th_TH": null,
        "description_pt_BR": null,
        "cust_orgIdForInterface": null,
        "description_es_ES": null,
        "name_pt_BR": null,
        "description_nl_NL": null,
        "cust_deptLevel": null,
        "name_nl_NL": null,
        "costCenter": "NONE",
        "description_defaultValue": "306",
        "cust_orgOfficialNameJA": null,
        "cust_orgNameForInterfaceEN2": null,
        "name_de_DE": null,
        "cust_orgNameForInterfaceEN3": null,
        "name_zh_TW": null,
        "cust_orgNameForInterfaceEN1": null,
        "name": "Quality Assessment Department",
        "name_es_ES": null,
        "description_en_US": "306",
        "cust_orgNameForInterfaceEN4": null,
        "cust_orgNameForInterfaceEN5": null,
        "description_en_DEBUG": null,
        "startDate": "2022-01-01T00:00:00",
        "description_it_IT": null,
        "description_ru_RU": null,
        "status": "A",
        "name_ru_RU": null,
        "description_ja_JP": null,
        "description_fr_FR": null,
        "name_it_IT": null,
        "description": "306",
        "description_de_DE": null,
        "name_fr_FR": null,
        "name_en_DEBUG": null,
        "name_ja_JP": null,
        "createdOn": "2021-12-24T07:10:53",
        "cust_organizationalRegion": null,
        "headOfUnit": null,
        "name_en_US": "Quality Assessment Department",
        "description_zh_TW": null,
        "name_zh_CN": "品质评价部",
        "name_defaultValue": "Quality Assessment Department",
        "cust_orgNameForInterfaceJA1": null,
        "description_bs_ID": null,
        "description_en_GB": null,
        "lastModifiedBy": "10032859",
        "cust_orgNameForInterfaceJA4": null,
        "cust_orgNameForInterfaceJA5": null,
        "cust_orgNameForInterfaceJA2": null,
        "cust_orgNameForInterfaceJA3": null,
        "name_en_GB": null,
        "name_vi_VN": null,
        "lastModifiedOn": "2021-12-24T07:10:53",
        "description_vi_VN": null,
        "description_zh_CN": null,
        "createdBy": "10032859",
        "mdfSystemRecordId": "956633FB46C14C6086BBC6533D3C08FC",
        "description_localized": "306",
        "name_bs_ID": null,
        "cust_DivisionProp": "60020001",
        "cust_LegalEntityProp": "H0700"
    }
]

3.8 公司信息查询

接口请求地址: /api/v1/sf/company
接口描述: Query company information from successfactors.
接口调用方式: GET

请求参数说明:

请求体结构示例

https://schm-api-test.shiseido.cn/schm-hr-eapi/api/v1/sf/company?pageSize=10&pageNo=0

返回结构示例

[
    {
        "name_en_US": "Shiseido China Co., Ltd.",
        "lastModifiedDateTime": "2023-12-22T05:31:26Z",
        "externalCode": "C0100",
        "createdDateTime": "2023-11-09T05:53:15Z",
        "startDate": "2023-10-01T00:00:00Z",
        "name_zh_CN": "资生堂(中国)投资有限公司",
        "status": "A"
    },
    {
        "name_en_US": "Shiseido Liyuan Cosmetics Co., Ltd.",
        "lastModifiedDateTime": "2023-12-22T05:31:26Z",
        "externalCode": "C0200",
        "createdDateTime": "2023-11-09T05:53:15Z",
        "startDate": "2023-10-01T00:00:00Z",
        "name_zh_CN": "资生堂丽源化妆品有限公司",
        "status": "A"
    },
    {
        "name_en_US": "Shiseido Hong Kong Limited",
        "lastModifiedDateTime": "2023-12-22T05:31:26Z",
        "externalCode": "C0300",
        "createdDateTime": "2023-11-09T05:53:15Z",
        "startDate": "2023-10-01T00:00:00Z",
        "name_zh_CN": "資生堂香港有限公司",
        "status": "A"
    },
    {
        "name_en_US": "Shiseido Guangdong Cosmetics., Ltd.",
        "lastModifiedDateTime": "2023-12-22T05:31:26Z",
        "externalCode": "C0500",
        "createdDateTime": "2023-11-09T05:53:15Z",
        "startDate": "2023-10-01T00:00:00Z",
        "name_zh_CN": "资生堂广东化妆品有限公司",
        "status": "A"
    },
    {
        "name_en_US": "Shiseido Ziyue (Shanghai) Management Consulting Co., Ltd.",
        "lastModifiedDateTime": "2023-12-22T05:31:26Z",
        "externalCode": "C0600",
        "createdDateTime": "2023-11-09T05:53:15Z",
        "startDate": "2023-10-01T00:00:00Z",
        "name_zh_CN": "資生堂資悦(上海)管理咨詢有限公司",
        "status": "A"
    },
    {
        "name_en_US": "Shiseido Cosmetics Manufacturing Co., LTD.",
        "lastModifiedDateTime": "2023-12-22T05:31:26Z",
        "externalCode": "H0600",
        "createdDateTime": "2023-11-09T05:53:15Z",
        "startDate": "2023-10-01T00:00:00Z",
        "name_zh_CN": "资生堂化妆品制造有限公司",
        "status": "A"
    }
]

3.9 Onboarding数据查询

接口请求地址: /api/v1/sf/onboarding
接口描述: 查询onboarding员工数据。目前数据来源是onboarding的SFTP服务器文件。
接口调用方式: GET

此接口几乎与3.5 employee接口结构相同，只是数据内容来自于onboarding数据。
onboarding数据没有birth_date属性，会一致返回null。

请求参数说明:

请求体结构示例

https://schm-api.shiseido.cn/schm-hr-eapi/api/v1/sf/onboarding?pageSize=10&pageNo=0

返回结构说明

返回结构示例

[
  {
    "person_id": "02000997",
    "last_modified_date_time": "2024-03-15T03:27:03",
    "perperson_last_modified_date_time": "2021-05-04T16:15:26",
    "date_of_birth": null,
    "preferred_last_name": "Ng",
    "formal_full_name": "Wing Sze Ng",
    "first_name": "Wing Sze",
    "gender": "F",
    "gender_value": "女",
    "last_name": "Ng",
    "marital_status_id": "1892",
    "marital_status": "M",
    "marital_status_value": "已婚",
    "nationality": "CHN",
    "preferred_first_name": "Sharon",
    "last_name_alt1": "吳",
    "first_name_alt1": "穎詩",
    "last_name_alt2": "Wu",
    "first_name_alt2": "Yingshi",
    "last_name_cn": "吳",
    "first_name_cn": "穎詩",
    "formalName": "Sharon Ng",
    "perpersonal_last_modified_date_time": "2021-05-21T04:16:16",
    "national_id": "Z3206166",
    "national_id_card_type": "HKID",
    "national_id_region": "HKG",
    "national_id_is_primary": 1,
    "national_id_expiration_date": null,
    "national_id_issue_date": null,
    "national_id_issuing_authority": null,
    "Effective_start_date": null,
    "account_number": "xxxxxx",
    "account_owner": "Ng Wing Sze",
    "bank": "HK_004",
    "province_of_hukou_id": null,
    "province_of_hukou": null,
    "province_of_hukou_value": null,
    "city_of_hukou_id": null,
    "city_of_hukou": null,
    "city_of_hukou_value": null,
    "place_of_hukou": null,
    "level_of_challenge": null,
    "hukou_type_id": null,
    "hukou_type": null,
    "hukou_type_value": null,
    "type_of_challenge_id": null,
    "type_of_challenge": null,
    "type_of_challenge_value": null,
    "reference_number": null,
    "ethnic_group": null,
    "number_of_children": null,
    "political_status": null,
    "date_of_marriage": null,
    "userId": "02000997",
    "probation_period_end_date": "2005-09-12T00:00:00",
    "social_insurance_payment_date": null,
    "original_start_date": "2005-06-13T00:00:00",
    "service_date": "2005-06-13T00:00:00",
    "seniority_start_date": "2005-06-13T00:00:00",
    "probation_start_date": "2005-06-13T00:00:00",
    "legacy_hris_id": "997",
    "probation_period_number": 3.0,
    "probation_period_frequency": "6016",
    "probation_status": null,
    "entry_into_group": null,
    "job_level_id": "290242",
    "job_level": "JS",
    "job_level_value": "初级专员",
    "startdate": "2024-02-05T00:00:00",
    "company": "C0300",
    "division": "60020301",
    "department": "60021363",
    "contract_start_date": null,
    "contract_end_date": null,
    "contract_type_id": "290236",
    "contract_type": "HKG-Z1",
    "contract_type_value": "Permanent",
    "cost_center": "DH1AFZZZZZ",
    "health_certificate_effective_date": null,
    "health_certificate_expiration_Date": null,
    "health_certificate": null,
    "attendance_type_id": null,
    "attendance_type": null,
    "attendance_type_value": null,
    "job_family_id": null,
    "job_family": "60000008",
    "job_family_value": null,
    "brand": null,
    "employee_class_id": "1256",
    "employee_class": "P",
    "employee_class_value": "正式员工(无固定期限)",
    "event_reason": "DATASUPRV",
    "job_classification": "NONE",
    "location": null,
    "subsidy_criteria_id": null,
    "subsidy_criteria": null,
    "subsidy_criteria_value": null,
    "position": "60024101",
    "position_entry_date": null,
    "manager": "30020386",
    "event": "1933",
    "job_function": "60000057",
    "grade_shk": "HKG_SHK_S2",
    "employee_type": "7749",
    "local_job_title": "Assistant Accounting Officer, Finance",
    "public_job_title_eng": "Assistant Accounting Officer, Finance",
    "mode_of_employment_id": null,
    "mode_of_employment": null,
    "mode_of_employment_value": null,
    "branch_office": null,
    "positionNav_externalName_defaultValue": null,
    "employment_status_id": "1910",
    "employment_status_code": "A",
    "employment_status_value": "在职",
    "empjob_last_modified_date_time": "2024-03-06T03:14:42",
    "compensation_startDate": "2024-01-01T00:00:00",
    "pay_group": "HKG_SHK_H2",
    "pay_component": "60000114",
    "currency": "HKD",
    "frequency": "60000010",
    "amount": xxxxx,
    "recurring_startDate": "2024-01-01T00:00:00",
    "termination_Date": null,
    "last_date_worked": null,
    "termination_sub_reason": null,
    "empemploymenttermination_last_modified_date_time": null,
    "email": [
      {
        "email_type": "B",
        "email_type_value": "公司",
        "email_address": "xxxxx",
        "personIdExternal": "02000997",
        "is_primary": 1,
        "last_modified_date_time": "2021-05-04T19:23:16"
      }
    ],
    "phone": [
      {
        "phone_type": "H",
        "phone_type_value": "家庭",
        "extension": null,
        "phone_number": "xxxxx",
        "country_code": "5290",
        "region_code": "97",
        "personIdExternal": "02000997",
        "last_modified_date_time": "2021-05-04T19:23:01"
      },
      {
        "phone_type": "P",
        "phone_type_value": "个人手机",
        "extension": null,
        "phone_number": "xxxxxxx",
        "country_code": "5290",
        "region_code": "97",
        "personIdExternal": "02000997",
        "last_modified_date_time": "2021-05-04T19:23:01"
      }
    ],
    "address": [
      {
        "address_type": null,
        "address_type_value": null,
        "detailed": "xxxxx",
        "street": "xxxxx",
        "district": null,
        "country": "HKG",
        "province": "xxxx",
        "city": "290173",
        "personIdExternal": "02000997",
        "last_modified_date_time": "2021-05-04T19:23:26"
      }
    ],
    "contacts": []
  }
]

所有以 _value 结尾的字段都是与PickListValueV2字典匹配出的值，默认取label_zh_CN，如果为空的话取label_defaultValue。

以下是员工在职状态字典对应关系