返回 API 文档索引

lwc-cloud-erp-hr API 接口文档

lwc-cloud-erp-hr 版本 3.0.9 54 个接口 7 个分组 70 个模型 来源: https://api.leadwaycloud.com/lwc-cloud-erp-hr/v3/api-docs

服务地址

地址说明
http://localhost:8080开发环境
https://api.leadwaycloud.com测试环境

接口详情

PUT

/api/shift/update/{id}

班次管理 排班方案-编辑排班 OperationId: update

调用方法

PUT /api/shift/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: ShiftScheduleDTO$UpdateDTO com.leadwaycloud.hr.model.dto.shift.ShiftScheduleDTO$UpdateDTO

名称类型必填说明示例
codestring方案编码
namestring方案名称
notestring备注

响应

状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/api/hr/position/update/{id}

职位管理 编辑职位 OperationId: update_1

调用方法

PUT /api/hr/position/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)主键ID0

请求体

Content-Type: application/json 必填:类型: PositionDTO$UpdateDTO com.leadwaycloud.hr.model.dto.PositionDTO$UpdateDTO

名称类型必填说明示例
namestring名称
parentIdinteger(int64)上一级ID
phonestring电话
faxstring传真
emailstring邮箱
notestring备注
externalCodestring外部编号
codestring编号
statusstring状态"ACTIVE"

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrPosition com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrPosition

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrPosition
PUT

/api/hr/employee/update/{id}

员工管理 编辑员工 OperationId: update_2

调用方法

PUT /api/hr/employee/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)员工ID0

请求体

Content-Type: application/json 必填:类型: EmployeeDTO$UpdateDTO com.leadwaycloud.hr.model.dto.EmployeeDTO$UpdateDTO

名称类型必填说明示例
codestring编号
nationalitystring民族
domicilestring户籍
statusstring状态"PERIOD_OF_PROBATION"
entryDatestring(date)入职日期"2020-10-11"
positiveDatestring(date)转正日期"2020-10-11"
resignDatestring(date)离职日期"2020-10-11"
bankCardstring银行卡
bankCardNumstring银行卡号
parentIdinteger(int64)上一级ID
externalCodestring外部编号
namestring名称
imagestring头像
birthdaystring(date)出生日期
sexstring性别
bankstring银行(名),sys_property获取
contactContactDTO$UpdateDTO
positionDepartmentDTOListPositionDepartmentDTO[]部门职位对象集合

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrEmployee com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrEmployee

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployee
PUT

/api/hr/department/updateBingStockWarehouse/{id}

部门管理 编辑部门绑定仓库 OperationId: updateBingStockWarehouse

调用方法

PUT /api/hr/department/updateBingStockWarehouse/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)部门ID0
stockWarehouseIdListquerystring仓库ID集合0

请求体

Content-Type: application/json 必填:类型: integer(int64)[]

名称类型必填说明示例
(array)integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/api/hr/department/updateBingGoodsCategory/{id}

部门管理 编辑部门绑定商品类型 OperationId: updateBingGoodsCategory

调用方法

PUT /api/hr/department/updateBingGoodsCategory/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)部门ID0
goodsCategoryIdListquerystring产品类型ID集合[0,1,2]

请求体

Content-Type: application/json 必填:类型: integer(int64)[]

名称类型必填说明示例
(array)integer(int64)[]

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
PUT

/api/hr/department/update/{id}

部门管理 编辑部门 OperationId: update_3

调用方法

PUT /api/hr/department/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)部门ID0

请求体

Content-Type: application/json 必填:类型: DepartmentDTO$UpdateDTO com.leadwaycloud.hr.model.dto.DepartmentDTO$UpdateDTO

名称类型必填说明示例
namestring名称
parentIdinteger(int64)上一级ID
phonestring电话
faxstring传真
emailstring邮箱
notestring备注
externalCodestring外部编号
codestring编号
statusstring状态"ACTIVE"
shortNamestring简称

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrDepartment com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrDepartment

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrDepartment
PUT

/api/hr/calendarSchedule/update/{id}

日历日程管理 编辑日历日程 OperationId: update_4

调用方法

PUT /api/hr/calendarSchedule/update/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)日历日程ID0

请求体

Content-Type: application/json 必填:类型: CalendarScheduleDTO$UpdateDTO com.leadwaycloud.hr.model.dto.CalendarScheduleDTO$UpdateDTO

名称类型必填说明示例
companyListinteger(int64)[]公司ID
typestring类型(WEEKEND:周末 TAKE:调休 HOLIDAY:节假日)
bigAndSmallboolean是否大小周
wageinteger(int32)薪资倍数
startDatestring(date)开始日期"2024-01-02"
endDatestring(date)结束日期"2020-10-11"
repeatstring重复类型 NONE:无 DAY:每天 WEEK:每周 MONTH:每月 YEAR:每年"NONE"
weekDayinteger(int32)每周周几(1,2,3,4,5,6,7)
monthDayinteger(int32)每月几号(1,2,3...31)
yearDaystring每年的几月几号(01-01)
contentstring日程内容
attachmentstring自定义数据(json格式)

响应

