人力资源接口文档 - 阿悦

⚠️ ： 此版本为在线稳定版

登录

接口设计说明

基本信息

Path： /shejishuoming

Method： GET

接口描述：

# 接口符合 restful 规范

success: true   执行成功
success: false 执行失败
code： 10002 token失效
message: 提示消息

请求参数

返回数据

名称	类型	是否必须	默认值	备注	其他信息

登录

基本信息

Path： /sys/login

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	默认值	备注	其他信息
mobile	string	必须		手机号
password	string	必须		密码

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	必须		成功状态
code	number	必须		状态码
message	string	必须		消息
data	string	必须		用户token

获取用户基本资料

基本信息

Path： /sys/profile

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/x-www-form-urlencoded	是
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意Bearer和token之间的空格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	object	非必须
├─ userId	string	非必须
├─ mobile	string	非必须
├─ username	string	非必须
├─ company	string	非必须
├─ companyId	string	非必须
├─ roles	object	非必须
├─ apis	string []	非必须			item 类型: string
├─		非必须
├─ menus	string []	非必须			item 类型: string
├─		非必须
├─ points	string []	非必须			item 类型: string
├─		非必须
├─ authCacheKey	null	非必须

组织架构

新增部门

基本信息

Path： /company/department

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization	JWT TOKEN	是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		部门编码，同级部门不可重复
introduce	string	非必须		介绍
manager	string	非必须		负责人名称
name	string	非必须		部门名称
pid	string	非必须		父级部门ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

查询企业的部门列表

基本信息

Path： /company/department

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	object	非必须
├─ companyId	string	非必须
├─ companyName	string	非必须
├─ companyManage	string	非必须
├─ depts	object []	非必须			item 类型: object
├─ id	string	必须
├─ pid	string	必须
├─ companyId	string	必须
├─ name	string	必须
├─ code	string,null	必须
├─ managerId	null,string	必须
├─ manager	string,null	必须
├─ introduce	string,null	必须
├─ createTime	null	必须

根据ID修改部门详情

基本信息

Path： /company/department/{id}

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		部门ID

Body

名称	类型	是否必须	默认值	备注	其他信息
code	string	非必须		部门编码，同级部门不可重复
companyId	string	非必须		企业id
createTime	string	非必须		创建时间	format: date-time
id	string	非必须		部门ID
introduce	string	非必须		介绍
manager	string	非必须		负责人名称
managerId	string	非必须		负责人ID
name	string	非必须		部门名称
pid	string	非必须		父级部门ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

根据ID删除部门

基本信息

Path： /company/department/{id}

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		部门ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

根据ID查询部门详情

基本信息

Path： /company/department/{id}

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		部门ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		部门对象
├─ code	string	非必须		部门编码，同级部门不可重复
├─ companyId	string	非必须		企业id
├─ createTime	string	非必须		创建时间	format: date-time
├─ id	string	非必须		部门ID
├─ introduce	string	非必须		介绍
├─ manager	string	非必须		负责人名称
├─ managerId	string	非必须		负责人ID
├─ name	string	非必须		部门名称
├─ pid	string	非必须		父级部门ID
message	string	非必须
success	boolean	非必须

角色管理

根据ID删除角色

基本信息

Path： /sys/role/{id}

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

根据ID更新角色

基本信息

Path： /sys/role/{id}

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

Body

名称	类型	是否必须	默认值	备注	其他信息
companyId	string	必须		公司id
description	string	必须		描述
id	string	必须		标识
name	string	必须		角色名称
permIds	string []	必须		权限点数据	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

根据ID获取角色详情

基本信息

Path： /sys/role/{id}

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
├─ companyId	string	必须		公司id
├─ description	string	必须		描述
├─ id	string	必须
├─ name	string	必须		角色名称
├─ permIds	string []	必须		权限点数据	item 类型: string
├─		非必须
message	string	非必须
success	boolean	非必须

添加角色

基本信息

Path： /sys/role

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
name	string	必须		角色名称
region	string	必须		角色描述

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

给角色分配权限

基本信息

Path： /sys/role/assignPrem

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	必须
permIds	string []	必须			item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

获取所有角色列表

基本信息

Path： /sys/role

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Query

参数名称	是否必须	示例	备注
page	是	1	页码
pagesize	是	10	每页条数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	object	非必须
├─ total	number	非必须
├─ rows	object []	非必须			item 类型: object
├─ id	string	必须
├─ name	string	必须
├─ description	string	必须
├─ companyId	string	必须

企业管理

保存企业数据

基本信息

Path： /company

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
auditState	string	非必须		审核状态 0:待审核，1：已审核
balance	number	非必须		当前余额	format: double
businessLicenseId	string	非必须		营业执照
companyAddress	string	非必须		公司地址
companyArea	string	非必须		公司地区
companyPhone	string	非必须		公司电话
companySize	string	非必须		公司规模
createTime	string	非必须		创建时间	format: date-time
expirationDate	string	非必须		到期时间	format: date-time
id	string	非必须		企业id
industry	string	非必须		所属行业
legalRepresentative	string	非必须		法人代表
mailbox	string	非必须		邮箱
managerId	string	非必须		企业登录账号ID
name	string	非必须		公司名称
remarks	string	非必须		备注
renewalDate	string	非必须		续期时间	format: date-time
state	integer	非必须		状态 0：不可用，1：可用	format: int32
version	string	非必须		当前版本

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

查询全部企业列表

基本信息

Path： /company

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ auditState	string	非必须		审核状态 0:待审核，1：已审核
├─ balance	number	非必须		当前余额	format: double
├─ businessLicenseId	string	非必须		营业执照
├─ companyAddress	string	非必须		公司地址
├─ companyArea	string	非必须		公司地区
├─ companyPhone	string	非必须		公司电话
├─ companySize	string	非必须		公司规模
├─ createTime	string	非必须		创建时间	format: date-time
├─ expirationDate	string	非必须		到期时间	format: date-time
├─ id	string	非必须		企业id
├─ industry	string	非必须		所属行业
├─ legalRepresentative	string	非必须		法人代表
├─ mailbox	string	非必须		邮箱
├─ managerId	string	非必须		企业登录账号ID
├─ name	string	非必须		公司名称
├─ remarks	string	非必须		备注
├─ renewalDate	string	非必须		续期时间	format: date-time
├─ state	integer	非必须		状态 0：不可用，1：可用	format: int32
├─ version	string	非必须		当前版本
message	string	非必须
success	boolean	非必须

根据id删除企业

基本信息

Path： /company/{id}

Method： DELETE

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		企业ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

根据id更新企业

基本信息

Path： /company/{id}

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		企业ID

Body

名称	类型	是否必须	默认值	备注	其他信息
auditState	string	非必须		审核状态 0:待审核，1：已审核
balance	number	非必须		当前余额	format: double
businessLicenseId	string	非必须		营业执照
companyAddress	string	非必须		公司地址
companyArea	string	非必须		公司地区
companyPhone	string	非必须		公司电话
companySize	string	非必须		公司规模
createTime	string	非必须		创建时间	format: date-time
expirationDate	string	非必须		到期时间	format: date-time
id	string	非必须		企业id
industry	string	非必须		所属行业
legalRepresentative	string	非必须		法人代表
mailbox	string	非必须		邮箱
managerId	string	非必须		企业登录账号ID
name	string	非必须		公司名称
remarks	string	非必须		备注
renewalDate	string	非必须		续期时间	format: date-time
state	integer	非必须		状态 0：不可用，1：可用	format: int32
version	string	非必须		当前版本

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

根据id查询企业

基本信息

Path： /company/{id}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		企业ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		企业对象
├─ auditState	string	非必须		审核状态 0:待审核，1：已审核
├─ balance	number	非必须		当前余额	format: double
├─ businessLicenseId	string	非必须		营业执照
├─ companyAddress	string	非必须		公司地址
├─ companyArea	string	非必须		公司地区
├─ companyPhone	string	非必须		公司电话
├─ companySize	string	非必须		公司规模
├─ createTime	string	非必须		创建时间	format: date-time
├─ expirationDate	string	非必须		到期时间	format: date-time
├─ id	string	非必须		企业id
├─ industry	string	非必须		所属行业
├─ legalRepresentative	string	非必须		法人代表
├─ mailbox	string	非必须		邮箱
├─ managerId	string	非必须		企业登录账号ID
├─ name	string	非必须		公司名称
├─ remarks	string	非必须		备注
├─ renewalDate	string	非必须		续期时间	format: date-time
├─ state	integer	非必须		状态 0：不可用，1：可用	format: int32
├─ version	string	非必须		当前版本
message	string	非必须
success	boolean	非必须

员工管理

查询年度人事归档列表

基本信息

Path： /employees/archives

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Query

参数名称	是否必须	示例	备注
page	否		页码
pagesize	否		每页条数
year	否		年份

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		分页数据
├─ rows	object []	非必须		分页数据列表	item 类型: object
├─ companyId	string	非必须		企业ID
├─ createTime	string	非必须		创建时间	format: date-time
├─ data	string	非必须		企业id
├─ departures	integer	非必须		离职人数	format: int32
├─ id	string	非必须		ID
├─ month	string	非必须		月份
├─ opUser	string	非必须		操作人
├─ payrolls	integer	非必须		在职人数	format: int32
├─ totals	integer	非必须		总人数	format: int32
├─ total	integer	非必须		总条数	format: int64
message	string	非必须
success	boolean	非必须

保存员工个人信息

基本信息

Path： /employees/{id}/personalInfo

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

Body