状态码: 200 说明: OK Content-Type: */* 类型: CalendarSchedule com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.calendar.schedule.CalendarSchedule

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataCalendarSchedule
PUT

/api/dining/updateTicketType/{ticketTypeId}

餐食 修改餐票类型 OperationId: updateTicketType

调用方法

PUT /api/dining/updateTicketType/{ticketTypeId}

参数

名称位置必填类型说明示例
ticketTypeIdpathinteger(int64)餐票类型ID

请求体

Content-Type: application/json 必填:类型: DiningDTO$UpdateTicketTypeDTO com.leadwaycloud.hr.model.dto.DiningDTO$UpdateTicketTypeDTO

名称类型必填说明示例
namestring
imagestring
stylestring
predictEndTimeLocalTime
validStartTimeLocalTime
validEndTimeLocalTime
statusstringACTIVE:可用 VOID:作废

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningTicketType com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.dining.DiningTicketType

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicketType
PUT

/api/dining/updateCanteen/{canteenId}

餐食 修改食堂信息 OperationId: updateTicketType_1

调用方法

PUT /api/dining/updateCanteen/{canteenId}

参数

名称位置必填类型说明示例
canteenIdpathinteger(int64)食堂ID

请求体

Content-Type: application/json 必填:类型: DiningDTO$UpdateCanteenDTO com.leadwaycloud.hr.model.dto.DiningDTO$UpdateCanteenDTO

名称类型必填说明示例
namestring
imagestring
statusstring

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningCanteen com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.dining.DiningCanteen

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningCanteen
PUT

/api/dining/destroyTicket/{ticketId}

餐食 餐票核销 OperationId: destoryTicket

调用方法

PUT /api/dining/destroyTicket/{ticketId}

参数

名称位置必填类型说明示例
ticketIdpathinteger(int64)餐票ID

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
POST

/api/shift/version/statusChange/{shiftScheduleVersionId}

班次管理 版本-状态变更 OperationId: versionStatusChange

调用方法

POST /api/shift/version/statusChange/{shiftScheduleVersionId}

参数

名称位置必填类型说明示例
shiftScheduleVersionIdpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: ShiftScheduleDTO$StatusChangeDTO com.leadwaycloud.hr.model.dto.shift.ShiftScheduleDTO$StatusChangeDTO

名称类型必填说明示例
statusstring状态

响应

状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
POST

/api/shift/version/copy/{shiftScheduleVersionId}

班次管理 版本-复制 OperationId: copyVersion

调用方法

POST /api/shift/version/copy/{shiftScheduleVersionId}

参数

名称位置必填类型说明示例
shiftScheduleVersionIdpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.lang.Long

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
datainteger(int64)返回数据
POST

/api/shift/version/add/{shiftScheduleId}

班次管理 版本-创建 OperationId: createVersion

调用方法

POST /api/shift/version/add/{shiftScheduleId}

参数

名称位置必填类型说明示例
shiftScheduleIdpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.lang.Long

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
datainteger(int64)返回数据
POST

/api/shift/statusChange/{id}

班次管理 排班方案-状态变更 OperationId: statusChange

调用方法

POST /api/shift/statusChange/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: ShiftScheduleDTO$StatusChangeDTO com.leadwaycloud.hr.model.dto.shift.ShiftScheduleDTO$StatusChangeDTO

名称类型必填说明示例
statusstring状态

响应

状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
POST

/api/shift/item/update/{shiftScheduleItemId}

班次管理 班次-编辑 OperationId: updateItem

调用方法

POST /api/shift/item/update/{shiftScheduleItemId}

参数

名称位置必填类型说明示例
shiftScheduleItemIdpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: ShiftScheduleItemDTO$UpdateDTO com.leadwaycloud.hr.model.dto.shift.ShiftScheduleItemDTO$UpdateDTO

名称类型必填说明示例
codestring班次编码
namestring班次名称
nointeger(int32)排序号
totalWorkHoursnumber总工时
timeSegmentListShiftScheduleItemDTO$TimeSegmentDTO

响应

状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
POST

/api/shift/item/add/{versionId}

班次管理 班次-新增 OperationId: addItem

调用方法

POST /api/shift/item/add/{versionId}

参数

名称位置必填类型说明示例
versionIdpathinteger(int64)

请求体

Content-Type: application/json 必填:类型: ShiftScheduleItemDTO$AddDTO com.leadwaycloud.hr.model.dto.shift.ShiftScheduleItemDTO$AddDTO

名称类型必填说明示例
codestring班次编码
namestring班次名称
nointeger(int32)排序号
totalWorkHoursnumber总工时
timeSegmentListShiftScheduleItemDTO$TimeSegmentDTO

响应

状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.lang.Long

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
datainteger(int64)返回数据
POST

/api/shift/add

班次管理 排班方案-添加 OperationId: add

调用方法

POST /api/shift/add

参数

请求体

Content-Type: application/json 必填:类型: ShiftScheduleDTO$AddDTO com.leadwaycloud.hr.model.dto.shift.ShiftScheduleDTO$AddDTO

名称类型必填说明示例
merchantIdinteger(int64)商户ID
companyIdinteger(int64)公司ID
codestring方案编码
namestring方案名称
notestring备注

响应

状态码: 200 说明: OK Content-Type: */* 类型: Long com.leadwaycloud.core.model.RJava.lang.Long

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
datainteger(int64)返回数据
POST

/api/hr/position/add

职位管理 添加职位 OperationId: add_1

调用方法

POST /api/hr/position/add

参数

请求体

Content-Type: application/json 必填:类型: PositionDTO$AddDTO com.leadwaycloud.hr.model.dto.PositionDTO$AddDTO

名称类型必填说明示例
namestring名称
parentIdinteger(int64)上一级ID
notestring备注
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
externalCodestring外部编号
codestring编号

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrPosition com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrPosition

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrPosition
POST

/api/hr/employee/add

员工管理 添加员工 OperationId: add_2

调用方法

POST /api/hr/employee/add

参数

请求体

Content-Type: application/json 必填:类型: EmployeeDTO$AddDTO com.leadwaycloud.hr.model.dto.EmployeeDTO$AddDTO

名称类型必填说明示例
codestring编号
nationalitystring民族
domicilestring户籍
statusstring状态"PERIOD_OF_PROBATION"
entryDatestring(date)入职日期"2020-10-11"
positiveDatestring(date)转正日期"2020-10-11"
resignDatestring(date)离职日期"2020-10-11"
bankCardstring开户行
bankCardNumstring银行卡号
parentIdinteger(int64)上一级ID
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
externalCodestring外部编号
namestring名称
imagestring头像
birthdaystring(date)出生日期
sexstring性别
bankstring银行(名),sys_property获取
partnerIdinteger(int64)CRM关系ID
contactContactDTO$AddDTO
positionDepartmentDTOListPositionDepartmentDTO[]部门职位对象集合

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrEmployee com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrEmployee

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployee
POST

/api/hr/employee/addUserEmployee/{userId}

员工管理 添加用户员工 OperationId: addEmployeeUser

调用方法