名称	类型	是否必须	默认值	备注	其他信息
age	string	非必须		年龄
archivingOrganization	string	非必须		存档机构
areThereAnyMajorMedicalHistories	string	非必须		有无重大病史
bankCardNumber	string	非必须		银行卡号
birthday	string	非必须		生日
bloodType	string	非必须		血型
certificateOfAcademicDegree	string	非必须		学位证书
companyId	string	非必须		企业id
constellation	string	非必须		星座
contactTheMobilePhone	string	非必须		联系手机
dateOfBirth	string	非必须		出生日期
dateOfResidencePermit	string	非必须		居住证办理日期
departmentName	string	非必须		部门
doChildrenHaveCommercialInsurance	string	非必须		子女有无商业保险
domicile	string	非必须		企业id
educationalType	string	非必须		学历类型
emergencyContact	string	非必须		紧急联系人
emergencyContactNumber	string	非必须		紧急联系电话
englishName	string	非必须		英文名
enrolmentTime	string	非必须		入学时间
graduateSchool	string	非必须		毕业学校
graduationCertificate	string	非必须		毕业证书
graduationTime	string	非必须		毕业时间
homeCompany	string	非必须		上家公司
idCardPhotoBack	string	非必须		身份证照片-背面
idCardPhotoPositive	string	非必须		身份证照片-正面
idNumber	string	非必须		身份证号
isThereAnyCompetitionRestriction	string	非必须		有无竞业限制
isThereAnyViolationOfLawOrDiscipline	string	非必须		有无违法违纪行为
major	string	非必须		专业
maritalStatus	string	非必须		婚姻状况
mobile	string	非必须		手机号
nation	string	非必须		民族
nationalArea	string	非必须		国家地区
nativePlace	string	非必须		籍贯
openingBank	string	非必须		开户行
passportNo	string	非必须		护照号
personalMailbox	string	非必须		个人邮箱
placeOfResidence	string	非必须		现居住地
politicalOutlook	string	非必须		政治面貌
postalAddress	string	非必须		通讯地址
proofOfDepartureOfFormerCompany	string	非必须		前公司离职证明
providentFundAccount	string	非必须		公积金账号
qq	string	非必须		QQ
remarks	string	非必须		备注
residenceCardCity	string	非必须		居住证城市
residencePermitDeadline	string	非必须		居住证截止日期
resume	string	非必须		简历
sex	string	非必须		性别
socialSecurityComputerNumber	string	非必须		社保电脑号
staffPhoto	string	非必须		员工照片
stateOfChildren	string	非必须		子女状态
theHighestDegreeOfEducation	string	非必须		最高学历
timeOfEntry	string	非必须		转正时间
timeToJoinTheParty	string	非必须		入党时间
title	string	非必须		职称
userId	string	非必须		用户ID
username	string	非必须		用户名
wechat	string	非必须		微信
zodiac	string	非必须		属相

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

保存员工岗位信息

基本信息

Path： /employees/{id}/jobs

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

Body

名称	类型	是否必须	默认值	备注	其他信息
adjustmentAgedays	integer	非必须		调整司龄天	format: int32
adjustmentOfLengthOfService	integer	非必须		调整工龄天	format: int32
closingTimeOfCurrentContract	string	非必须		现合同结束时间
companyId	string	非必须		公司ID
contractDocuments	string	非必须		合同文件
contractPeriod	string	非必须		合同期限
correctionEvaluation	string	非必须		转正评价
currentContractStartTime	string	非必须		现合同开始时间
firstContractTerminationTime	string	非必须		首次合同结束时间
hrbp	string	非必须		HRBP
initialContractStartTime	string	非必须		首次合同开始时间
otherRecruitmentChannels	string	非必须		其他招聘渠道
post	string	非必须		岗位
rank	string	非必须		职级
recommenderBusinessPeople	string	非必须		推荐企业人
recruitmentChannels	string	非必须		招聘渠道
renewalNumber	integer	非必须		续签次数	format: int32
reportId	string	非必须		汇报对象
reportName	string	非必须		汇报对象
socialRecruitment	string	非必须		社招校招
stateOfCorrection	string	非必须		转正状态
taxableCity	string	非必须		纳税城市
userId	string	非必须		员工ID
workMailbox	string	非必须		工作邮箱
workingCity	string	非必须		工作城市
workingTimeForTheFirstTime	string	非必须		首次参加工作时间

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

保存员工调岗信息

基本信息

Path： /employees/{id}/transferPosition

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

Body

名称	类型	是否必须	默认值	备注	其他信息
adjustmentTime	string	非必须		调岗时间	format: date-time
causeOfAdjustingPost	string	非必须		调岗原因
closingTimeOfCurrentContract	string	非必须		现合同结束时间
contractPeriod	string	非必须		合同期限
createTime	string	非必须		创建时间	format: date-time
currentContractStartTime	string	非必须		现合同开始时间
enclosure	string	非必须		附件
estatus	integer	非必须		状态 1是未执行，2是已执行	format: int32
firstContractTerminationTime	string	非必须		首次合同结束时间
formOfManagement	string	非必须		管理形式
hrbp	string	非必须		HRBP
initialContractStartTime	string	非必须		首次合同开始时间
post	string	非必须		岗位
rank	string	非必须		职级
recommenderBusinessPeople	string	非必须		推荐企业人
renewalNumber	integer	非必须		续签次数	format: int32
reportingObject	string	非必须		汇报对象
taxableCity	string	非必须		纳税城市
userId	string	非必须		员工ID
workingCity	string	非必须		工作城市
workingPlace	string	非必须		工作地点

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

保存员工转正数据

基本信息

Path： /employees/{id}/positive

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

Body

名称	类型	是否必须	默认值	备注	其他信息
correctionEvaluation	string	非必须		转正评价
createTime	string	非必须		创建时间	format: date-time
dateOfCorrection	string	非必须		转正日期	format: date-time
enclosure	string	非必须		附件
estatus	integer	非必须		状态 1是未执行，2是已执行	format: int32
userId	string	非必须		员工ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

保存城市信息

基本信息

Path： /employees/{id}/pdf

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

返回数据

OK

保存离职表单信息

基本信息

Path： /employees/{id}/leave

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

Body

名称	类型	是否必须	默认值	备注	其他信息
compensation	string	非必须		补偿金
createTime	string	非必须		创建时间	format: date-time
notifications	string	非必须		代通知金
picture	string	非必须		图片
providentFundReductionMonth	string	非必须		公积金减员月
reasonsForLeaving	string	非必须		申请离职原因
resignationTime	string	非必须		离职时间
socialSecurityReductionMonth	string	非必须		社保减员月
typeOfTurnover	string	非必须		离职类型
userId	string	非必须		员工Id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

批量导入员工

基本信息

Path： /sys/user/batch

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息

新增员工

基本信息

Path： /sys/user

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是
Authorization	JWT TOKEN	是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
username	string	非必须		姓名
mobile	string	非必须		手机号
formOfEmployment	number	非必须		聘用形式
workNumber	string	非必须		工号
departmentName	string	非必须		组织名称
timeOfEntry	string	非必须		入职时间
correctionTime	string	非必须		转正时间

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	null	非必须

查询员工调岗信息

基本信息

Path： /employees/{id}/transferPosition

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		企业员工岗位详情
├─ adjustmentAgedays	integer	非必须		调整司龄天	format: int32
├─ adjustmentOfLengthOfService	integer	非必须		调整工龄天	format: int32
├─ closingTimeOfCurrentContract	string	非必须		现合同结束时间
├─ companyId	string	非必须		公司ID
├─ contractDocuments	string	非必须		合同文件
├─ contractPeriod	string	非必须		合同期限
├─ correctionEvaluation	string	非必须		转正评价
├─ currentContractStartTime	string	非必须		现合同开始时间
├─ firstContractTerminationTime	string	非必须		首次合同结束时间
├─ hrbp	string	非必须		HRBP
├─ initialContractStartTime	string	非必须		首次合同开始时间
├─ otherRecruitmentChannels	string	非必须		其他招聘渠道
├─ post	string	非必须		岗位
├─ rank	string	非必须		职级
├─ recommenderBusinessPeople	string	非必须		推荐企业人
├─ recruitmentChannels	string	非必须		招聘渠道
├─ renewalNumber	integer	非必须		续签次数	format: int32
├─ reportId	string	非必须		汇报对象
├─ reportName	string	非必须		汇报对象
├─ socialRecruitment	string	非必须		社招校招
├─ stateOfCorrection	string	非必须		转正状态
├─ taxableCity	string	非必须		纳税城市
├─ userId	string	非必须		员工ID
├─ workMailbox	string	非必须		工作邮箱
├─ workingCity	string	非必须		工作城市
├─ workingTimeForTheFirstTime	string	非必须		首次参加工作时间
message	string	非必须
success	boolean	非必须

保存员工基本信息

基本信息

Path： /sys/user/{id}

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	非必须
mobile	string	非必须
username	string	非必须
password	string	非必须
enableState	number	非必须
createTime	string	非必须
companyId	string	非必须
companyName	string	非必须
departmentId	string	非必须
timeOfEntry	string	非必须
formOfEmployment	number	非必须
workNumber	string	非必须
formOfManagement	null	非必须
workingCity	null	非必须
correctionTime	string	非必须
inServiceStatus	number	非必须
departmentName	string	非必须
roleIds	string []	非必须			item 类型: string
├─		非必须
staffPhoto	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

生成人事报表

基本信息

Path： /employees/export/{month}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
month		报表月份

返回数据

OK

给员工分配角色

基本信息

Path： /sys/user/assignRoles

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
id	string	非必须
roleIds	string []	非必须			item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	null	非必须

获取员工个人信息

基本信息