POST /api/hr/employee/addUserEmployee/{userId}

参数

名称位置必填类型说明示例
userIdpathinteger(int64)用户ID1

请求体

Content-Type: application/json 必填:类型: EmployeeDTO$AddDTO com.leadwaycloud.hr.model.dto.EmployeeDTO$AddDTO

名称类型必填说明示例
codestring编号
nationalitystring民族
domicilestring户籍
statusstring状态"PERIOD_OF_PROBATION"
entryDatestring(date)入职日期"2020-10-11"
positiveDatestring(date)转正日期"2020-10-11"
resignDatestring(date)离职日期"2020-10-11"
bankCardstring开户行
bankCardNumstring银行卡号
parentIdinteger(int64)上一级ID
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
externalCodestring外部编号
namestring名称
imagestring头像
birthdaystring(date)出生日期
sexstring性别
bankstring银行(名),sys_property获取
partnerIdinteger(int64)CRM关系ID
contactContactDTO$AddDTO
positionDepartmentDTOListPositionDepartmentDTO[]部门职位对象集合

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrEmployee com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrEmployee

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployee
POST

/api/hr/department/add

部门管理 添加部门 OperationId: add_3

调用方法

POST /api/hr/department/add

参数

请求体

Content-Type: application/json 必填:类型: DepartmentDTO$AddDTO com.leadwaycloud.hr.model.dto.DepartmentDTO$AddDTO

名称类型必填说明示例
namestring名称
parentIdinteger(int64)上一级ID
phonestring电话
faxstring传真
emailstring邮箱
notestring备注
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
externalCodestring外部编号
codestring编号
shortNamestring简称

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrDepartment com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrDepartment

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrDepartment
POST

/api/hr/calendarSchedule/add

日历日程管理 添加日历日程 OperationId: add_4

调用方法

POST /api/hr/calendarSchedule/add

参数

请求体

Content-Type: application/json 必填:类型: CalendarScheduleDTO$AddDTO com.leadwaycloud.hr.model.dto.CalendarScheduleDTO$AddDTO

名称类型必填说明示例
companyIdinteger(int64)公司ID
typestring类型(WEEKEND:周末 TAKE:调休 HOLIDAY:节假日)
bigAndSmallboolean是否大小周
wageinteger(int32)薪资倍数
startDatestring(date)开始日期"2024-01-02"
endDatestring(date)结束日期"2020-10-11"
repeatstring重复类型 NONE:无 DAY:每天 WEEK:每周 MONTH:每月 YEAR:每年"NONE"
weekDayinteger(int32)每周周几(1,2,3,4,5,6,7)
monthDayinteger(int32)每月几号(1,2,3...31)
yearDaystring每年的几月几号(01-01)
contentstring日程内容
attachmentstring自定义数据(json格式)

响应

状态码: 200 说明: OK Content-Type: */* 类型: CalendarSchedule com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.calendar.schedule.CalendarSchedule

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataCalendarSchedule
POST

/api/dining/manualTicket

餐食 手工发放餐票 OperationId: manualTicket

调用方法

POST /api/dining/manualTicket

参数

请求体

Content-Type: application/json 必填:类型: DiningDTO$ManualTicketDTO com.leadwaycloud.hr.model.dto.DiningDTO$ManualTicketDTO

名称类型必填说明示例
canteenIdinteger(int64)
datestring(date)
ticketTypeIdinteger(int64)
userIdListinteger(int64)

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningTicket com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.dining.DiningTicket

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicket[]返回数据
POST

/api/dining/applyTicket

餐食 领取餐票 OperationId: applyTicket

调用方法

POST /api/dining/applyTicket

参数

请求体

Content-Type: application/json 必填:类型: DiningDTO$ApplyTicketDTO com.leadwaycloud.hr.model.dto.DiningDTO$ApplyTicketDTO

名称类型必填说明示例
canteenIdinteger(int64)食堂ID
datestring(date)使用日期
ticketTypeIdListinteger(int64)[]餐食票类型ID集合

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningTicket com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.dining.DiningTicket

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicket[]返回数据
POST

/api/dining/addTicketType

餐食 添加餐票类型 OperationId: addTicketType

调用方法

POST /api/dining/addTicketType

参数

请求体

Content-Type: application/json 必填:类型: DiningDTO$AddTicketTypeDTO com.leadwaycloud.hr.model.dto.DiningDTO$AddTicketTypeDTO

名称类型必填说明示例
namestring名称
imagestring图片
stylestring样式
predictEndTimeLocalTime
validStartTimeLocalTime
validEndTimeLocalTime

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningTicketType com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.dining.DiningTicketType

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicketType
POST

/api/dining/addCanteen

餐食 添加食堂 OperationId: addTicketType_1

调用方法

POST /api/dining/addCanteen

参数

请求体

Content-Type: application/json 必填:类型: DiningDTO$AddCanteenDTO com.leadwaycloud.hr.model.dto.DiningDTO$AddCanteenDTO

名称类型必填说明示例
codestring
namestring
imagestring

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningCanteen com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.dining.DiningCanteen

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningCanteen
GET

/api/shift/page

班次管理 排班方案-分页 OperationId: page

调用方法

GET /api/shift/page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
codequerystring方案编码
namequerystring方案名称
statusquerystring状态 【 DRAFT : ACTIVE : DEACTIVATE : DELETE : 】

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: ShiftScheduleVO$ListVO com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.hr.model.vo.shift.ShiftScheduleVO$ListVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataShiftScheduleVO$ListVO
GET

/api/shift/list

班次管理 排班方案-列表 OperationId: list

调用方法

GET /api/shift/list

参数

名称位置必填类型说明示例
codequerystring方案编码
namequerystring方案名称
statusquerystring状态 【 DRAFT : ACTIVE : DEACTIVATE : DELETE : 】

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: ShiftScheduleVO$DetailVO com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.vo.shift.ShiftScheduleVO$DetailVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataShiftScheduleVO$DetailVO[]返回数据
GET

/api/shift/get/{id}

班次管理 排班方案-详情 OperationId: get

调用方法

GET /api/shift/get/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)排班方案ID

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: ShiftScheduleVO$DetailVO com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.vo.shift.ShiftScheduleVO$DetailVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataShiftScheduleVO$DetailVO
GET

/api/monitor/version

服务监控管理 获取服务版本信息 OperationId: version

调用方法

GET /api/monitor/version

参数

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
GET

/api/monitor/health

服务监控管理 心跳检查 OperationId: health

调用方法

GET /api/monitor/health

参数

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
GET

/api/hr/position/list

职位管理 查询职位列表 OperationId: list_1

调用方法

GET /api/hr/position/list

参数

名称位置必填类型说明示例
companyIdqueryinteger(int64)公司ID

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrPosition com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.hr.HrPosition

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrPosition[]返回数据
GET

/api/hr/position/get/{id}

职位管理 查询职位详情 OperationId: get_1

调用方法

GET /api/hr/position/get/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)主键ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrPosition com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrPosition

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrPosition
GET

/api/hr/employee/queryUserEmployee/{userId}

员工管理 查询用户员工信息 OperationId: queryUserEmployee

调用方法

GET /api/hr/employee/queryUserEmployee/{userId}

参数

名称位置必填类型说明示例
userIdpathinteger(int64)用户ID1

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrEmployee com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrEmployee

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployee
GET

/api/hr/employee/queryByPositionId/{positionId}

员工管理 查询职位下的员工列表 OperationId: queryByPositionId

调用方法

GET /api/hr/employee/queryByPositionId/{positionId}

参数

名称位置必填类型说明示例
positionIdpathinteger(int64)职位ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrEmployeeDepartmentPosition com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.hr.HrEmployeeDepartmentPosition

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployeeDepartmentPosition[]返回数据
GET

/api/hr/employee/queryByDepartmentId/{departmentId}

员工管理 查询部门下的员工列表 OperationId: queryByDepartmentId

调用方法

GET /api/hr/employee/queryByDepartmentId/{departmentId}

参数

名称位置必填类型说明示例
departmentIdpathinteger(int64)部门ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrEmployeeDepartmentPosition com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.hr.HrEmployeeDepartmentPosition

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployeeDepartmentPosition[]返回数据
GET

/api/hr/employee/page

员工管理 查询员工列表 OperationId: page_1

调用方法

GET /api/hr/employee/page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
companyIdqueryinteger(int64)公司ID
codequerystring编号
nationalityquerystring民族
domicilequerystring户籍
statusListquerystring状态"PERIOD_OF_PROBATION"
parentIdqueryinteger(int64)上一级ID
externalCodequerystring外部编号
namequerystring名称
companyIdListqueryinteger(int64)[]
queryAssociateUserqueryboolean查询关联用户

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrEmployee com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.hr.model.entity.hr.HrEmployee

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployee
GET

/api/hr/employee/get/{id}

员工管理 查询员工详情 OperationId: get_2

调用方法

GET /api/hr/employee/get/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)员工ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrEmployee com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrEmployee

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployee
GET

/api/hr/department/queryStockWarehouse/{id}

部门管理 查询部门下的仓库 OperationId: queryStockWarehouse

调用方法

GET /api/hr/department/queryStockWarehouse/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)部门ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: StockWarehouse com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.stock.StockWarehouse

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataStockWarehouse[]返回数据
GET

/api/hr/department/queryHrDepartment/{warehouseId}

部门管理 查询仓库下的部门 OperationId: queryHrDepartment

调用方法

GET /api/hr/department/queryHrDepartment/{warehouseId}

参数

名称位置必填类型说明示例
warehouseIdpathinteger(int64)仓库id

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrDepartment com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.hr.HrDepartment

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrDepartment[]返回数据
GET

/api/hr/department/queryGoodsCategory/{id}

部门管理 查询部门下的商品类型 OperationId: queryGoodsCategory

调用方法

GET /api/hr/department/queryGoodsCategory/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)部门ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: StockGoodsCategory com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.stock.StockGoodsCategory

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataStockGoodsCategory[]返回数据
GET

/api/hr/department/list

部门管理 查询部门列表 OperationId: list_2

调用方法

GET /api/hr/department/list

参数

名称位置必填类型说明示例
namequerystring名称
companyIdqueryinteger(int64)公司ID
merchantIdqueryinteger(int64)商户ID
statusListquerystring[]
codequerystring编号

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrDepartment com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.hr.HrDepartment

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrDepartment[]返回数据
GET

/api/hr/department/get/{id}

部门管理 查询部门详情 OperationId: get_3

调用方法

GET /api/hr/department/get/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)部门ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: HrDepartment com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrDepartment

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrDepartment
GET

/api/hr/calendarSchedule/page

日历日程管理 查询日历日程 OperationId: page_2

调用方法

GET /api/hr/calendarSchedule/page

参数

名称位置必填类型说明示例
pagequeryinteger(int32)查询页码0
sizequeryinteger(int32)查询页行数10
companyIdqueryinteger(int64)公司ID
typequerystring类型(WEEKEND:周末 TAKE:调休 HOLIDAY:节假日) 【 WORK : WEEKEND : TAKE : HOLIDAY : 】
contentquerystring日程内容

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: CalendarSchedule com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.hr.model.entity.calendar.schedule.CalendarSchedule

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataCalendarSchedule
GET

/api/hr/calendarSchedule/list

日历日程管理 查询时间区间日程 OperationId: list_3

调用方法

GET /api/hr/calendarSchedule/list

参数

名称位置必填类型说明示例
companyListqueryinteger(int64)[]
startDatequerystring(date)开始日期"2024-01-01"
endDatequerystring(date)结束日期"2024-01-30"

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: CalendarScheduleVO com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringCom.leadwaycloud.hr.model.vo.CalendarScheduleVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
GET

/api/dining/qyerMerchantCurrentDayTicketCount

餐食 查询商户当日各类型餐票订餐数量 OperationId: queryCurrentDayTicketCount

调用方法

GET /api/dining/qyerMerchantCurrentDayTicketCount

参数

名称位置必填类型说明示例
companyIdqueryinteger(int64)公司ID

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: Integer com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.util.MapJava.lang.StringJava.lang.Integer

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
GET

/api/dining/queryUserTicket

餐食 用户餐票查询 OperationId: queryUserTicket

调用方法

GET /api/dining/queryUserTicket

参数

名称位置必填类型说明示例
datequerystring(date)
isDestoryqueryboolean
ticketTypeIdqueryinteger(int64)
canteenIdqueryinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningTicket com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.dining.DiningTicket

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicket[]返回数据
GET

/api/dining/queryTicketType/{ticketTypeId}

餐食 查询餐票类型详情 OperationId: queryTicketTypeList

调用方法

GET /api/dining/queryTicketType/{ticketTypeId}

参数

名称位置必填类型说明示例
ticketTypeIdpathinteger(int64)餐票类型ID

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningTicketType com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.dining.DiningTicketType

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicketType
GET

/api/dining/queryTicketType/list

餐食 查询餐票类型列表 OperationId: queryTicketTypeList_1

调用方法

GET /api/dining/queryTicketType/list

参数

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningTicketType com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.dining.DiningTicketType

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicketType[]返回数据
GET

/api/dining/queryCanteenTicket/{canteenId}

餐食 食堂餐票查询 OperationId: queryCanteenTicket

调用方法

GET /api/dining/queryCanteenTicket/{canteenId}

参数

名称位置必填类型说明示例
canteenIdpathinteger(int64)食堂ID
datequerystring(date)
isDestoryqueryboolean
ticketTypeIdqueryinteger(int64)
userIdqueryinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningTicket com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.dining.DiningTicket

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicket[]返回数据
GET

/api/dining/queryCanteenList

餐食 获取食堂列表 OperationId: queryCanteenList

调用方法

GET /api/dining/queryCanteenList

参数

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: DiningCanteen com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.dining.DiningCanteen

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningCanteen[]返回数据
DELETE

/api/shift/item/delete/{shiftScheduleItemId}

班次管理 班次-删除 OperationId: deleteItem

调用方法

DELETE /api/shift/item/delete/{shiftScheduleItemId}

参数

名称位置必填类型说明示例
shiftScheduleItemIdpathinteger(int64)

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: Object com.leadwaycloud.core.model.RJava.lang.Object

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
DELETE

/api/hr/calendarSchedule/delete/{id}

日历日程管理 删除日历日程 OperationId: updateBingStockWarehouse_1

调用方法

DELETE /api/hr/calendarSchedule/delete/{id}

参数

名称位置必填类型说明示例
idpathinteger(int64)日历日程ID0

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据
DELETE

/api/dining/removeExpireTicket

餐食 删除过期餐票 OperationId: removeExpireTicket

调用方法

DELETE /api/dining/removeExpireTicket

参数

请求体

响应

状态码: 200 说明: OK Content-Type: */* 类型: Void com.leadwaycloud.core.model.RJava.lang.Void

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据