Path： /employees/{id}/personalInfo

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		员工个人信息
├─ age	string	非必须		年龄
├─ archivingOrganization	string	非必须		存档机构
├─ areThereAnyMajorMedicalHistories	string	非必须		有无重大病史
├─ bankCardNumber	string	非必须		银行卡号
├─ birthday	string	非必须		生日
├─ bloodType	string	非必须		血型
├─ certificateOfAcademicDegree	string	非必须		学位证书
├─ companyId	string	非必须		企业id
├─ constellation	string	非必须		星座
├─ contactTheMobilePhone	string	非必须		联系手机
├─ dateOfBirth	string	非必须		出生日期
├─ dateOfResidencePermit	string	非必须		居住证办理日期
├─ departmentName	string	非必须		部门
├─ doChildrenHaveCommercialInsurance	string	非必须		子女有无商业保险
├─ domicile	string	非必须		企业id
├─ educationalType	string	非必须		学历类型
├─ emergencyContact	string	非必须		紧急联系人
├─ emergencyContactNumber	string	非必须		紧急联系电话
├─ englishName	string	非必须		英文名
├─ enrolmentTime	string	非必须		入学时间
├─ graduateSchool	string	非必须		毕业学校
├─ graduationCertificate	string	非必须		毕业证书
├─ graduationTime	string	非必须		毕业时间
├─ homeCompany	string	非必须		上家公司
├─ idCardPhotoBack	string	非必须		身份证照片-背面
├─ idCardPhotoPositive	string	非必须		身份证照片-正面
├─ idNumber	string	非必须		身份证号
├─ isThereAnyCompetitionRestriction	string	非必须		有无竞业限制
├─ isThereAnyViolationOfLawOrDiscipline	string	非必须		有无违法违纪行为
├─ major	string	非必须		专业
├─ maritalStatus	string	非必须		婚姻状况
├─ mobile	string	非必须		手机号
├─ nation	string	非必须		民族
├─ nationalArea	string	非必须		国家地区
├─ nativePlace	string	非必须		籍贯
├─ openingBank	string	非必须		开户行
├─ passportNo	string	非必须		护照号
├─ personalMailbox	string	非必须		个人邮箱
├─ placeOfResidence	string	非必须		现居住地
├─ politicalOutlook	string	非必须		政治面貌
├─ postalAddress	string	非必须		通讯地址
├─ proofOfDepartureOfFormerCompany	string	非必须		前公司离职证明
├─ providentFundAccount	string	非必须		公积金账号
├─ qq	string	非必须		QQ
├─ remarks	string	非必须		备注
├─ residenceCardCity	string	非必须		居住证城市
├─ residencePermitDeadline	string	非必须		居住证截止日期
├─ resume	string	非必须		简历
├─ sex	string	非必须		性别
├─ socialSecurityComputerNumber	string	非必须		社保电脑号
├─ staffPhoto	string	非必须		员工照片
├─ stateOfChildren	string	非必须		子女状态
├─ theHighestDegreeOfEducation	string	非必须		最高学历
├─ timeOfEntry	string	非必须		转正时间
├─ timeToJoinTheParty	string	非必须		入党时间
├─ title	string	非必须		职称
├─ userId	string	非必须		用户ID
├─ username	string	非必须		用户名
├─ wechat	string	非必须		微信
├─ zodiac	string	非必须		属相
message	string	非必须
success	boolean	非必须

获取员工列表

基本信息

Path： /sys/user

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Query

参数名称	是否必须	示例	备注
page	是	1	页码
size	是	10	每页条数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	object	非必须
├─ total	number	非必须
├─ rows	object []	非必须			item 类型: object
├─ id	string	必须
├─ mobile	string	必须
├─ username	string	必须
├─ password	string	必须
├─ enableState	number	必须
├─ createTime	string,null	必须
├─ companyId	string	必须
├─ companyName	string	必须
├─ departmentId	string	必须
├─ timeOfEntry	string	必须
├─ formOfEmployment	number	必须
├─ workNumber	string	必须
├─ formOfManagement	null	必须
├─ workingCity	null	必须
├─ correctionTime	string,null	必须
├─ inServiceStatus	number	必须
├─ departmentName	string	必须
├─ level	string	必须
├─ staffPhoto	string,null	必须

获取员工基本信息

基本信息

Path： /sys/user/{id}

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	object	非必须
├─ id	string	非必须
├─ mobile	string	非必须
├─ username	string	非必须
├─ password	string	非必须
├─ enableState	number	非必须
├─ createTime	string	非必须
├─ companyId	string	非必须
├─ companyName	string	非必须
├─ departmentId	string	非必须
├─ timeOfEntry	string	非必须
├─ formOfEmployment	number	非必须
├─ workNumber	string	非必须
├─ formOfManagement	null	非必须
├─ workingCity	null	非必须
├─ correctionTime	string	非必须
├─ inServiceStatus	number	非必须
├─ departmentName	string	非必须
├─ roleIds	string []	非必须			item 类型: string
├─		非必须
├─ staffPhoto	string	非必须

获取员工岗位信息

基本信息

Path： /employees/{id}/jobs

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		企业员工岗位详情
├─ adjustmentAgedays	integer	非必须		调整司龄天	format: int32
├─ adjustmentOfLengthOfService	integer	非必须		调整工龄天	format: int32
├─ closingTimeOfCurrentContract	string	非必须		现合同结束时间
├─ companyId	string	非必须		公司ID
├─ contractDocuments	string	非必须		合同文件
├─ contractPeriod	string	非必须		合同期限
├─ correctionEvaluation	string	非必须		转正评价
├─ currentContractStartTime	string	非必须		现合同开始时间
├─ firstContractTerminationTime	string	非必须		首次合同结束时间
├─ hrbp	string	非必须		HRBP
├─ initialContractStartTime	string	非必须		首次合同开始时间
├─ otherRecruitmentChannels	string	非必须		其他招聘渠道
├─ post	string	非必须		岗位
├─ rank	string	非必须		职级
├─ recommenderBusinessPeople	string	非必须		推荐企业人
├─ recruitmentChannels	string	非必须		招聘渠道
├─ renewalNumber	integer	非必须		续签次数	format: int32
├─ reportId	string	非必须		汇报对象
├─ reportName	string	非必须		汇报对象
├─ socialRecruitment	string	非必须		社招校招
├─ stateOfCorrection	string	非必须		转正状态
├─ taxableCity	string	非必须		纳税城市
├─ userId	string	非必须		员工ID
├─ workMailbox	string	非必须		工作邮箱
├─ workingCity	string	非必须		工作城市
├─ workingTimeForTheFirstTime	string	非必须		首次参加工作时间
message	string	非必须
success	boolean	非必须

获取员工简单列表

基本信息

Path： /sys/user/simple

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	object []	非必须			item 类型: object
├─ id	string	必须
├─ username	string	必须

获取用户转正信息详情

基本信息

Path： /employees/{id}/positive

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		员工转正详情
├─ correctionEvaluation	string	非必须		转正评价
├─ createTime	string	非必须		创建时间	format: date-time
├─ dateOfCorrection	string	非必须		转正日期	format: date-time
├─ enclosure	string	非必须		附件
├─ estatus	integer	非必须		状态 1是未执行，2是已执行	format: int32
├─ userId	string	非必须		员工ID
message	string	非必须
success	boolean	非必须

获取离职表单信息

基本信息

Path： /employees/{id}/leave

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		离职信息
├─ compensation	string	非必须		补偿金
├─ createTime	string	非必须		创建时间	format: date-time
├─ notifications	string	非必须		代通知金
├─ picture	string	非必须		图片
├─ providentFundReductionMonth	string	非必须		公积金减员月
├─ reasonsForLeaving	string	非必须		申请离职原因
├─ resignationTime	string	非必须		离职时间
├─ socialSecurityReductionMonth	string	非必须		社保减员月
├─ typeOfTurnover	string	非必须		离职类型
├─ userId	string	非必须		员工Id
message	string	非必须
success	boolean	非必须

权限管理

根据ID更新权限点详情

基本信息

Path： /sys/permission/{id}

Method： PUT

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

Body

名称	类型	是否必须	默认值	备注	其他信息
enVisible	string	非必须
name	string	非必须
code	string	非必须
description	string	非必须
type	number	非必须
pid	string	非必须
id	string	必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息

根据ID获取权限点详情

基本信息

Path： /sys/permission/{id}

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	object	非必须
├─ menuOrder	string	非必须
├─ enVisible	string	非必须
├─ code	string	非必须
├─ menuIcon	string	非必须
├─ name	string	非必须
├─ description	string	非必须
├─ pid	string	非必须
├─ id	string	非必须
├─ type	number	非必须

根据id删除权限点

基本信息

Path： /sys/permission/{id}

Method： DELETE

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

添加权限点

基本信息

Path： /sys/permission

Method： POST

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
enVisible	string	非必须
name	string	非必须
code	string	非必须
description	string	非必须
type	number	非必须
pid	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

获取所有权限点

基本信息

Path： /sys/permission

Method： GET

接口描述：

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
success	boolean	非必须
code	number	非必须
message	string	非必须
data	object []	非必须			item 类型: object
├─ id	string	必须
├─ name	string	必须
├─ type	number	必须
├─ code	string	必须
├─ description	string	必须
├─ pid	string	必须
├─ enVisible	string	必须

审批管理

发起流程申请

基本信息

Path： /user/process/startProcess

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
days	string	非必须		天数
departmentId	string	非必须		部门ID
departmentName	string	非必须		部门
procApplyTime	string	非必须		申请时间	format: date-time
procCurrNodeUserId	string	非必须		当前节点审批人ID
procCurrNodeUserName	string	非必须		当前节点审批人
procData	string	非必须		申请的业务数据(需要转化为json)
procEndTime	string	非必须		结束流程时间	format: date-time
processDefinitionId	string	非必须		流程定义ID
processId	string	非必须		流程实例ID
processKey	string	非必须		流程标识
processName	string	非必须		流程名称
processState	string	非必须		流程状态（1审批中；2审批通过；3审批不通过；4撤销)
timeOfEntry	string	非必须		入职时间	format: date-time
userId	string	非必须		申请人ID
username	string	非必须		申请人

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

提交审核

基本信息

Path： /user/process/instance/commit

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
taskId	string	非必须
handleOpinion	string	非必须
handleTime	string	非必须			format: date-time
handleType	string	非必须
handleUserId	string	非必须
handleUserName	string	非必须
processId	string	非必须
taskKey	string	非必须
taskName	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

查询审批单审批明细

基本信息

Path： /user/process/instance/tasks/{id}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		审批单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		审批意见列表
├─ taskId	string	非必须
├─ handleOpinion	string	非必须
├─ handleTime	string	非必须			format: date-time
├─ handleType	string	非必须
├─ handleUserId	string	非必须
├─ handleUserName	string	非必须
├─ processId	string	非必须
├─ taskKey	string	非必须
├─ taskName	string	非必须
message	string	非必须
success	boolean	非必须

查询审批单的详情数据

基本信息

Path： /user/process/instance/{id}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		审批单ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		流程实例，审批单
├─ departmentId	string	非必须		部门ID
├─ departmentName	string	非必须		部门
├─ procApplyTime	string	非必须		申请时间	format: date-time
├─ procCurrNodeUserId	string	非必须		当前节点审批人ID
├─ procCurrNodeUserName	string	非必须		当前节点审批人
├─ procData	string	非必须		申请的业务数据(需要转化为json)
├─ procEndTime	string	非必须		结束流程时间	format: date-time
├─ processDefinitionId	string	非必须		流程定义ID
├─ processId	string	非必须		流程实例ID
├─ processKey	string	非必须		流程标识
├─ processName	string	非必须		流程名称
├─ processState	string	非必须		流程状态（1审批中；2审批通过；3审批不通过；4撤销)
├─ timeOfEntry	string	非必须		入职时间	format: date-time
├─ userId	string	非必须		申请人ID
├─ username	string	非必须		申请人
message	string	非必须
success	boolean	非必须

查询所有的流程定义

基本信息

Path： /user/process/definition

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ description	string	非必须		流程描述
├─ key	string	非必须		流程key
├─ name	string	非必须		流程名称
message	string	非必须
success	boolean	非必须

查询申请列表

基本信息

Path： /user/process/instance/{page}/{size}

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
page		页面
size		每页条数

Body

名称	类型	是否必须	默认值	备注	其他信息
departmentId	string	非必须		部门ID
departmentName	string	非必须		部门
procApplyTime	string	非必须		申请时间	format: date-time
procCurrNodeUserId	string	非必须		当前节点审批人ID
procCurrNodeUserName	string	非必须		当前节点审批人
procData	string	非必须		申请的业务数据(需要转化为json)
procEndTime	string	非必须		结束流程时间	format: date-time
processDefinitionId	string	非必须		流程定义ID
processId	string	非必须		流程实例ID
processKey	string	非必须		流程标识
processName	string	非必须		流程名称
processState	string	非必须		流程状态（1审批中；2审批通过；3审批不通过；4撤销)
timeOfEntry	string	非必须		入职时间	format: date-time
userId	string	非必须		申请人ID
username	string	非必须		申请人

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		分页数据
├─ rows	object []	非必须		分页数据列表	item 类型: object
├─ departmentId	string	非必须		部门ID
├─ departmentName	string	非必须		部门
├─ procApplyTime	string	非必须		申请时间	format: date-time
├─ procCurrNodeUserId	string	非必须		当前节点审批人ID
├─ procCurrNodeUserName	string	非必须		当前节点审批人
├─ procData	string	非必须		申请的业务数据(需要转化为json)
├─ procEndTime	string	非必须		结束流程时间	format: date-time
├─ processDefinitionId	string	非必须		流程定义ID
├─ processId	string	非必须		流程实例ID
├─ processKey	string	非必须		流程标识
├─ processName	string	非必须		流程名称
├─ processState	string	非必须		流程状态（1审批中；2审批通过；3审批不通过；4撤销)
├─ timeOfEntry	string	非必须		入职时间	format: date-time
├─ userId	string	非必须		申请人ID
├─ username	string	非必须		申请人
├─ total	integer	非必须		总条数	format: int64
message	string	非必须
success	boolean	非必须

设置流程的挂起与激活状态

基本信息

Path： /user/process/suspend/{processKey}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
processKey		流程key

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

部署新流程

基本信息

Path： /user/process/deploy

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

参数名称	参数类型	是否必须	示例	备注
file	file	否		流程定义文件

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

社保管理

查询社保历史归档列表

基本信息

Path： /social_securitys/historys/{year}/list

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
参保年		year
year

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ companyId	string	非必须		企业id
├─ creationTime	string	非必须		创建时间	format: date-time
├─ enterprisePayment	number	非必须		企业缴费
├─ id	string	非必须		ID
├─ personalPayment	number	非必须		个人缴费
├─ total	number	非必须		合计
├─ yearsMonth	string	非必须		年月
message	string	非必须
success	boolean	非必须

保存企业社保配置信息

基本信息

Path： /social_securitys/settings

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
companyId	string	非必须		企业id
dataMonth	string	非必须
isSettings	integer	非必须		是否设置 0为未设置，1为已设置	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

查询企业用户社保列表

基本信息

Path： /social_securitys/list

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
departmentChecks	string []	非必须		部门列表	item 类型: string
├─		非必须
page	integer	非必须		页码	format: int32
pageSize	integer	非必须		每页条数	format: int32
providentFundChecks	string []	非必须		公积金城市列表	item 类型: string
├─		非必须
socialSecurityChecks	string []	非必须		参保城市列表	item 类型: string
├─		非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		分页数据
├─ rows	object []	非必须		分页数据列表	item 类型: object
├─ departmentName	string	非必须		部门名称
├─ id	string	非必须		ID
├─ leaveTime	string	非必须		离职时间
├─ mobile	string	非必须		用户手机号码
├─ participatingInTheCity	string	非必须		参保城市名称
├─ participatingInTheCityId	string	非必须		参保城市id
├─ providentFundBase	integer	非必须		公积金基数	format: int32
├─ providentFundCity	string	非必须		公积金城市名称
├─ providentFundCityId	string	非必须		公积金城市id
├─ socialSecurityBase	integer	非必须		社保基数	format: int32
├─ timeOfEntry	string	非必须		入职时间
├─ username	string	非必须		用户名
├─ workNumber	string	非必须		工号
├─ total	integer	非必须		总条数	format: int64
message	string	非必须
success	boolean	非必须

查询企业社保配置信息

基本信息

Path： /social_securitys/settings

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		企业设置对象
├─ companyId	string	非必须		企业id
├─ dataMonth	string	非必须
├─ isSettings	integer	非必须		是否设置 0为未设置，1为已设置	format: int32
message	string	非必须
success	boolean	非必须

查询月份数据报表

基本信息

Path： /social_securitys/historys/{yearMonth}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
参保年月		yearMonth
yearMonth

Body

名称	类型	是否必须	默认值	备注	其他信息
	integer	非必须			format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ accumulationFundEnterpriseBase	number	非必须		公积金企业基数
├─ apersonOfGreatDisease	number	非必须
├─ archiveId	string	非必须		归档id
├─ bankCardNumber	string	非必须		银行卡号
├─ baseOfIndustrialInjuryEnterprises	number	非必须		工伤企业基数
├─ baseOfSeriousIllness	number	非必须		大病企业基数
├─ bigDiseaseEnterprise	number	非必须		大病企业
├─ childbearingEnterprise	number	非必须		生育企业
├─ fertilityEnterpriseBase	number	非必须		生育企业基数
├─ firstLevelDepartment	string	非必须		一级部门
├─ householdRegistrationType	string	非必须		户籍类型
├─ id	string	非必须		id
├─ idNumber	string	非必须		身份证号
├─ individualBaseOfProvidentFund	number	非必须		公积金个人基数
├─ industrialInjuryEnterprise	number	非必须		工伤企业
├─ leaveDate	string	非必须		离职时间
├─ medicalEnterprise	number	非必须		医疗企业
├─ medicalEnterpriseBase	number	非必须		医疗企业基数
├─ medicalIndividual	number	非必须		医疗个人
├─ medicalPersonalBase	number	非必须		医疗个人基数
├─ medicalPersonalRatio	number	非必须		医疗个人比例
├─ mobile	string	非必须		手机号
├─ oldAgeIndividual	number	非必须		养老个人
├─ openingBank	string	非必须		开户行
├─ participatingInTheCity	string	非必须		参保城市
├─ pensionEnterprise	number	非必须		养老企业
├─ pensionEnterpriseBase	number	非必须		养老企业基数
├─ percentageOfUnemployedIndividuals	number	非必须		失业个人比例
├─ personalBaseOfSeriousIllness	number	非必须		大病个人基数
├─ personalPensionBase	number	非必须		养老个人基数
├─ personalPensionRatio	number	非必须		养老个人比例
├─ personalProportionOfSeriousIllness	number	非必须		大病个人比例
├─ personalRatioOfProvidentFund	number	非必须		公积金个人比例
├─ proportionOfFertilityEnterprises	number	非必须		生育企业比例
├─ proportionOfIndustrialInjuryEnterprises	number	非必须		工伤企业比例
├─ proportionOfMedicalEnterprises	number	非必须		医疗企业比例
├─ proportionOfPensionEnterprises	number	非必须		养老企业比例
├─ proportionOfProvidentFundEnterprises	number	非必须		公积金企业比例
├─ proportionOfSeriouslyIllEnterprises	number	非必须		企业id
├─ proportionOfUnemployedEnterprises	number	非必须		失业企业比例
├─ providentFundAccount	string	非必须		公积金账号
├─ providentFundBase	number	非必须		公积金基数
├─ providentFundCity	string	非必须		公积金城市
├─ providentFundEnterprises	number	非必须		公积金企业
├─ providentFundIndividual	number	非必须		公积金个人
├─ providentFundMonth	string	非必须		公积金月份
├─ providentFundNotes	string	非必须		公积金备注
├─ socialSecurity	number	非必须		社保合计
├─ socialSecurityBase	number	非必须		社保基数
├─ socialSecurityComputerNumber	string	非必须		社保电脑号
├─ socialSecurityEnterprise	number	非必须		社保企业
├─ socialSecurityIndividual	number	非必须		社保个人
├─ socialSecurityMonth	string	非必须		社保月份
├─ socialSecurityNotes	string	非必须		社保备注
├─ theHighestDegreeOfEducation	string	非必须		学历
├─ theNumberOfUnemployedIndividuals	number	非必须		失业个人基数
├─ timeOfEntry	string	非必须		入职时间	format: date-time
├─ totalProvidentFund	number	非必须		公积金合计
├─ twoLevelDepartment	string	非必须		二级部门
├─ unemployedEnterprise	number	非必须		失业企业
├─ unemployedIndividual	number	非必须		失业个人
├─ unemploymentEnterpriseBase	number	非必须		失业企业基数
├─ userId	string	非必须		用户id
├─ username	string	非必须		姓名
├─ workingCity	string	非必须		工作城市
├─ yearsMonth	string	非必须		年月
message	string	非必须
success	boolean	非必须