模型定义

com.leadwaycloud.core.model.RJava.lang.Object

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据

com.leadwaycloud.hr.model.dto.shift.ShiftScheduleDTO$UpdateDTO

更新排班方案DTO

名称类型必填说明示例
codestring方案编码
namestring方案名称
notestring备注

com.leadwaycloud.hr.model.dto.PositionDTO$UpdateDTO

编辑职位DTO

名称类型必填说明示例
namestring名称
parentIdinteger(int64)上一级ID
phonestring电话
faxstring传真
emailstring邮箱
notestring备注
externalCodestring外部编号
codestring编号
statusstring状态"ACTIVE"

com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrPosition

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrPosition

com.leadwaycloud.hr.model.entity.hr.HrPosition

职位

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
namestring名称
parentIdinteger(int64)上一级ID
idChainstring完成的组织架构值
notestring备注
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
externalCodestring外部编号
codestring编号
statusstring状态"ACTIVE"

com.leadwaycloud.hr.model.dto.ContactDTO$UpdateDTO

编辑联系地址DTO

名称类型必填说明示例
countryIdinteger(int64)国家ID
stateIdinteger(int64)省、直辖市ID
cityIdinteger(int64)城市ID
areaIdinteger(int64)区、县ID
streetIdinteger(int64)街道ID
addressstring详细地址
postcodestring邮编
phonestring电话
mobilestring手机
faxstring传真
emailstring邮箱

com.leadwaycloud.hr.model.dto.EmployeeDTO$UpdateDTO

编辑员工DTO

名称类型必填说明示例
codestring编号
nationalitystring民族
domicilestring户籍
statusstring状态"PERIOD_OF_PROBATION"
entryDatestring(date)入职日期"2020-10-11"
positiveDatestring(date)转正日期"2020-10-11"
resignDatestring(date)离职日期"2020-10-11"
bankCardstring银行卡
bankCardNumstring银行卡号
parentIdinteger(int64)上一级ID
externalCodestring外部编号
namestring名称
imagestring头像
birthdaystring(date)出生日期
sexstring性别
bankstring银行(名),sys_property获取
contactContactDTO$UpdateDTO
positionDepartmentDTOListPositionDepartmentDTO[]部门职位对象集合

com.leadwaycloud.hr.model.dto.PositionDepartmentDTO

编辑员工职位/部门DTO

名称类型必填说明示例
positionIdinteger(int64)职位ID
departmentIdinteger(int64)部门ID
companyIdinteger(int64)公司ID

com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrEmployee

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployee

com.leadwaycloud.hr.model.entity.hr.HrDepartment

部门

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
namestring名称
parentIdinteger(int64)上一级ID
idChainstring完整的组织架构值
phonestring电话
faxstring传真
emailstring邮箱
notestring备注
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
externalCodestring外部编号
codestring编号
statusstring状态
idaasIdstringidaas唯一ID
shortNamestring简称

com.leadwaycloud.hr.model.entity.hr.HrEmployee