保存或更新用户社保数据

基本信息

Path： /social_securitys/{id}

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

Body

名称	类型	是否必须	默认值	备注	其他信息
enterpriseProportion	number	非必须		公积金企业比例
enterpriseProvidentFundPayment	number	非必须		公积金企业缴纳数额
enterprisesPaySocialSecurityThisMonth	integer	非必须		本月是否缴纳社保 0为不缴纳 1为缴纳	format: int32
enterprisesPayTheProvidentFundThisMonth	integer	非必须		本月是否缴纳公积金 0为不缴纳 1为缴纳	format: int32
householdRegistration	string	非必须		户籍
householdRegistrationType	integer	非必须		户籍类型 1为本市城镇 2为本市农村 3为外埠城镇 4为外埠农村	format: int32
industrialInjuryRatio	number	非必须		工伤比例
lastModifyTime	string	非必须		最后修改时间	format: date-time
participatingInTheCity	string	非必须		参保城市
participatingInTheCityId	string	非必须		参保城市id
personalProportion	number	非必须		公积金个人比例
personalProvidentFundPayment	number	非必须		公积金个人缴纳数额
providentFundBase	number	非必须		公积金基数
providentFundCity	string	非必须		公积金城市
providentFundCityId	string	非必须		公积金城市id
providentFundNotes	string	非必须		公积金备注
providentFundSwitchUpdateTime	string	非必须		公积金缴纳变更时间	format: date-time
socialSecurityBase	number	非必须		社保基数
socialSecurityNotes	string	非必须		社保备注
socialSecuritySwitchUpdateTime	string	非必须		社保是否缴纳变更时间	format: date-time
socialSecurityType	integer	非必须		参保类型 1为首次开户 2为非首次开户	format: int32
userId	string	非必须		企业id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

根据城市id查询参保城市的参保项目

基本信息

Path： /social_securitys/payment_item/{id}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
城市ID		id
id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ cityId	string	非必须
├─ id	string	非必须
├─ name	string	非必须
├─ paymentItemId	string	非必须
├─ scaleCompany	number	非必须
├─ scalePersonal	number	非必须
├─ switchCompany	boolean	非必须
├─ switchPersonal	boolean	非必须
message	string	非必须
success	boolean	非必须

根据用户id和考勤年月查询用户考勤归档明细

基本信息

Path： /social_securitys/historys/archiveDetail/{userId}/{yearMonth}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
用户ID		userId
参保年月		yearMonth
userId
yearMonth

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		社保归档数据详情
├─ accumulationFundEnterpriseBase	number	非必须		公积金企业基数
├─ apersonOfGreatDisease	number	非必须
├─ archiveId	string	非必须		归档id
├─ bankCardNumber	string	非必须		银行卡号
├─ baseOfIndustrialInjuryEnterprises	number	非必须		工伤企业基数
├─ baseOfSeriousIllness	number	非必须		大病企业基数
├─ bigDiseaseEnterprise	number	非必须		大病企业
├─ childbearingEnterprise	number	非必须		生育企业
├─ fertilityEnterpriseBase	number	非必须		生育企业基数
├─ firstLevelDepartment	string	非必须		一级部门
├─ householdRegistrationType	string	非必须		户籍类型
├─ id	string	非必须		id
├─ idNumber	string	非必须		身份证号
├─ individualBaseOfProvidentFund	number	非必须		公积金个人基数
├─ industrialInjuryEnterprise	number	非必须		工伤企业
├─ leaveDate	string	非必须		离职时间
├─ medicalEnterprise	number	非必须		医疗企业
├─ medicalEnterpriseBase	number	非必须		医疗企业基数
├─ medicalIndividual	number	非必须		医疗个人
├─ medicalPersonalBase	number	非必须		医疗个人基数
├─ medicalPersonalRatio	number	非必须		医疗个人比例
├─ mobile	string	非必须		手机号
├─ oldAgeIndividual	number	非必须		养老个人
├─ openingBank	string	非必须		开户行
├─ participatingInTheCity	string	非必须		参保城市
├─ pensionEnterprise	number	非必须		养老企业
├─ pensionEnterpriseBase	number	非必须		养老企业基数
├─ percentageOfUnemployedIndividuals	number	非必须		失业个人比例
├─ personalBaseOfSeriousIllness	number	非必须		大病个人基数
├─ personalPensionBase	number	非必须		养老个人基数
├─ personalPensionRatio	number	非必须		养老个人比例
├─ personalProportionOfSeriousIllness	number	非必须		大病个人比例
├─ personalRatioOfProvidentFund	number	非必须		公积金个人比例
├─ proportionOfFertilityEnterprises	number	非必须		生育企业比例
├─ proportionOfIndustrialInjuryEnterprises	number	非必须		工伤企业比例
├─ proportionOfMedicalEnterprises	number	非必须		医疗企业比例
├─ proportionOfPensionEnterprises	number	非必须		养老企业比例
├─ proportionOfProvidentFundEnterprises	number	非必须		公积金企业比例
├─ proportionOfSeriouslyIllEnterprises	number	非必须		企业id
├─ proportionOfUnemployedEnterprises	number	非必须		失业企业比例
├─ providentFundAccount	string	非必须		公积金账号
├─ providentFundBase	number	非必须		公积金基数
├─ providentFundCity	string	非必须		公积金城市
├─ providentFundEnterprises	number	非必须		公积金企业
├─ providentFundIndividual	number	非必须		公积金个人
├─ providentFundMonth	string	非必须		公积金月份
├─ providentFundNotes	string	非必须		公积金备注
├─ socialSecurity	number	非必须		社保合计
├─ socialSecurityBase	number	非必须		社保基数
├─ socialSecurityComputerNumber	string	非必须		社保电脑号
├─ socialSecurityEnterprise	number	非必须		社保企业
├─ socialSecurityIndividual	number	非必须		社保个人
├─ socialSecurityMonth	string	非必须		社保月份
├─ socialSecurityNotes	string	非必须		社保备注
├─ theHighestDegreeOfEducation	string	非必须		学历
├─ theNumberOfUnemployedIndividuals	number	非必须		失业个人基数
├─ timeOfEntry	string	非必须		入职时间	format: date-time
├─ totalProvidentFund	number	非必须		公积金合计
├─ twoLevelDepartment	string	非必须		二级部门
├─ unemployedEnterprise	number	非必须		失业企业
├─ unemployedIndividual	number	非必须		失业个人
├─ unemploymentEnterpriseBase	number	非必须		失业企业基数
├─ userId	string	非必须		用户id
├─ username	string	非必须		姓名
├─ workingCity	string	非必须		工作城市
├─ yearsMonth	string	非必须		年月
message	string	非必须
success	boolean	非必须

根据用户id查询用户的社保数据

基本信息

Path： /social_securitys/{id}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
用户id		id
id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		查询个人社保详情
├─ user	object	非必须		用户对象
├─ companyName	string	非必须		企业
├─ correctionTime	string	非必须			format: date-time
├─ departmentId	string	非必须
├─ departmentName	string	非必须		部门
├─ enableState	integer	非必须		状态 0为禁用 1为启用	format: int32
├─ formOfEmployment	integer	非必须		聘用形式	format: int32
├─ formOfManagement	string	非必须
├─ id	string	非必须		用户id
├─ inServiceStatus	integer	非必须		在职状态 1.在职 2.离职	format: int32
├─ level	string	非必须
├─ mobile	string	非必须		手机号码
├─ password	string	非必须		密码
├─ staffPhoto	string	非必须		头像
├─ timeOfEntry	string	非必须			format: date-time
├─ username	string	非必须		用户名
├─ workNumber	string	非必须		工号
├─ workingCity	string	非必须		工作城市
├─ uss	object	非必须		用户社保参保数据
├─ enterpriseProportion	number	非必须		公积金企业比例
├─ enterpriseProvidentFundPayment	number	非必须		公积金企业缴纳数额
├─ enterprisesPaySocialSecurityThisMonth	integer	非必须		本月是否缴纳社保 0为不缴纳 1为缴纳	format: int32
├─ enterprisesPayTheProvidentFundThisMonth	integer	非必须		本月是否缴纳公积金 0为不缴纳 1为缴纳	format: int32
├─ householdRegistration	string	非必须		户籍
├─ householdRegistrationType	integer	非必须		户籍类型 1为本市城镇 2为本市农村 3为外埠城镇 4为外埠农村	format: int32
├─ industrialInjuryRatio	number	非必须		工伤比例
├─ lastModifyTime	string	非必须		最后修改时间	format: date-time
├─ participatingInTheCity	string	非必须		参保城市
├─ participatingInTheCityId	string	非必须		参保城市id
├─ personalProportion	number	非必须		公积金个人比例
├─ personalProvidentFundPayment	number	非必须		公积金个人缴纳数额
├─ providentFundBase	number	非必须		公积金基数
├─ providentFundCity	string	非必须		公积金城市
├─ providentFundCityId	string	非必须		公积金城市id
├─ providentFundNotes	string	非必须		公积金备注
├─ providentFundSwitchUpdateTime	string	非必须		公积金缴纳变更时间	format: date-time
├─ socialSecurityBase	number	非必须		社保基数
├─ socialSecurityNotes	string	非必须		社保备注
├─ socialSecuritySwitchUpdateTime	string	非必须		社保是否缴纳变更时间	format: date-time
├─ socialSecurityType	integer	非必须		参保类型 1为首次开户 2为非首次开户	format: int32
├─ userId	string	非必须		企业id
message	string	非必须
success	boolean	非必须

社保数据归档

基本信息

Path： /social_securitys/historys/{yearMonth}/archive

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
参保年月		yearMonth
yearMonth

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