员工

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
codestring编号
nationalitystring名族
domicilestring户籍
statusstring状态"PERIOD_OF_PROBATION"
entryDatestring(date)入职日期"2020-10-11"
positiveDatestring(date)转正日期"2020-10-11"
resignDatestring(date)离职日期"2020-10-11"
bankCardstring银行卡
bankCardNumstring银行卡号
partnerIdinteger(int64)客户关系对象ID
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
parentIdinteger(int64)上一级ID
idChainstring完整的组织架构值
externalCodestring外部编号
namestring名称
imagestring头像
contactIdinteger(int64)地址ID
birthdaystring(date)出生日期
sexstring性别
bankstring银行(名),sys_property获取
contactResContact
employeeDepartmentPositionListHrEmployeeDepartmentPosition[]员工-部门-职位

com.leadwaycloud.hr.model.entity.hr.HrEmployeeDepartmentPosition

员工-部门-职位

名称类型必填说明示例
idinteger(int64)
employeeIdinteger(int64)员工ID
positionIdinteger(int64)职位ID
departmentIdinteger(int64)部门ID
companyIdinteger(int64)公司ID
employeeHrEmployee
positionHrPosition
departmentHrDepartment
companyResCompany

com.leadwaycloud.hr.model.entity.res.ResCompany

公司模型

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID
partnerIdinteger(int64)关系ID
codestring公司编号(仅允许字母和数字)"CD01"
otherCodestring其他编号"AAAA-01"
typestring类型
statusstring状态
parentIdinteger(int64)上级公司ID
idChainstring公司ID完整架构(上下级公司id用-连接)"123-456"
sloganstring公司标语
initConfigboolean是否已经初始化公司配置 true:已初始化 false:未初始化false
namestring名称
imagestring图片
contactIdinteger(int64)地址ID
foreignNamesstring其他国家名称JSON字符串
contentstring其他详情JSON字符串,可动态添加附件字段名
enNamestring发票名称
currencyIdinteger(int64)货币Id

com.leadwaycloud.hr.model.entity.res.ResContact

地址联系关系

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
countryIdinteger(int64)国家ID
stateIdinteger(int64)省、直辖市ID
cityIdinteger(int64)城市ID
areaIdinteger(int64)区、县ID
streetIdinteger(int64)街道ID
addressstring详细地址
postcodestring邮编
phonestring电话
phoneExtensionstring电话-分机号
mobilestring手机
faxstring传真
faxExtensionstring传真-分机号
emailstring邮箱"邮箱"
houseNumberstring门牌号

com.leadwaycloud.core.model.RJava.lang.Void

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据

com.leadwaycloud.hr.model.dto.DepartmentDTO$UpdateDTO

编辑部门DTO

名称类型必填说明示例
namestring名称
parentIdinteger(int64)上一级ID
phonestring电话
faxstring传真
emailstring邮箱
notestring备注
externalCodestring外部编号
codestring编号
statusstring状态"ACTIVE"
shortNamestring简称

com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.hr.HrDepartment

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrDepartment

com.leadwaycloud.hr.model.dto.CalendarScheduleDTO$UpdateDTO

编辑日历日程

名称类型必填说明示例
companyListinteger(int64)[]公司ID
typestring类型(WEEKEND:周末 TAKE:调休 HOLIDAY:节假日)
bigAndSmallboolean是否大小周
wageinteger(int32)薪资倍数
startDatestring(date)开始日期"2024-01-02"
endDatestring(date)结束日期"2020-10-11"
repeatstring重复类型 NONE:无 DAY:每天 WEEK:每周 MONTH:每月 YEAR:每年"NONE"
weekDayinteger(int32)每周周几(1,2,3,4,5,6,7)
monthDayinteger(int32)每月几号(1,2,3...31)
yearDaystring每年的几月几号(01-01)
contentstring日程内容
attachmentstring自定义数据(json格式)

com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.calendar.schedule.CalendarSchedule

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataCalendarSchedule

com.leadwaycloud.hr.model.entity.calendar.schedule.CalendarSchedule

返回数据

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
merchantIdinteger(int64)商户ID
companyIdinteger(int64)公司ID
typestring类型(WORK:工作日 WEEKEND:周末 TAKE:调休 HOLIDAY:节假日)
bigAndSmallboolean是否大小周
wageinteger(int32)薪资倍数
startDatestring(date)开始日期"2024-01-02"
endDatestring(date)结束日期"2020-10-11"
repeatstring重复类型 NONE:无 DAY:每天 WEEK:每周 MONTH:每月 YEAR:每年"NONE"
weekDayinteger(int32)每周周几(1,2,3,4,5,6,7)
monthDayinteger(int32)每月几号(1,2,3...31)
yearDaystring每年的几月几号(01-01)
contentstring日程内容
attachmentstring自定义数据(json格式)

com.leadwaycloud.hr.model.dto.DiningDTO$UpdateTicketTypeDTO

名称类型必填说明示例
namestring
imagestring
stylestring
predictEndTimeLocalTime
validStartTimeLocalTime
validEndTimeLocalTime
statusstringACTIVE:可用 VOID:作废

java.time.LocalTime

名称类型必填说明示例
hourinteger(int32)
minuteinteger(int32)
secondinteger(int32)
nanointeger(int32)

com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.dining.DiningTicketType

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicketType

com.leadwaycloud.hr.model.entity.dining.DiningTicketType

返回数据

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
namestring
imagestring
stylestring
validStartTimeLocalTime
validEndTimeLocalTime
predictEndTimeLocalTime
companyIdinteger(int64)
statusstring

com.leadwaycloud.hr.model.dto.DiningDTO$UpdateCanteenDTO

名称类型必填说明示例
namestring
imagestring
statusstring

com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.entity.dining.DiningCanteen

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningCanteen

com.leadwaycloud.hr.model.entity.dining.DiningCanteen

公司员工食堂

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
codestring编号
namestring名称
merchantIdinteger(int64)商户ID
imagestring图片
statusstring状态

com.leadwaycloud.hr.model.dto.shift.ShiftScheduleDTO$StatusChangeDTO

状态变更DTO

名称类型必填说明示例
statusstring状态

com.leadwaycloud.core.model.RJava.lang.Long

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
datainteger(int64)返回数据

com.leadwaycloud.hr.model.dto.shift.ShiftScheduleItemDTO$TimeSegmentDTO

添加排班方案班次时间段DTO

名称类型必填说明示例
startTimeLocalTime
endTimeLocalTime
typestring类型
workHoursnumber工时

com.leadwaycloud.hr.model.dto.shift.ShiftScheduleItemDTO$UpdateDTO

编辑排班方案班次DTO

名称类型必填说明示例
codestring班次编码
namestring班次名称
nointeger(int32)排序号
totalWorkHoursnumber总工时
timeSegmentListShiftScheduleItemDTO$TimeSegmentDTO

com.leadwaycloud.hr.model.dto.shift.ShiftScheduleItemDTO$AddDTO

新增排班方案班次DTO

名称类型必填说明示例
codestring班次编码
namestring班次名称
nointeger(int32)排序号
totalWorkHoursnumber总工时
timeSegmentListShiftScheduleItemDTO$TimeSegmentDTO

com.leadwaycloud.hr.model.dto.shift.ShiftScheduleDTO$AddDTO

添加排班方案DTO

名称类型必填说明示例
merchantIdinteger(int64)商户ID
companyIdinteger(int64)公司ID
codestring方案编码
namestring方案名称
notestring备注

com.leadwaycloud.hr.model.dto.PositionDTO$AddDTO

添加职位DTO

名称类型必填说明示例
namestring名称
parentIdinteger(int64)上一级ID
notestring备注
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
externalCodestring外部编号
codestring编号

com.leadwaycloud.hr.model.dto.ContactDTO$AddDTO

添加联系地址DTO

名称类型必填说明示例
countryIdinteger(int64)国家ID
stateIdinteger(int64)省、直辖市ID
cityIdinteger(int64)城市ID
areaIdinteger(int64)区、县ID
streetIdinteger(int64)街道ID
addressstring详细地址
postcodestring邮编
phonestring电话
mobilestring手机
faxstring传真
emailstring邮箱

com.leadwaycloud.hr.model.dto.EmployeeDTO$AddDTO

添加员工DTO

名称类型必填说明示例
codestring编号
nationalitystring民族
domicilestring户籍
statusstring状态"PERIOD_OF_PROBATION"
entryDatestring(date)入职日期"2020-10-11"
positiveDatestring(date)转正日期"2020-10-11"
resignDatestring(date)离职日期"2020-10-11"
bankCardstring开户行
bankCardNumstring银行卡号
parentIdinteger(int64)上一级ID
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
externalCodestring外部编号
namestring名称
imagestring头像
birthdaystring(date)出生日期
sexstring性别
bankstring银行(名),sys_property获取
partnerIdinteger(int64)CRM关系ID
contactContactDTO$AddDTO
positionDepartmentDTOListPositionDepartmentDTO[]部门职位对象集合

com.leadwaycloud.hr.model.dto.DepartmentDTO$AddDTO

添加部门DTO

名称类型必填说明示例
namestring名称
parentIdinteger(int64)上一级ID
phonestring电话
faxstring传真
emailstring邮箱
notestring备注
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户号ID
externalCodestring外部编号
codestring编号
shortNamestring简称

com.leadwaycloud.hr.model.dto.CalendarScheduleDTO$AddDTO

添加日历日程

名称类型必填说明示例
companyIdinteger(int64)公司ID
typestring类型(WEEKEND:周末 TAKE:调休 HOLIDAY:节假日)
bigAndSmallboolean是否大小周
wageinteger(int32)薪资倍数
startDatestring(date)开始日期"2024-01-02"
endDatestring(date)结束日期"2020-10-11"
repeatstring重复类型 NONE:无 DAY:每天 WEEK:每周 MONTH:每月 YEAR:每年"NONE"
weekDayinteger(int32)每周周几(1,2,3,4,5,6,7)
monthDayinteger(int32)每月几号(1,2,3...31)
yearDaystring每年的几月几号(01-01)
contentstring日程内容
attachmentstring自定义数据(json格式)

com.leadwaycloud.hr.model.dto.DiningDTO$ManualTicketDTO

名称类型必填说明示例
canteenIdinteger(int64)
datestring(date)
ticketTypeIdinteger(int64)
userIdListinteger(int64)

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.dining.DiningTicket

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicket[]返回数据

com.leadwaycloud.hr.model.entity.dining.DiningTicket

餐食票

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
userIdinteger(int64)
companyIdinteger(int64)
applicationIdinteger(int64)
canteenIdinteger(int64)
ticketTypeIdinteger(int64)
useDatestring(date)
batchCodestring
destroyTimestring(date-time)
destroyCodestring
destroyDeviceIdinteger(int64)
sectionIdinteger(int64)
ticketTypeDiningTicketType
canteenDiningCanteen
userResUser
companyResCompany

com.leadwaycloud.hr.model.entity.res.ResUser

用户模型

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
statusstring状态
userNamestring登录名称
languagestring语言"zh_CN"
companyIdinteger(int64)公司ID
merchantIdinteger(int64)商户ID
readVersionInfoboolean是否已读更新版本信息false
namestring名称
imagestring图片
partnerIdinteger(int64)CRM对象ID
contactIdinteger(int64)地址联系ID
signstring用户签名
forceUpdatePasswordboolean是否强制修改密码
idaasIdstringidaas唯一ID
allowLoginChannelstring允许登陆渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,供应商平台:SUPPLIER_PLATFORM)。如果有多个用,逗号隔开
registerChannelstring注册渠道(ERP:ERP_BACKEND,电商平台:ECOMMERCE_PLATFORM,IDaaS平台:IDAAS)
userAuditStatusstring用户审核状态
externalCodestring外部编号
contactResContact

com.leadwaycloud.hr.model.dto.DiningDTO$ApplyTicketDTO

领取餐票DTO

名称类型必填说明示例
canteenIdinteger(int64)食堂ID
datestring(date)使用日期
ticketTypeIdListinteger(int64)[]餐食票类型ID集合

com.leadwaycloud.hr.model.dto.DiningDTO$AddTicketTypeDTO

餐食票类型DTO

名称类型必填说明示例
namestring名称
imagestring图片
stylestring样式
predictEndTimeLocalTime
validStartTimeLocalTime
validEndTimeLocalTime