设置企业社保配置信息

基本信息

Path： /social_securitys/historys/{yearMonth}/newReport

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
yearMonth		参保年月

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

薪资配置

保存企业工资设置

基本信息

Path： /salarys/company-settings

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
companyId	string	非必须		企业id
dataMonth	string	非必须		查询月份
isSettings	integer	非必须		当月是否设置薪资 0为未设置，1为已设置	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

保存企业计薪及津贴设置

基本信息

Path： /salarys/settings

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
communicationSubsidyAmount	number	非必须		通讯补贴金额
communicationSubsidyScheme	integer	非必须		通讯补贴计算类型 1 : 日 ,3 : 月	format: int32
companyId	string	非必须		企业id
housingSubsidyAmount	number	非必须		住房补助金额
housingSubsidyScheme	integer	非必须		住房补助计算类型	format: int32
lunchAllowanceAmount	number	非必须		午餐补贴金额
lunchAllowanceScheme	integer	非必须		午餐补贴计算类型	format: int32
socialSecurityType	integer	非必须		社保自然月	format: int32
subsidyName	string	非必须		津贴方案名称
subsidyRemark	string	非必须		津贴备注
taxCalculationType	integer	非必须		计税方式	format: int32
transportationSubsidyAmount	number	非必须		交通补贴金额
transportationSubsidyScheme	integer	非必须		交通补贴计算类型	format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

构造新月份工资报表

基本信息

Path： /salarys/reports/{yearMonth}/newReport

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
yearMonth		报表年月

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

获取企业是否设置当月工资

基本信息

Path： /salarys/company-settings

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		企业月薪资配置
├─ companyId	string	非必须		企业id
├─ dataMonth	string	非必须		查询月份
├─ isSettings	integer	非必须		当月是否设置薪资 0为未设置，1为已设置	format: int32
message	string	非必须
success	boolean	非必须

获取企业计薪及津贴设置

基本信息

Path： /salarys/settings

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		企业计薪及津贴设置
├─ communicationSubsidyAmount	number	非必须		通讯补贴金额
├─ communicationSubsidyScheme	integer	非必须		通讯补贴计算类型 1 : 日 ,3 : 月	format: int32
├─ companyId	string	非必须		企业id
├─ housingSubsidyAmount	number	非必须		住房补助金额
├─ housingSubsidyScheme	integer	非必须		住房补助计算类型	format: int32
├─ lunchAllowanceAmount	number	非必须		午餐补贴金额
├─ lunchAllowanceScheme	integer	非必须		午餐补贴计算类型	format: int32
├─ socialSecurityType	integer	非必须		社保自然月	format: int32
├─ subsidyName	string	非必须		津贴方案名称
├─ subsidyRemark	string	非必须		津贴备注
├─ taxCalculationType	integer	非必须		计税方式	format: int32
├─ transportationSubsidyAmount	number	非必须		交通补贴金额
├─ transportationSubsidyScheme	integer	非必须		交通补贴计算类型	format: int32
message	string	非必须
success	boolean	非必须

薪资管理

员工定薪

基本信息

Path： /salarys/init/{userId}

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
userId

Body

名称	类型	是否必须	默认值	备注	其他信息
correctionOfBasicWages	number	非必须		转正基本工资
currentBasicSalary	number	非必须		当前基本工资
currentPostWage	number	非必须		当前岗位工资
fixedBasicSalary	number	非必须		定薪基本工资
fixedPostWage	number	非必须		定薪岗位工资
turnToPostWages	number	非必须		转正岗位工资
userId	string	非必须		用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

查询用户薪资

基本信息

Path： /salarys/modify/{userId}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
userId		用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

查询用户薪资列表

基本信息

Path： /salarys/list

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		分页数据
├─ rows	object []	非必须		分页数据列表	item 类型: object
├─ correctionOfBasicWages	number	非必须		转正基本工资
├─ currentBasicSalary	number	非必须		当前基本工资
├─ currentPostWage	number	非必须		当前岗位工资
├─ fixedBasicSalary	number	非必须		定薪基本工资
├─ fixedPostWage	number	非必须		定薪岗位工资
├─ turnToPostWages	number	非必须		转正岗位工资
├─ userId	string	非必须		用户id
├─ total	integer	非必须		总条数	format: int64
message	string	非必须
success	boolean	非必须

根据年月查询企业用户薪资列表

基本信息

Path： /salarys/reports/{yearMonth}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
yearMonth		年月份

Body

名称	类型	是否必须	默认值	备注	其他信息
	integer	非必须			format: int32

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ apersonOfGreatDisease	number	非必须
├─ archiveId	string	非必须		归档id
├─ attendanceDeductionMonthly	string	非必须		考勤扣款
├─ bankCardNumber	string	非必须		银行卡号
├─ baseSalaryByMonth	number	非必须		当月基本工资基数
├─ baseSalaryToTaxByMonth	number	非必须		当月纳税基本工资
├─ bigDiseaseEnterprise	number	非必须		大病企业缴纳金额
├─ causeOfSalaryAdjustment	string	非必须		调薪原因
├─ childbearingEnterprise	number	非必须		生育企业缴纳金额
├─ currentBaseSalary	number	非必须		最新基本工资基数
├─ currentSalaryTotalBase	number	非必须		最新工资基数合计
├─ departmentName	string	非必须		部门名称
├─ effectiveTimeOfPayAdjustment	string	非必须		调薪生效时间
├─ entTotal	number	非必须
├─ enterpriseLaborCost	number	非必须		企业人工成本
├─ formOfEmployment	string	非必须		聘用形式
├─ id	string	非必须		id
├─ idNumber	string	非必须		身份证号
├─ inServiceStatus	string	非必须		企业id
├─ industrialInjuryEnterprise	number	非必须		工伤企业缴纳金额
├─ medicalEnterprise	number	非必须		医疗企业缴纳金额
├─ medicalIndividual	number	非必须		医疗个人缴纳金额
├─ mobile	string	非必须		手机号
├─ officialSalaryDays	number	非必须		计薪天数
├─ oldAgeIndividual	number	非必须		养老个人缴纳金额
├─ openingBank	string	非必须		开户行
├─ payment	number	非必须		实发工资
├─ paymentBeforeTax	number	非必须		税前实发
├─ paymentMonths	integer	非必须		发薪月数	format: int32
├─ paymentRemark	string	非必须		实发工资备注
├─ pensionEnterprise	number	非必须		养老企业缴纳金额
├─ perTotal	number	非必须
├─ providentFundEnterprises	number	非必须		公积金企业缴纳金额
├─ providentFundIndividual	number	非必须		公积金个人缴纳金额
├─ remark	string	非必须		备注
├─ salary	number	非必须		工资合计
├─ salaryAfterTax	number	非必须		税后工资合计
├─ salaryBeforeTax	number	非必须		税前工资合计
├─ salaryByTax	number	非必须		应纳税工资
├─ salaryChangeAmount	number	非必须		调薪金额
├─ salaryChangeScale	number	非必须		调薪比例
├─ salaryCost	number	非必须		薪酬成本
├─ salaryStandard	number	非必须		计薪标准
├─ socialSecurity	number	非必须		社保扣款缴纳金额
├─ socialSecurityEnterprise	number	非必须		社保企业缴纳金额
├─ socialSecurityIndividual	number	非必须		社保个人缴纳金额
├─ socialSecurityProvidentFundEnterprises	number	非必须		公积金社保企业缴纳金额
├─ tax	number	非必须		应扣税
├─ taxCountingMethod	string	非必须		计税方式
├─ taxToProvidentFund	number	非必须		公积金需纳税额
├─ totalProvidentFundIndividual	number	非必须		公积金扣款个人缴纳金额
├─ unemployedEnterprise	number	非必须		失业企业缴纳金额
├─ unemployedIndividual	number	非必须		失业个人缴纳金额
├─ userId	string	非必须		用户id
├─ username	string	非必须		姓名
├─ workNumber	string	非必须		工号
message	string	非必须
success	boolean	非必须

调薪

基本信息

Path： /salarys/modify/{userId}

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
userId

Body

名称	类型	是否必须	默认值	备注	其他信息
correctionOfBasicWages	number	非必须		转正基本工资
currentBasicSalary	number	非必须		当前基本工资
currentPostWage	number	非必须		当前岗位工资
fixedBasicSalary	number	非必须		定薪基本工资
fixedPostWage	number	非必须		定薪岗位工资
turnToPostWages	number	非必须		转正岗位工资
userId	string	非必须		用户id

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

考勤设置管理

保存加班规则

基本信息

Path： /cfg/extDuty

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
companyId	string	非必须		企业id
dayOffConfigList	object []	非必须		调休规则	item 类型: object
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ latestEffectDate	string	非必须		调休最后有效日期
├─ remarks	string	非必须
├─ unit	string	非必须		调休单位
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
dayOffConfigs	object	非必须		调休规则
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ latestEffectDate	string	非必须		调休最后有效日期
├─ remarks	string	非必须
├─ unit	string	非必须		调休单位
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
departmentId	string	非必须		部门ID
extraDutyConfig	object	非必须
├─ companyId	string	非必须
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ departmentId	string	非必须
├─ id	string	非必须
├─ isClock	integer	非必须			format: int32
├─ isCompensationint	string	非必须
├─ remarks	string	非必须
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ workHoursDay	string	非必须
extraDutyRuleList	object []	非必须		加班规则	item 类型: object
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ isEnable	integer	非必须		是否可用 0开启 1 关闭	format: int32
├─ isTimeOff	integer	非必须		是否调休 0不调休 1调休	format: int32
├─ remarks	string	非必须
├─ rule	string	非必须		规则内容
├─ ruleEndTime	string	非必须		截止时间
├─ ruleStartTime	string	非必须		开始时间
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
isClock	integer	非必须		是否打卡 0开启 1关闭	format: int32
isCompensationint	string	非必须		是否开启加班补偿 0开启 1关闭
latestEffectDate	string	非必须		调休最后有效日期
rules	object []	非必须		加班规则	item 类型: object
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ isEnable	integer	非必须		是否可用 0开启 1 关闭	format: int32
├─ isTimeOff	integer	非必须		是否调休 0不调休 1调休	format: int32
├─ remarks	string	非必须
├─ rule	string	非必须		规则内容
├─ ruleEndTime	string	非必须		截止时间
├─ ruleStartTime	string	非必须		开始时间
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
unit	string	非必须		调休单位
workHoursDay	string	非必须		每日标准工作时长，单位小时

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