com.leadwaycloud.hr.model.dto.DiningDTO$AddCanteenDTO

名称类型必填说明示例
codestring
namestring
imagestring

com.leadwaycloud.core.model.PCom.leadwaycloud.hr.model.vo.shift.ShiftScheduleVO$ListVO

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListShiftScheduleVO$ListVO[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.hr.model.vo.shift.ShiftScheduleVO$ListVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataShiftScheduleVO$ListVO

com.leadwaycloud.hr.model.vo.shift.ShiftScheduleVO$ListVO

排班方案列表VO

名称类型必填说明示例
idinteger(int64)主键ID
codestring方案编码
namestring方案名称
notestring备注
statusstring状态
createUserNamestring创建人名称
createTimestring(date-time)创建时间
publishUserNamestring发布人名称
publishTimestring(date-time)发布时间

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.vo.shift.ShiftScheduleVO$DetailVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataShiftScheduleVO$DetailVO[]返回数据

com.leadwaycloud.hr.model.entity.shift.ShiftScheduleItem

排班方案班次

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
codestring班次编码
namestring班次名称
nointeger(int32)排序号
totalWorkHoursnumber总工时
statusstring状态
timeSegmentListShiftScheduleItemTimeSegment

com.leadwaycloud.hr.model.entity.shift.ShiftScheduleItemTimeSegment

排班方案班次时间段

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
startTimeLocalTime
endTimeLocalTime
typestring类型
workHoursnumber工时

com.leadwaycloud.hr.model.vo.shift.ShiftScheduleVO$DetailVO

排班方案详情VO

名称类型必填说明示例
idinteger(int64)主键ID
codestring方案编码
namestring方案名称
notestring备注
statusstring状态
createUserNamestring创建人名称
createTimestring(date-time)创建时间
publishUserNamestring发布人名称
publishTimestring(date-time)发布时间
versionListShiftScheduleVersionVO

com.leadwaycloud.hr.model.vo.shift.ShiftScheduleVersionVO

排班方案版本详情VO

名称类型必填说明示例
idinteger(int64)主键ID
versioninteger(int32)版本号
statusstring状态
createUserNamestring创建人名称
createTimestring(date-time)创建时间
publishUserNamestring发布人名称
publishTimestring(date-time)发布时间
shiftScheduleItemListShiftScheduleItem

com.leadwaycloud.core.model.RCom.leadwaycloud.hr.model.vo.shift.ShiftScheduleVO$DetailVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataShiftScheduleVO$DetailVO

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.hr.HrPosition

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrPosition[]返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.hr.HrEmployeeDepartmentPosition

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployeeDepartmentPosition[]返回数据

com.leadwaycloud.core.model.PCom.leadwaycloud.hr.model.entity.hr.HrEmployee

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListHrEmployee[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.hr.model.entity.hr.HrEmployee

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrEmployee

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.stock.StockWarehouse

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataStockWarehouse[]返回数据

com.leadwaycloud.hr.model.entity.stock.StockWarehouse

仓库

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
codestring编号
namestring名称
idChainstring完整的组织结构
systemboolean系统创建
parentIdinteger(int64)父级ID
imagesstring图片
typestring仓库类型
merchantIdinteger(int64)商户号ID
companyIdinteger(int64)公司ID
statusstring状态
financeCenterIdinteger(int64)成本中心ID
goodsTypestring仓库商品类型
goodsSubTypestring仓库商品子类型
manufactureTypestring质量类型(合格库/不合格库/待检库...)
inventoryMoveTypestring入库/回库类型-万航
calcCostboolean是否计算成本。科研,料头仓库为false,默认值为true。
externalCodestring外部编号
assetboolean是否资产-爱达

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.hr.HrDepartment

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataHrDepartment[]返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.stock.StockGoodsCategory

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataStockGoodsCategory[]返回数据

com.leadwaycloud.hr.model.entity.stock.StockGoodsCategory

商品分类

名称类型必填说明示例
idinteger(int64)
createByinteger(int64)
createTimestring(date-time)
updateByinteger(int64)
updateTimestring(date-time)
namestring名称
codestring编号
statusstring状态
parentIdinteger(int64)父级ID
idChainstring完整的组织结构
imagesstring图片
merchantIdinteger(int64)商户ID
externalCodestring外部编号
saleTaxIdinteger(int64)销售税ID
purchaseTaxIdinteger(int64)采购税ID
accountingTitleIdinteger(int64)会计科目ID
costAccountingTitleIdinteger(int64)成本科目ID
descriptionstring描述
originstring来源
boutiqueboolean是否为精品分类
specificationGroupIdinteger(int64)商品规格组ID
extensionInfostring额外属性

com.leadwaycloud.core.model.PCom.leadwaycloud.hr.model.entity.calendar.schedule.CalendarSchedule

返回数据

名称类型必填说明示例
firstboolean是否是第一页true
lastboolean是否是最后一页true
totalPagesinteger(int32)总页数1
totalElementsinteger(int64)总数据条数1
sizeinteger(int32)每页条数10
numberinteger(int32)当前页码0
numberOfElementsinteger(int32)当前页数据条数0
dataListCalendarSchedule[]当前页数据

com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.hr.model.entity.calendar.schedule.CalendarSchedule

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataCalendarSchedule

com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringCom.leadwaycloud.hr.model.vo.CalendarScheduleVO

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据

com.leadwaycloud.hr.model.vo.CalendarScheduleVO

时间区间日程VO

名称类型必填说明示例
datestring(date)日期"2020-10-11"
typestring类型(WORK:工作日 WEEKEND:周末 TAKE:调休 HOLIDAY:节假日)
wageinteger(int32)薪资倍数
contentstring日程内容

com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.util.MapJava.lang.StringJava.lang.Integer

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataobject返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.dining.DiningTicketType

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningTicketType[]返回数据

com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.hr.model.entity.dining.DiningCanteen

名称类型必填说明示例
statusinteger(int32)状态码200
codestring业务代码"000"
messagestring消息描述"成功"
dataDiningCanteen[]返回数据