保存或者更新请假规则

基本信息

Path： /cfg/leave

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	object []	非必须			item 类型: object
├─ companyId	string	非必须		企业id
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ departmentId	string	非必须		部门ID
├─ id	string	非必须		配置ID
├─ isEnable	integer	非必须		是否开启	format: int32
├─ leaveType	string	非必须		假期类型
├─ remarks	string	非必须
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

保存考勤扣款规则

基本信息

Path： /cfg/deduction

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	object []	非必须			item 类型: object
├─ absenceDays	string	非必须		旷工天数
├─ absenceTimesUpperLimt	string	非必须		旷工次数上限
├─ companyId	string	非必须		企业id
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ dedAmonutLowerLimit	number	非必须		扣款金额下限
├─ dedAmonutUpperLimit	number	非必须		扣款金额上限
├─ dedTypeCode	string	非必须		扣款类型编码
├─ departmentId	string	非必须		部门ID
├─ fineSalaryMultiples	string	非必须		罚款工资倍数
├─ id	string	非必须		配置ID
├─ isAbsenteeism	string	非必须		是否旷工 0不旷工 1旷工
├─ isEnable	integer	非必须		是否可用 0开启 1 关闭	format: int32
├─ periodLowerLimit	string	非必须		迟到时间段下限
├─ periodUpperLimit	string	非必须		迟到时间段上限
├─ remarks	string	非必须
├─ timesLowerLimit	string	非必须		次数下限
├─ timesUpperLimit	string	非必须		次数上限
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

保存考勤设置

基本信息

Path： /cfg/atte

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
afternoonEndTime	string	非必须		下午下班时间
afternoonStartTime	string	非必须		下午上班时间
companyId	string	非必须		企业id
createBy	string	非必须
createDate	string	非必须			format: date-time
departmentId	string	非必须		部门ID
id	string	非必须		配置ID
morningEndTime	string	非必须		上午下班时间
morningStartTime	string	非必须		上午上班时间
remarks	string	非必须
updateBy	string	非必须
updateDate	string	非必须			format: date-time

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

根据部门id查询考勤设置

基本信息

Path： /cfg/atte/item

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		考勤配置
├─ afternoonEndTime	string	非必须		下午下班时间
├─ afternoonStartTime	string	非必须		下午上班时间
├─ companyId	string	非必须		企业id
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ departmentId	string	非必须		部门ID
├─ id	string	非必须		配置ID
├─ morningEndTime	string	非必须		上午下班时间
├─ morningStartTime	string	非必须		上午上班时间
├─ remarks	string	非必须
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
message	string	非必须
success	boolean	非必须

根据部门查询考勤加班规则

基本信息

Path： /cfg/extDuty/item

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		加班调休规则配置
├─ companyId	string	非必须		企业id
├─ dayOffConfigList	object []	非必须		调休规则	item 类型: object
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ latestEffectDate	string	非必须		调休最后有效日期
├─ remarks	string	非必须
├─ unit	string	非必须		调休单位
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ dayOffConfigs	object	非必须		调休规则
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ latestEffectDate	string	非必须		调休最后有效日期
├─ remarks	string	非必须
├─ unit	string	非必须		调休单位
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ departmentId	string	非必须		部门ID
├─ extraDutyConfig	object	非必须
├─ companyId	string	非必须
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ departmentId	string	非必须
├─ id	string	非必须
├─ isClock	integer	非必须			format: int32
├─ isCompensationint	string	非必须
├─ remarks	string	非必须
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ workHoursDay	string	非必须
├─ extraDutyRuleList	object []	非必须		加班规则	item 类型: object
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ isEnable	integer	非必须		是否可用 0开启 1 关闭	format: int32
├─ isTimeOff	integer	非必须		是否调休 0不调休 1调休	format: int32
├─ remarks	string	非必须
├─ rule	string	非必须		规则内容
├─ ruleEndTime	string	非必须		截止时间
├─ ruleStartTime	string	非必须		开始时间
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ isClock	integer	非必须		是否打卡 0开启 1关闭	format: int32
├─ isCompensationint	string	非必须		是否开启加班补偿 0开启 1关闭
├─ latestEffectDate	string	非必须		调休最后有效日期
├─ rules	object []	非必须		加班规则	item 类型: object
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ isEnable	integer	非必须		是否可用 0开启 1 关闭	format: int32
├─ isTimeOff	integer	非必须		是否调休 0不调休 1调休	format: int32
├─ remarks	string	非必须
├─ rule	string	非必须		规则内容
├─ ruleEndTime	string	非必须		截止时间
├─ ruleStartTime	string	非必须		开始时间
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ unit	string	非必须		调休单位
├─ workHoursDay	string	非必须		每日标准工作时长，单位小时
message	string	非必须
success	boolean	非必须

根据部门查询考勤扣款规则

基本信息

Path： /cfg/ded/list

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ absenceDays	string	非必须		旷工天数
├─ absenceTimesUpperLimt	string	非必须		旷工次数上限
├─ companyId	string	非必须		企业id
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ dedAmonutLowerLimit	number	非必须		扣款金额下限
├─ dedAmonutUpperLimit	number	非必须		扣款金额上限
├─ dedTypeCode	string	非必须		扣款类型编码
├─ departmentId	string	非必须		部门ID
├─ fineSalaryMultiples	string	非必须		罚款工资倍数
├─ id	string	非必须		配置ID
├─ isAbsenteeism	string	非必须		是否旷工 0不旷工 1旷工
├─ isEnable	integer	非必须		是否可用 0开启 1 关闭	format: int32
├─ periodLowerLimit	string	非必须		迟到时间段下限
├─ periodUpperLimit	string	非必须		迟到时间段上限
├─ remarks	string	非必须
├─ timesLowerLimit	string	非必须		次数下限
├─ timesUpperLimit	string	非必须		次数上限
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
message	string	非必须
success	boolean	非必须

根据部门查询请假规则设置

基本信息

Path： /cfg/leave/list

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ companyId	string	非必须		企业id
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ departmentId	string	非必须		部门ID
├─ id	string	非必须		配置ID
├─ isEnable	integer	非必须		是否开启	format: int32
├─ leaveType	string	非必须		假期类型
├─ remarks	string	非必须
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
message	string	非必须
success	boolean	非必须

考勤管理

上传考勤打卡数据

基本信息

Path： /attendances/import

Method： POST

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

参数名称	参数类型	是否必须	示例	备注
file	file	是		考勤数据报表

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

归档历史列表

基本信息

Path： /attendances/reports/year

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ archiveMonth	string	非必须		归档月
├─ archiveYear	string	非必须		归档年
├─ companyId	string	非必须		企业ID
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ departmentId	string	非必须		部门ID
├─ fullAttePeopleNum	integer	非必须		全勤人数	format: int32
├─ id	string	非必须		归档ID
├─ isArchived	integer	非必须		是否归档 0已经归档 1没有归档	format: int32
├─ remarks	string	非必须
├─ totalPeopleNum	integer	非必须		总人数	format: int32
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
message	string	非必须
success	boolean	非必须

新建考勤报表

基本信息

Path： /attendances/newReports

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

月度考勤记录归档

基本信息

Path： /attendances/archives

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

查询归档详情

基本信息

Path： /attendances/reports/{id}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id		归档历史ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ abortionLeaveDays	string	非必须		流产假天数
├─ absenceDays	string	非必须		旷工天数
├─ accidentialLeaveDays	string	非必须		工伤假
├─ actualAtteOfficialDays	string	非必须		实际出勤天数（正式）
├─ actualAtteUnofficialDays	string	非必须		实际出勤天数（非正式）
├─ archiveDate	string	非必须		归档日期
├─ atteArchiveMonthlyId	string	非必须		归档id
├─ atteSolution	string	非必须		当月考勤方案
├─ clockRate	string	非必须		打卡率
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ dayOffLeaveDays	string	非必须		调休天数
├─ department	string	非必须		级部门
├─ doctorOffLeaveDays	string	非必须		产检假
├─ earlyTimes	string	非必须		早退次数
├─ funeralLeaveDays	string	非必须		丧假天数
├─ homeLeavaDays	string	非必须		探亲假
├─ hoursPerDays	string	非必须		日均时长（自然日）
├─ hoursPerRestDay	string	非必须		日均时长（休息日）
├─ hoursPerWorkDay	string	非必须		日均时长(工作日)
├─ id	string	非必须		id
├─ isFullAttendanceint	integer	非必须		是否全勤 0全勤 1非全勤	format: int32
├─ laterTimes	string	非必须		迟到次数
├─ leaveDays	string	非必须		事假天数
├─ longSickLeaveDays	string	非必须		长期病假天数
├─ marraiageLeaveDays	string	非必须		婚假天数
├─ maternityLeaveDays	string	非必须		产假
├─ mobile	string	非必须		手机号
├─ name	string	非必须		姓名
├─ normalDays	string	非必须		正常天数
├─ onBusinessDays	string	非必须		出差天数
├─ outgoingDays	string	非必须		外出天数
├─ paternityLeaveDays	string	非必须		陪产假
├─ remarks	string	非必须
├─ rewardMaternityLeaveDays	string	非必须		奖励产假天数
├─ salaryAdjustmentDays	string	非必须		计薪天数调整
├─ salaryOfficialDays	string	非必须		计薪天数（正式）
├─ salaryStandards	string	非必须		计薪标准
├─ salaryUnofficialDays	string	非必须		计薪天数（非正式）
├─ sickLeaveDays	string	非必须		病假天数
├─ signedTimes	integer	非必须		迟到次数	format: int32
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ userId	string	非必须		用户ID
├─ workCity	string	非必须		工作城市
├─ workHour	string	非必须		工作时长
├─ workNumber	string	非必须		工号
├─ workingDays	string	非必须		应出勤工作日
├─ yearLeaveDays	string	非必须		年假天数
message	string	非必须
success	boolean	非必须

查询考勤数据列表

基本信息

Path： /attendances

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Query

参数名称	是否必须	示例	备注
page	是		页码
pagesize	是		每页条数

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		考勤数据列表
├─ data	object	非必须
├─ counts	integer	非必须			format: int32
├─ isArchived	integer	非必须			format: int32
├─ items	object []	非必须			item 类型: object
├─ attendanceRecord	object []	非必须		考勤记录	item 类型: object
├─ adtInCoordinate	string	非必须		考勤坐标
├─ adtInHourse	string	非必须		考勤办公室
├─ adtInPlace	string	非必须		考勤地点
├─ adtInTime	string	非必须		上班考勤时间	format: date-time
├─ adtOutHourse	string	非必须		考勤办公室
├─ adtOutPlace	string	非必须		下班考情地点
├─ adtOutTime	string	非必须		下班考勤时间	format: date-time
├─ adtStatu	integer	非必须		考情状态 1正常 2旷工 3迟到 4早退 5外出 6出差 7年假 8事假 9病假 10婚假 11丧假 12产假 13奖励产假 14陪产假 15探亲假 16工伤假 17调休 18产检假 19流产假 20长期病假 21测试架 22补签	format: int32
├─ companyId	string	非必须		企业id
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ day	string	非必须		考勤日期
├─ departmentId	string	非必须		部门ID
├─ id	string	非必须		考勤ID
├─ jobStatu	integer	非必须		职位状态 1在职2离职	format: int64
├─ remarks	string	非必须
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ userId	string	非必须		用户ID
├─ departmentId	string	非必须		部门ID
├─ departmentName	string	非必须		部门
├─ id	string	非必须		编号id
├─ mobile	string	非必须		手机
├─ username	string	非必须		用户名
├─ workNumber	string	非必须		工号
├─ page	integer	非必须			format: int32
├─ pageSize	integer	非必须			format: int32
├─ pages	integer	非必须			format: int32
├─ totals	object	非必须
├─ monthOfReport	integer	非必须			format: int32
├─ tobeTaskCount	integer	非必须			format: int32
├─ monthOfReport	integer	非必须		当前考勤的月份	format: int32
├─ tobeTaskCount	integer	非必须		待处理的考勤数量	format: int32
message	string	非必须
success	boolean	非必须

根据用户id和月份查询已归档的考勤明细

基本信息

Path： /attendances/archive/{userId}/{yearMonth}

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
userId		用户ID
yearMonth		月份

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须		归档月考勤明细记录
├─ abortionLeaveDays	string	非必须		流产假天数
├─ absenceDays	string	非必须		旷工天数
├─ accidentialLeaveDays	string	非必须		工伤假
├─ actualAtteOfficialDays	string	非必须		实际出勤天数（正式）
├─ actualAtteUnofficialDays	string	非必须		实际出勤天数（非正式）
├─ archiveDate	string	非必须		归档日期
├─ atteArchiveMonthlyId	string	非必须		归档id
├─ atteSolution	string	非必须		当月考勤方案
├─ clockRate	string	非必须		打卡率
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ dayOffLeaveDays	string	非必须		调休天数
├─ department	string	非必须		级部门
├─ doctorOffLeaveDays	string	非必须		产检假
├─ earlyTimes	string	非必须		早退次数
├─ funeralLeaveDays	string	非必须		丧假天数
├─ homeLeavaDays	string	非必须		探亲假
├─ hoursPerDays	string	非必须		日均时长（自然日）
├─ hoursPerRestDay	string	非必须		日均时长（休息日）
├─ hoursPerWorkDay	string	非必须		日均时长(工作日)
├─ id	string	非必须		id
├─ isFullAttendanceint	integer	非必须		是否全勤 0全勤 1非全勤	format: int32
├─ laterTimes	string	非必须		迟到次数
├─ leaveDays	string	非必须		事假天数
├─ longSickLeaveDays	string	非必须		长期病假天数
├─ marraiageLeaveDays	string	非必须		婚假天数
├─ maternityLeaveDays	string	非必须		产假
├─ mobile	string	非必须		手机号
├─ name	string	非必须		姓名
├─ normalDays	string	非必须		正常天数
├─ onBusinessDays	string	非必须		出差天数
├─ outgoingDays	string	非必须		外出天数
├─ paternityLeaveDays	string	非必须		陪产假
├─ remarks	string	非必须
├─ rewardMaternityLeaveDays	string	非必须		奖励产假天数
├─ salaryAdjustmentDays	string	非必须		计薪天数调整
├─ salaryOfficialDays	string	非必须		计薪天数（正式）
├─ salaryStandards	string	非必须		计薪标准
├─ salaryUnofficialDays	string	非必须		计薪天数（非正式）
├─ sickLeaveDays	string	非必须		病假天数
├─ signedTimes	integer	非必须		迟到次数	format: int32
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ userId	string	非必须		用户ID
├─ workCity	string	非必须		工作城市
├─ workHour	string	非必须		工作时长
├─ workNumber	string	非必须		工号
├─ workingDays	string	非必须		应出勤工作日
├─ yearLeaveDays	string	非必须		年假天数
message	string	非必须
success	boolean	非必须

编辑用户的考勤记录

基本信息

Path： /attendances/{id}

Method： PUT

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

路径参数

参数名称	示例	备注
id

Body

名称	类型	是否必须	默认值	备注	其他信息
adtInCoordinate	string	非必须		考勤坐标
adtInHourse	string	非必须		考勤办公室
adtInPlace	string	非必须		考勤地点
adtInTime	string	非必须		上班考勤时间	format: date-time
adtOutHourse	string	非必须		考勤办公室
adtOutPlace	string	非必须		下班考情地点
adtOutTime	string	非必须		下班考勤时间	format: date-time
adtStatu	integer	非必须		考情状态 1正常 2旷工 3迟到 4早退 5外出 6出差 7年假 8事假 9病假 10婚假 11丧假 12产假 13奖励产假 14陪产假 15探亲假 16工伤假 17调休 18产检假 19流产假 20长期病假 21测试架 22补签	format: int32
companyId	string	非必须		企业id
createBy	string	非必须
createDate	string	非必须			format: date-time
day	string	非必须		考勤日期
departmentId	string	非必须		部门ID
id	string	非必须		考勤ID
jobStatu	integer	非必须		职位状态 1在职2离职	format: int64
remarks	string	非必须
updateBy	string	非必须
updateDate	string	非必须			format: date-time
userId	string	非必须		用户ID

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object	非必须
message	string	非必须
success	boolean	非必须

获取月考勤报表数据

基本信息

Path： /attendances/reports

Method： GET

接口描述：
undefined

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Authorization		是	Bearer b31747f8-7344-4d4a-a1b2-ad0b22dfda19	携带token 注意token和Bearer之间的空格

Body

名称	类型	是否必须	默认值	备注	其他信息
	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须			format: int32
data	object []	非必须			item 类型: object
├─ abortionLeaveDays	string	非必须		流产假天数
├─ absenceDays	string	非必须		旷工天数
├─ accidentialLeaveDays	string	非必须		工伤假
├─ actualAtteOfficialDays	string	非必须		实际出勤天数（正式）
├─ actualAtteUnofficialDays	string	非必须		实际出勤天数（非正式）
├─ archiveDate	string	非必须		归档日期
├─ atteArchiveMonthlyId	string	非必须		归档id
├─ atteSolution	string	非必须		当月考勤方案
├─ clockRate	string	非必须		打卡率
├─ createBy	string	非必须
├─ createDate	string	非必须			format: date-time
├─ dayOffLeaveDays	string	非必须		调休天数
├─ department	string	非必须		级部门
├─ doctorOffLeaveDays	string	非必须		产检假
├─ earlyTimes	string	非必须		早退次数
├─ funeralLeaveDays	string	非必须		丧假天数
├─ homeLeavaDays	string	非必须		探亲假
├─ hoursPerDays	string	非必须		日均时长（自然日）
├─ hoursPerRestDay	string	非必须		日均时长（休息日）
├─ hoursPerWorkDay	string	非必须		日均时长(工作日)
├─ id	string	非必须		id
├─ isFullAttendanceint	integer	非必须		是否全勤 0全勤 1非全勤	format: int32
├─ laterTimes	string	非必须		迟到次数
├─ leaveDays	string	非必须		事假天数
├─ longSickLeaveDays	string	非必须		长期病假天数
├─ marraiageLeaveDays	string	非必须		婚假天数
├─ maternityLeaveDays	string	非必须		产假
├─ mobile	string	非必须		手机号
├─ name	string	非必须		姓名
├─ normalDays	string	非必须		正常天数
├─ onBusinessDays	string	非必须		出差天数
├─ outgoingDays	string	非必须		外出天数
├─ paternityLeaveDays	string	非必须		陪产假
├─ remarks	string	非必须
├─ rewardMaternityLeaveDays	string	非必须		奖励产假天数
├─ salaryAdjustmentDays	string	非必须		计薪天数调整
├─ salaryOfficialDays	string	非必须		计薪天数（正式）
├─ salaryStandards	string	非必须		计薪标准
├─ salaryUnofficialDays	string	非必须		计薪天数（非正式）
├─ sickLeaveDays	string	非必须		病假天数
├─ signedTimes	integer	非必须		迟到次数	format: int32
├─ updateBy	string	非必须
├─ updateDate	string	非必须			format: date-time
├─ userId	string	非必须		用户ID
├─ workCity	string	非必须		工作城市
├─ workHour	string	非必须		工作时长
├─ workNumber	string	非必须		工号
├─ workingDays	string	非必须		应出勤工作日
├─ yearLeaveDays	string	非必须		年假天数
message	string	非必须
success	boolean	非必须